@alicloud/ccc20200701 2.38.2 → 2.38.3

package/dist/models/ListIntervalAgentReportResponseBody.d.ts

@@ -1,20 +1,132 @@
 import * as $dara from '@darabonba/typescript';
 export declare class ListIntervalAgentReportResponseBodyDataBack2Back extends $dara.Model {
+    /**
+     * @remarks
+     * Agent acknowledgement rate.
+     *
+     * @example
+     * 1
+     */
     agentHandleRate?: number;
+    /**
+     * @remarks
+     * Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because answer events and acknowledgement events may fall into different time ranges, the result may exceed 100% in certain cases.)
+     *
+     * @example
+     * 0.5
+     */
     answerRate?: number;
+    /**
+     * @remarks
+     * Average customer-side ring duration in seconds.
+     *
+     * @example
+     * 100
+     */
     averageCustomerRingTime?: number;
+    /**
+     * @remarks
+     * Average ring time, in seconds.
+     *
+     * @example
+     * 100
+     */
     averageRingTime?: number;
+    /**
+     * @remarks
+     * Average talk time, in seconds.
+     *
+     * @example
+     * 100
+     */
     averageTalkTime?: number;
+    /**
+     * @remarks
+     * Number of calls answered by agents.
+     *
+     * @example
+     * 12
+     */
     callsAgentHandled?: number;
+    /**
+     * @remarks
+     * Number of answered calls.
+     *
+     * @example
+     * 100
+     */
     callsAnswered?: number;
+    /**
+     * @remarks
+     * Number of calls answered by customers.
+     *
+     * @example
+     * 9
+     */
     callsCustomerAnswered?: number;
+    /**
+     * @remarks
+     * Number of dial-up calls.
+     *
+     * @example
+     * 100
+     */
     callsDialed?: number;
+    /**
+     * @remarks
+     * Customer answer rate.
+     *
+     * @example
+     * 0.75
+     */
     customerAnswerRate?: number;
+    /**
+     * @remarks
+     * Maximum customer-side ring time, in seconds.
+     *
+     * @example
+     * 100
+     */
     maxCustomerRingTime?: number;
+    /**
+     * @remarks
+     * Maximum ring duration in seconds.
+     *
+     * @example
+     * 100
+     */
     maxRingTime?: number;
+    /**
+     * @remarks
+     * Maximum talk time, in seconds.
+     *
+     * @example
+     * 100
+     */
     maxTalkTime?: number;
+    /**
+     * @remarks
+     * Total customer-side ring time, in seconds.
+     *
+     * @example
+     * 100
+     */
     totalCustomerRingTime?: number;
+    /**
+     * @remarks
+     * Total ring time, in seconds.
+     *
+     * @example
+     * 100
+     */
     totalRingTime?: number;
+    /**
+     * @remarks
+     * Total talk time, in seconds.
+     *
+     * @example
+     * 100
+     */
     totalTalkTime?: number;
     static names(): {
         [key: string]: string;
@@ -28,7 +140,21 @@ export declare class ListIntervalAgentReportResponseBodyDataBack2Back extends $d
     });
 }
 export declare class ListIntervalAgentReportResponseBodyDataInboundAccessChannelTypeDetails extends $dara.Model {
+    /**
+     * @remarks
+     * Channel Type.
+     *
+     * @example
+     * Web
+     */
     accessChannelType?: string;
+    /**
+     * @remarks
+     * Number of assigned sessions.
+     *
+     * @example
+     * 2
+     */
     callsOffered?: number;
     static names(): {
         [key: string]: string;
@@ -42,134 +168,255 @@ export declare class ListIntervalAgentReportResponseBodyDataInboundAccessChannel
     });
 }
 export declare class ListIntervalAgentReportResponseBodyDataInbound extends $dara.Model {
+    /**
+     * @remarks
+     * Statistics for each Channel.
+     */
     accessChannelTypeDetails?: ListIntervalAgentReportResponseBodyDataInboundAccessChannelTypeDetails[];
+    /**
+     * @remarks
+     * Average first response time for chat sessions, in seconds.
+     *
+     * @example
+     * 8
+     */
     averageFirstResponseTime?: number;
     /**
+     * @remarks
+     * Average hold time during calls, in seconds. Calculation Formula: TotalHoldTime / CallsHold.
+     *
      * @example
      * 0
      */
     averageHoldTime?: number;
+    /**
+     * @remarks
+     * Average response time for chat sessions.
+     *
+     * @example
+     * 10
+     */
     averageResponseTime?: number;
     /**
+     * @remarks
+     * Average ring time, in seconds. Calculation Formula: TotalRingTime / CallsRinged.
+     *
      * @example
      * 0
      */
     averageRingTime?: number;
     /**
+     * @remarks
+     * Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsHandled.
+     *
      * @example
      * 0
      */
     averageTalkTime?: number;
     /**
+     * @remarks
+     * Average post-processing time, in seconds. Calculation Formula: TotalWorkTime / CallsHandled.
+     *
      * @example
      * 0
      */
     averageWorkTime?: number;
     /**
+     * @remarks
+     * Number of attended transfer-ins. If a single call is transferred to the agent multiple times, each transfer counts as one.
+     *
      * @example
      * 0
      */
     callsAttendedTransferIn?: number;
     /**
+     * @remarks
+     * Number of transfer-out calls. If a single call is transferred to other agents multiple times, each transfer counts as one.
+     *
      * @example
      * 0
      */
     callsAttendedTransferOut?: number;
     /**
+     * @remarks
+     * Number of blind transfer-in calls. If a single call is transferred in to this agent multiple times, each transfer counts as one.
+     *
      * @example
      * 0
      */
     callsBlindTransferIn?: number;
     /**
+     * @remarks
+     * Number of blind transfer-out calls. If a single call is transferred out to other agents multiple times, each transfer counts as one.
+     *
      * @example
      * 0
      */
     callsBlindTransferOut?: number;
     /**
+     * @remarks
+     * Acknowledgement count, which is the number of times agents answered calls.
+     *
      * @example
      * 0
      */
     callsHandled?: number;
     /**
+     * @remarks
+     * Number of calls placed on hold, that is, the count of occurrences where a call was held.
+     *
      * @example
      * 0
      */
     callsHold?: number;
     /**
+     * @remarks
+     * Assigned count, which refers to the number of calls assigned to this agent, including calls blindly transferred or consultatively transferred from other agents.
+     *
      * @example
      * 0
      */
     callsOffered?: number;
     /**
+     * @remarks
+     * Number of calls that rang to the agent.
+     *
      * @example
      * 0
      */
     callsRinged?: number;
     /**
+     * @remarks
+     * Acknowledgement rate. Calculation Formula: CallsHandled / CallsOffered (because acknowledgement events and assign events may fall into different time ranges, the result may exceed 100% in certain cases).
+     *
      * @example
      * 0
      */
     handleRate?: number;
     /**
+     * @remarks
+     * Maximum call hold duration, in seconds.
+     *
      * @example
      * 0
      */
     maxHoldTime?: number;
     /**
+     * @remarks
+     * Maximum ring time, in seconds.
+     *
      * @example
      * 0
      */
     maxRingTime?: number;
     /**
+     * @remarks
+     * Maximum talk time, in seconds.
+     *
      * @example
      * 0
      */
     maxTalkTime?: number;
     /**
+     * @remarks
+     * Maximum post-processing duration, in seconds.
+     *
      * @example
      * 0
      */
     maxWorkTime?: number;
     /**
+     * @remarks
+     * Satisfaction Index, which is the average of the satisfaction rating digits (single-digit numbers) entered by users.
+     *
      * @example
      * 0
      */
     satisfactionIndex?: number;
     /**
+     * @remarks
+     * Satisfaction rate. Calculation Formula: Number of evaluations marked as satisfied / Count of satisfaction survey responses.
+     *
      * @example
      * 0
      */
     satisfactionRate?: number;
     /**
+     * @remarks
+     * Sending Count of satisfaction surveys.
+     *
      * @example
      * 0
      */
     satisfactionSurveysOffered?: number;
     /**
+     * @remarks
+     * Response Count of satisfaction surveys.
+     *
      * @example
      * 0
      */
     satisfactionSurveysResponded?: number;
+    /**
+     * @remarks
+     * Service level within 15 seconds.
+     *
+     * @example
+     * 0.6
+     */
     serviceLevel15?: number;
     /**
+     * @remarks
+     * Total hold time during calls, in seconds.
+     *
      * @example
      * 0
      */
     totalHoldTime?: number;
+    /**
+     * @remarks
+     * Total number of messages sent in chat sessions.
+     *
+     * @example
+     * 12
+     */
     totalMessagesSent?: number;
+    /**
+     * @remarks
+     * Total number of messages sent by the agent in chat sessions.
+     *
+     * @example
+     * 10
+     */
     totalMessagesSentByAgent?: number;
+    /**
+     * @remarks
+     * Total number of messages sent by the Customer in chat sessions.
+     *
+     * @example
+     * 2
+     */
     totalMessagesSentByCustomer?: number;
     /**
+     * @remarks
+     * Total ring time, in seconds.
+     *
      * @example
      * 0
      */
     totalRingTime?: number;
     /**
+     * @remarks
+     * Total talk time, in seconds.
+     *
      * @example
      * 0
      */
     totalTalkTime?: number;
     /**
+     * @remarks
+     * Total post-processing time, in seconds.
+     *
      * @example
      * 0
      */
@@ -186,11 +433,53 @@ export declare class ListIntervalAgentReportResponseBodyDataInbound extends $dar
     });
 }
 export declare class ListIntervalAgentReportResponseBodyDataInternal extends $dara.Model {
+    /**
+     * @remarks
+     * Average talk time, in seconds.
+     *
+     * @example
+     * 100
+     */
     averageTalkTime?: number;
+    /**
+     * @remarks
+     * Number of answered calls.
+     *
+     * @example
+     * 100
+     */
     callsAnswered?: number;
+    /**
+     * @remarks
+     * Number of dial-up calls.
+     *
+     * @example
+     * 100
+     */
     callsDialed?: number;
+    /**
+     * @remarks
+     * Number of acknowledgements, which refers to the number of times the agent acknowledged a call.
+     *
+     * @example
+     * 100
+     */
     callsHandled?: number;
+    /**
+     * @remarks
+     * Number of assigned calls, which refers to the count of calls assigned to this agent, including calls blindly transferred or consultatively transferred from other agents.
+     *
+     * @example
+     * 100
+     */
     callsOffered?: number;
+    /**
+     * @remarks
+     * Number of calls participated in.
+     *
+     * @example
+     * 80
+     */
     callsTalked?: number;
     static names(): {
         [key: string]: string;
@@ -205,141 +494,225 @@ export declare class ListIntervalAgentReportResponseBodyDataInternal extends $da
 }
 export declare class ListIntervalAgentReportResponseBodyDataOutbound extends $dara.Model {
     /**
+     * @remarks
+     * Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because answering events and acknowledgement events may fall into different Time Ranges, the Result may exceed 100% in certain cases.)
+     *
      * @example
      * 0
      */
     answerRate?: number;
     /**
+     * @remarks
+     * Average dial-up duration, in seconds. Calculation Formula: TotalDialingTime / CallsDialed.
+     *
      * @example
      * 30
      */
     averageDialingTime?: number;
     /**
+     * @remarks
+     * Average hold duration, in seconds. Calculation formula: TotalHoldTime / CallsHold.
+     *
      * @example
      * 0
      */
     averageHoldTime?: number;
     /**
+     * @remarks
+     * Average ring time in seconds. Calculation Formula: TotalRingTime / CallsRinged.
+     *
      * @example
      * 0
      */
     averageRingTime?: number;
     /**
+     * @remarks
+     * Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsAnswered.
+     *
      * @example
      * 0
      */
     averageTalkTime?: number;
     /**
+     * @remarks
+     * Average post-processing time in seconds. Calculation Formula: TotalWorkTime / CallsDialed.
+     *
      * @example
      * 1
      */
     averageWorkTime?: number;
     /**
+     * @remarks
+     * Answered call count.
+     *
      * @example
      * 0
      */
     callsAnswered?: number;
     /**
+     * @remarks
+     * Number of attended transfer-in calls. If a single call is transferred to the agent multiple times, each transfer counts as one.
+     *
      * @example
      * 0
      */
     callsAttendedTransferIn?: number;
     /**
+     * @remarks
+     * Number of transfer-out calls. If a single call is transferred out to other agents multiple times, each transfer-out counts as one.
+     *
      * @example
      * 0
      */
     callsAttendedTransferOut?: number;
     /**
+     * @remarks
+     * Number of blind transfer-in calls. If a single call is transferred to the agent multiple times, each transfer counts as one.
+     *
      * @example
      * 0
      */
     callsBlindTransferIn?: number;
     /**
+     * @remarks
+     * Number of blind transfer-out calls. If a single call is transferred to other agents multiple times, each transfer counts as one.
+     *
      * @example
      * 0
      */
     callsBlindTransferOut?: number;
     /**
+     * @remarks
+     * Dial-up count.
+     *
      * @example
      * 5
      */
     callsDialed?: number;
     /**
+     * @remarks
+     * Hold count, which is the number of times call hold occurred.
+     *
      * @example
      * 0
      */
     callsHold?: number;
     /**
+     * @remarks
+     * Number of calls that rang for the agent.
+     *
      * @example
      * 0
      */
     callsRinged?: number;
     /**
+     * @remarks
+     * Maximum dial-up duration, in seconds.
+     *
      * @example
      * 60
      */
     maxDialingTime?: number;
     /**
+     * @remarks
+     * Maximum hold time during calls, in seconds.
+     *
      * @example
      * 0
      */
     maxHoldTime?: number;
     /**
+     * @remarks
+     * Maximum ring time, in seconds.
+     *
      * @example
      * 0
      */
     maxRingTime?: number;
     /**
+     * @remarks
+     * Maximum talk time, in seconds.
+     *
      * @example
      * 0
      */
     maxTalkTime?: number;
     /**
+     * @remarks
+     * Maximum post-processing time in seconds.
+     *
      * @example
      * 2
      */
     maxWorkTime?: number;
     /**
+     * @remarks
+     * Satisfaction index, which is the average value of the satisfaction key digits (single-digit numbers).
+     *
      * @example
      * 0
      */
     satisfactionIndex?: number;
     /**
+     * @remarks
+     * Satisfaction rate. Calculation Formula: Count of evaluations marked as satisfied / Count of satisfaction survey responses.
+     *
      * @example
      * 0
      */
     satisfactionRate?: number;
     /**
+     * @remarks
+     * Sending Count of satisfaction surveys.
+     *
      * @example
      * 0
      */
     satisfactionSurveysOffered?: number;
     /**
+     * @remarks
+     * Count of satisfaction survey responses.
+     *
      * @example
      * 0
      */
     satisfactionSurveysResponded?: number;
     /**
+     * @remarks
+     * Total dial-up duration, in seconds.
+     *
      * @example
      * 148
      */
     totalDialingTime?: number;
     /**
+     * @remarks
+     * Total hold duration, in seconds.
+     *
      * @example
      * 0
      */
     totalHoldTime?: number;
     /**
+     * @remarks
+     * Total ring time, in seconds.
+     *
      * @example
      * 0
      */
     totalRingTime?: number;
     /**
+     * @remarks
+     * Total talk time, in seconds.
+     *
      * @example
      * 0
      */
     totalTalkTime?: number;
     /**
+     * @remarks
+     * Total post-processing duration, in seconds.
+     *
      * @example
      * 4
      */
@@ -356,8 +729,29 @@ export declare class ListIntervalAgentReportResponseBodyDataOutbound extends $da
     });
 }
 export declare class ListIntervalAgentReportResponseBodyDataOverallBreakCodeDetailList extends $dara.Model {
+    /**
+     * @remarks
+     * Break code.
+     *
+     * @example
+     * 会议
+     */
     breakCode?: string;
+    /**
+     * @remarks
+     * Quantity.
+     *
+     * @example
+     * 10
+     */
     count?: number;
+    /**
+     * @remarks
+     * Duration in seconds.
+     *
+     * @example
+     * 100
+     */
     duration?: number;
     static names(): {
         [key: string]: string;
@@ -372,148 +766,278 @@ export declare class ListIntervalAgentReportResponseBodyDataOverallBreakCodeDeta
 }
 export declare class ListIntervalAgentReportResponseBodyDataOverall extends $dara.Model {
     /**
+     * @remarks
+     * Average break duration, in seconds. Calculation Formula: TotalBreakTime / Count of breaks. The count of breaks is not an API statistics field.
+     *
      * @example
      * 0
      */
     averageBreakTime?: number;
     /**
+     * @remarks
+     * Average call hold duration, in seconds. Calculation Formula: TotalHoldTime / (Inbound CallsHold + Outbound CallsHold).
+     *
      * @example
      * 0
      */
     averageHoldTime?: number;
     /**
+     * @remarks
+     * Average ready time, in seconds. Calculation Formula: TotalReadyTime / Count of ready events. The count of ready events is a non-API statistical field.
+     *
      * @example
      * 0
      */
     averageReadyTime?: number;
     /**
+     * @remarks
+     * Average talk time, in seconds. Calculation Formula: TotalTalkTime / (CallsAnswered + CallsHandled).
+     *
      * @example
      * 0
      */
     averageTalkTime?: number;
     /**
+     * @remarks
+     * Average post-processing duration per call, in seconds. Calculation Formula: TotalWorkTime / TotalCalls.
+     *
      * @example
      * 1
      */
     averageWorkTime?: number;
+    /**
+     * @remarks
+     * List of break details.
+     */
     breakCodeDetailList?: ListIntervalAgentReportResponseBodyDataOverallBreakCodeDetailList[];
     /**
+     * @remarks
+     * This field has a value only when the input parameter Interval is Daily, representing the first publish time of the day.
+     *
      * @example
      * 0
      */
     firstCheckInTime?: number;
-    lastCheckOutTime?: number;
     /**
+     * @remarks
+     * This field has a value only when the input parameter Interval is Daily, representing the last unpublish time of the day.
+     *
      * @example
      * 0
      */
+    lastCheckOutTime?: number;
+    /**
+     * @remarks
+     * This value is available only when the input parameter Interval is set to Daily, indicating the last unpublish time on that day.
+     *
+     * @example
+     * 已弃用，请使用LastCheckOutTime代替此参数。
+     */
     lastCheckoutTime?: number;
     /**
+     * @remarks
+     * Maximum break time, in seconds.
+     *
      * @example
      * 1
      */
     maxBreakTime?: number;
     /**
+     * @remarks
+     * Maximum call hold time, in seconds.
+     *
      * @example
      * 0
      */
     maxHoldTime?: number;
     /**
+     * @remarks
+     * Maximum ready time, in seconds.
+     *
      * @example
      * 435
      */
     maxReadyTime?: number;
     /**
+     * @remarks
+     * Maximum talk time, in seconds.
+     *
      * @example
      * 0
      */
     maxTalkTime?: number;
     /**
+     * @remarks
+     * Maximum post-processing duration in seconds.
+     *
      * @example
      * 2
      */
     maxWorkTime?: number;
     /**
+     * @remarks
+     * Agent occupancy rate. Calculation Formula: (TotalWorkTime + TotalTalkTime) / TotalLoggedInTime.
+     *
      * @example
      * 0
      */
     occupancyRate?: number;
     /**
+     * @remarks
+     * Satisfaction index, which is the average value of the satisfaction keypress digits (single-digit numbers).
+     *
      * @example
      * 0
      */
     satisfactionIndex?: number;
     /**
+     * @remarks
+     * Satisfaction rate. Calculation Formula: Number of evaluations marked as satisfied / Count of satisfaction survey responses.
+     *
      * @example
      * 0
      */
     satisfactionRate?: number;
     /**
+     * @remarks
+     * Sending Count of satisfaction surveys.
+     *
      * @example
      * 0
      */
     satisfactionSurveysOffered?: number;
     /**
+     * @remarks
+     * Response Count of satisfaction surveys.
+     *
      * @example
      * 0
      */
     satisfactionSurveysResponded?: number;
     /**
+     * @remarks
+     * Total break time, in seconds.
+     *
      * @example
      * 1
      */
     totalBreakTime?: number;
     /**
+     * @remarks
+     * Total call volume. Calculation Formula: CallsOffered + CallsDialed.
+     *
      * @example
      * 5
      */
     totalCalls?: number;
     /**
+     * @remarks
+     * Total hold time in seconds.
+     *
      * @example
      * 0
      */
     totalHoldTime?: number;
     /**
+     * @remarks
+     * Total logon duration, in seconds. Note: Exclude offline and break durations.
+     *
      * @example
      * 914
      */
     totalLoggedInTime?: number;
+    /**
+     * @remarks
+     * Total off-site logged-in duration, in seconds.
+     *
+     * @example
+     * 100
+     */
     totalOffSiteLoggedInTime?: number;
     /**
+     * @remarks
+     * Total off-site online duration, in seconds.
+     *
      * @example
      * 已弃用，请使用TotalOffSiteLoggedInTime代替此参数
      */
     totalOffSiteOnlineTime?: number;
+    /**
+     * @remarks
+     * Total office phone logged-in time, in seconds.
+     *
+     * @example
+     * 100
+     */
     totalOfficePhoneLoggedInTime?: number;
     /**
+     * @remarks
+     * Total office phone online time, in seconds.
+     *
      * @example
      * 已弃用，请使用TotalOfficePhoneLoggedInTime代替此参数
      */
     totalOfficePhoneOnlineTime?: number;
+    /**
+     * @remarks
+     * Total on-site logged-in duration, in seconds.
+     *
+     * @example
+     * 100
+     */
     totalOnSiteLoggedInTime?: number;
     /**
+     * @remarks
+     * Total on-site online duration, in seconds.
+     *
      * @example
      * 已弃用，请使用TotalOnSiteLoggedInTime代替此参数
      */
     totalOnSiteOnlineTime?: number;
+    /**
+     * @remarks
+     * Total online time for outbound-only scenarios, in seconds.
+     *
+     * @example
+     * 100
+     */
     totalOutboundScenarioLoggedInTime?: number;
+    /**
+     * @remarks
+     * Total idle time for outbound-only scenarios, in seconds.
+     *
+     * @example
+     * 100
+     */
     totalOutboundScenarioReadyTime?: number;
     /**
+     * @remarks
+     * Total outbound-only scenario duration, in seconds.
+     *
      * @example
      * 已弃用，请使用TotalOutboundScenarioLoggedInTime代替此参数
      */
     totalOutboundScenarioTime?: number;
     /**
+     * @remarks
+     * Total ready time, in seconds.
+     *
      * @example
      * 763
      */
     totalReadyTime?: number;
     /**
+     * @remarks
+     * Total talk duration, in seconds.
+     *
      * @example
      * 0
      */
     totalTalkTime?: number;
     /**
+     * @remarks
+     * Total post-processing time in seconds.
+     *
      * @example
      * 4
      */
@@ -530,12 +1054,35 @@ export declare class ListIntervalAgentReportResponseBodyDataOverall extends $dar
     });
 }
 export declare class ListIntervalAgentReportResponseBodyData extends $dara.Model {
+    /**
+     * @remarks
+     * Back-to-back call metric.
+     */
     back2Back?: ListIntervalAgentReportResponseBodyDataBack2Back;
+    /**
+     * @remarks
+     * Inbound metrics.
+     */
     inbound?: ListIntervalAgentReportResponseBodyDataInbound;
+    /**
+     * @remarks
+     * Internal call metrics.
+     */
     internal?: ListIntervalAgentReportResponseBodyDataInternal;
+    /**
+     * @remarks
+     * Outbound metrics.
+     */
     outbound?: ListIntervalAgentReportResponseBodyDataOutbound;
+    /**
+     * @remarks
+     * Overall metrics.
+     */
     overall?: ListIntervalAgentReportResponseBodyDataOverall;
     /**
+     * @remarks
+     * Start time of the time segment, formatted as a UNIX timestamp in milliseconds.
+     *
      * @example
      * 1620291600000
      */
@@ -553,18 +1100,38 @@ export declare class ListIntervalAgentReportResponseBodyData extends $dara.Model
 }
 export declare class ListIntervalAgentReportResponseBody extends $dara.Model {
     /**
+     * @remarks
+     * Response code.
+     *
      * @example
      * OK
      */
     code?: string;
+    /**
+     * @remarks
+     * List of agent segment statistics.
+     */
     data?: ListIntervalAgentReportResponseBodyData[];
     /**
+     * @remarks
+     * HTTP status code.
+     *
      * @example
      * 200
      */
     httpStatusCode?: number;
+    /**
+     * @remarks
+     * Response message.
+     *
+     * @example
+     * 无
+     */
     message?: string;
     /**
+     * @remarks
+     * Request ID.
+     *
      * @example
      * 943D8EF3-3321-471F-A104-51C96FCA94D6
      */