ServiceApi - object-oriented interface

ServiceApi

Hierarchy (View Summary)

Constructors

  • Parameters

    • Optionalconfiguration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns ServiceApi

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • 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

    Returns Promise<AxiosResponse<FixedSlotCapacity, any>>

    ServiceApi

  • 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

    Returns Promise<AxiosResponse<RangeSlotCapacity, any>>

    ServiceApi

  • 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

    Returns Promise<AxiosResponse<GetServiceJobsResponse, any>>

    ServiceApi

  • 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

    Returns Promise<AxiosResponse<string, any>>

    ServiceApi

  • 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

    Returns Promise<AxiosResponse<UpdateScheduleResponse, any>>

    ServiceApi