Function ServiceApiFactory

Returns {
    addAppointmentForServiceJobByServiceJobId(
        requestParameters: ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SetAppointmentResponse>;
    assignAppointmentResources(
        requestParameters: ServiceApiAssignAppointmentResourcesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AssignAppointmentResourcesResponse>;
    cancelReservation(
        requestParameters: ServiceApiCancelReservationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelReservationResponse>;
    cancelServiceJobByServiceJobId(
        requestParameters: ServiceApiCancelServiceJobByServiceJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelServiceJobByServiceJobIdResponse>;
    completeServiceJobByServiceJobId(
        requestParameters: ServiceApiCompleteServiceJobByServiceJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CompleteServiceJobByServiceJobIdResponse>;
    createReservation(
        requestParameters: ServiceApiCreateReservationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateReservationResponse>;
    createServiceDocumentUploadDestination(
        requestParameters: ServiceApiCreateServiceDocumentUploadDestinationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateServiceDocumentUploadDestination>;
    getAppointmentSlots(
        requestParameters: ServiceApiGetAppointmentSlotsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAppointmentSlotsResponse>;
    getAppointmmentSlotsByJobId(
        requestParameters: ServiceApiGetAppointmmentSlotsByJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAppointmentSlotsResponse>;
    getFixedSlotCapacity(
        requestParameters: ServiceApiGetFixedSlotCapacityRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FixedSlotCapacity>;
    getRangeSlotCapacity(
        requestParameters: ServiceApiGetRangeSlotCapacityRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RangeSlotCapacity>;
    getServiceJobByServiceJobId(
        requestParameters: ServiceApiGetServiceJobByServiceJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetServiceJobByServiceJobIdResponse>;
    getServiceJobs(
        requestParameters: ServiceApiGetServiceJobsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetServiceJobsResponse>;
    rescheduleAppointmentForServiceJobByServiceJobId(
        requestParameters: ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SetAppointmentResponse>;
    setAppointmentFulfillmentData(
        requestParameters: ServiceApiSetAppointmentFulfillmentDataRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<string>;
    updateReservation(
        requestParameters: ServiceApiUpdateReservationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateReservationResponse>;
    updateSchedule(
        requestParameters: ServiceApiUpdateScheduleRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateScheduleResponse>;
}

• addAppointmentForServiceJobByServiceJobId:function

  • addAppointmentForServiceJobByServiceJobId(
        requestParameters: ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SetAppointmentResponse>

    Adds an appointment to the service job indicated by the service job identifier specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SetAppointmentResponse>

    Throws

• assignAppointmentResources:function

  • assignAppointmentResources(
        requestParameters: ServiceApiAssignAppointmentResourcesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AssignAppointmentResourcesResponse>

    Assigns new resource(s) or overwrite/update the existing one(s) to a service job appointment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiAssignAppointmentResourcesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AssignAppointmentResourcesResponse>

    Throws

• cancelReservation:function

  • cancelReservation(
        requestParameters: ServiceApiCancelReservationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelReservationResponse>

    Cancel a reservation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiCancelReservationRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CancelReservationResponse>

    Throws

• cancelServiceJobByServiceJobId:function

  • cancelServiceJobByServiceJobId(
        requestParameters: ServiceApiCancelServiceJobByServiceJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelServiceJobByServiceJobIdResponse>

    Cancels the service job indicated by the service job identifier specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiCancelServiceJobByServiceJobIdRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CancelServiceJobByServiceJobIdResponse>

    Throws

• completeServiceJobByServiceJobId:function

  • completeServiceJobByServiceJobId(
        requestParameters: ServiceApiCompleteServiceJobByServiceJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CompleteServiceJobByServiceJobIdResponse>

    Completes the service job indicated by the service job identifier specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiCompleteServiceJobByServiceJobIdRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CompleteServiceJobByServiceJobIdResponse>

    Throws

• createReservation:function

  • createReservation(
        requestParameters: ServiceApiCreateReservationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateReservationResponse>

    Create a reservation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiCreateReservationRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CreateReservationResponse>

    Throws

• createServiceDocumentUploadDestination:function

  • createServiceDocumentUploadDestination(
        requestParameters: ServiceApiCreateServiceDocumentUploadDestinationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateServiceDocumentUploadDestination>

    Creates an upload destination. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiCreateServiceDocumentUploadDestinationRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CreateServiceDocumentUploadDestination>

    Throws

• getAppointmentSlots:function

  • getAppointmentSlots(
        requestParameters: ServiceApiGetAppointmentSlotsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAppointmentSlotsResponse>

    Gets appointment slots as per the service context specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 20 | 40 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiGetAppointmentSlotsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetAppointmentSlotsResponse>

    Throws

• getAppointmmentSlotsByJobId:function

  • getAppointmmentSlotsByJobId(
        requestParameters: ServiceApiGetAppointmmentSlotsByJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAppointmentSlotsResponse>

    Gets appointment slots for the service associated with the service job id specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiGetAppointmmentSlotsByJobIdRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetAppointmentSlotsResponse>

    Throws

• getFixedSlotCapacity:function

  • getFixedSlotCapacity(
        requestParameters: ServiceApiGetFixedSlotCapacityRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<FixedSlotCapacity>

    Provides capacity in fixed-size slots. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiGetFixedSlotCapacityRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<FixedSlotCapacity>

    Throws

• getRangeSlotCapacity:function

  • getRangeSlotCapacity(
        requestParameters: ServiceApiGetRangeSlotCapacityRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RangeSlotCapacity>

    Provides capacity slots in a format similar to availability records. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiGetRangeSlotCapacityRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RangeSlotCapacity>

    Throws

• getServiceJobByServiceJobId:function

  • getServiceJobByServiceJobId(
        requestParameters: ServiceApiGetServiceJobByServiceJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetServiceJobByServiceJobIdResponse>

    Gets details of service job indicated by the provided serviceJobID. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 20 | 40 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiGetServiceJobByServiceJobIdRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetServiceJobByServiceJobIdResponse>

    Throws

• getServiceJobs:function

  • getServiceJobs(
        requestParameters: ServiceApiGetServiceJobsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetServiceJobsResponse>

    Gets service job details for the specified filter query. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiGetServiceJobsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetServiceJobsResponse>

    Throws

• rescheduleAppointmentForServiceJobByServiceJobId:function

  • rescheduleAppointmentForServiceJobByServiceJobId(
        requestParameters: ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SetAppointmentResponse>

    Reschedules an appointment for the service job indicated by the service job identifier specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SetAppointmentResponse>

    Throws

• setAppointmentFulfillmentData:function

  • setAppointmentFulfillmentData(
        requestParameters: ServiceApiSetAppointmentFulfillmentDataRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<string>

    Updates the appointment fulfillment data related to a given jobID and appointmentID. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiSetAppointmentFulfillmentDataRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<string>

    Throws

• updateReservation:function

  • updateReservation(
        requestParameters: ServiceApiUpdateReservationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateReservationResponse>

    Update a reservation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiUpdateReservationRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UpdateReservationResponse>

    Throws

• updateSchedule:function

  • updateSchedule(
        requestParameters: ServiceApiUpdateScheduleRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateScheduleResponse>

    Update the schedule of the given resource. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • requestParameters: ServiceApiUpdateScheduleRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UpdateScheduleResponse>

    Throws