Function ServiceApiAxiosParamCreator

ServiceApi - axios parameter creator

Export

  • ServiceApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        addAppointmentForServiceJobByServiceJobId: (
            serviceJobId: string,
            body: AddAppointmentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        assignAppointmentResources: (
            serviceJobId: string,
            appointmentId: string,
            body: AssignAppointmentResourcesRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        cancelReservation: (
            reservationId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        cancelServiceJobByServiceJobId: (
            serviceJobId: string,
            cancellationReasonCode: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        completeServiceJobByServiceJobId: (
            serviceJobId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createReservation: (
            marketplaceIds: string[],
            body: CreateReservationRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createServiceDocumentUploadDestination: (
            body: ServiceUploadDocument,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getAppointmentSlots: (
            asin: string,
            storeId: string,
            marketplaceIds: string[],
            startTime?: string,
            endTime?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getAppointmmentSlotsByJobId: (
            serviceJobId: string,
            marketplaceIds: string[],
            startTime?: string,
            endTime?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getFixedSlotCapacity: (
            resourceId: string,
            marketplaceIds: string[],
            body: FixedSlotCapacityQuery,
            nextPageToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getRangeSlotCapacity: (
            resourceId: string,
            marketplaceIds: string[],
            body: RangeSlotCapacityQuery,
            nextPageToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getServiceJobByServiceJobId: (
            serviceJobId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getServiceJobs: (
            marketplaceIds: string[],
            serviceOrderIds?: string[],
            serviceJobStatus?: GetServiceJobsServiceJobStatusEnum[],
            pageToken?: string,
            pageSize?: number,
            sortField?: GetServiceJobsSortFieldEnum,
            sortOrder?: GetServiceJobsSortOrderEnum,
            createdAfter?: string,
            createdBefore?: string,
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            scheduleStartDate?: string,
            scheduleEndDate?: string,
            asins?: string[],
            requiredSkills?: string[],
            storeIds?: string[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        rescheduleAppointmentForServiceJobByServiceJobId: (
            serviceJobId: string,
            appointmentId: string,
            body: RescheduleAppointmentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        setAppointmentFulfillmentData: (
            serviceJobId: string,
            appointmentId: string,
            body: SetAppointmentFulfillmentDataRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateReservation: (
            reservationId: string,
            marketplaceIds: string[],
            body: UpdateReservationRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateSchedule: (
            resourceId: string,
            marketplaceIds: string[],
            body: UpdateScheduleRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        addAppointmentForServiceJobByServiceJobId: (
            serviceJobId: string,
            body: AddAppointmentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        assignAppointmentResources: (
            serviceJobId: string,
            appointmentId: string,
            body: AssignAppointmentResourcesRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        cancelReservation: (
            reservationId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        cancelServiceJobByServiceJobId: (
            serviceJobId: string,
            cancellationReasonCode: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        completeServiceJobByServiceJobId: (
            serviceJobId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createReservation: (
            marketplaceIds: string[],
            body: CreateReservationRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createServiceDocumentUploadDestination: (
            body: ServiceUploadDocument,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getAppointmentSlots: (
            asin: string,
            storeId: string,
            marketplaceIds: string[],
            startTime?: string,
            endTime?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getAppointmmentSlotsByJobId: (
            serviceJobId: string,
            marketplaceIds: string[],
            startTime?: string,
            endTime?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getFixedSlotCapacity: (
            resourceId: string,
            marketplaceIds: string[],
            body: FixedSlotCapacityQuery,
            nextPageToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getRangeSlotCapacity: (
            resourceId: string,
            marketplaceIds: string[],
            body: RangeSlotCapacityQuery,
            nextPageToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getServiceJobByServiceJobId: (
            serviceJobId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getServiceJobs: (
            marketplaceIds: string[],
            serviceOrderIds?: string[],
            serviceJobStatus?: GetServiceJobsServiceJobStatusEnum[],
            pageToken?: string,
            pageSize?: number,
            sortField?: GetServiceJobsSortFieldEnum,
            sortOrder?: GetServiceJobsSortOrderEnum,
            createdAfter?: string,
            createdBefore?: string,
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            scheduleStartDate?: string,
            scheduleEndDate?: string,
            asins?: string[],
            requiredSkills?: string[],
            storeIds?: string[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        rescheduleAppointmentForServiceJobByServiceJobId: (
            serviceJobId: string,
            appointmentId: string,
            body: RescheduleAppointmentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        setAppointmentFulfillmentData: (
            serviceJobId: string,
            appointmentId: string,
            body: SetAppointmentFulfillmentDataRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateReservation: (
            reservationId: string,
            marketplaceIds: string[],
            body: UpdateReservationRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateSchedule: (
            resourceId: string,
            marketplaceIds: string[],
            body: UpdateScheduleRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • addAppointmentForServiceJobByServiceJobId: (
          serviceJobId: string,
          body: AddAppointmentRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • assignAppointmentResources: (
          serviceJobId: string,
          appointmentId: string,
          body: AssignAppointmentResourcesRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • cancelReservation: (
          reservationId: string,
          marketplaceIds: string[],
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • cancelServiceJobByServiceJobId: (
          serviceJobId: string,
          cancellationReasonCode: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • completeServiceJobByServiceJobId: (serviceJobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      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.

      Throws

    • createReservation: (
          marketplaceIds: string[],
          body: CreateReservationRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • createServiceDocumentUploadDestination: (
          body: ServiceUploadDocument,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • getAppointmentSlots: (
          asin: string,
          storeId: string,
          marketplaceIds: string[],
          startTime?: string,
          endTime?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • getAppointmmentSlotsByJobId: (
          serviceJobId: string,
          marketplaceIds: string[],
          startTime?: string,
          endTime?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • getFixedSlotCapacity: (
          resourceId: string,
          marketplaceIds: string[],
          body: FixedSlotCapacityQuery,
          nextPageToken?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • getRangeSlotCapacity: (
          resourceId: string,
          marketplaceIds: string[],
          body: RangeSlotCapacityQuery,
          nextPageToken?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • getServiceJobByServiceJobId: (serviceJobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      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.

      Throws

    • getServiceJobs: (
          marketplaceIds: string[],
          serviceOrderIds?: string[],
          serviceJobStatus?: GetServiceJobsServiceJobStatusEnum[],
          pageToken?: string,
          pageSize?: number,
          sortField?: GetServiceJobsSortFieldEnum,
          sortOrder?: GetServiceJobsSortOrderEnum,
          createdAfter?: string,
          createdBefore?: string,
          lastUpdatedAfter?: string,
          lastUpdatedBefore?: string,
          scheduleStartDate?: string,
          scheduleEndDate?: string,
          asins?: string[],
          requiredSkills?: string[],
          storeIds?: string[],
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • rescheduleAppointmentForServiceJobByServiceJobId: (
          serviceJobId: string,
          appointmentId: string,
          body: RescheduleAppointmentRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • setAppointmentFulfillmentData: (
          serviceJobId: string,
          appointmentId: string,
          body: SetAppointmentFulfillmentDataRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • updateReservation: (
          reservationId: string,
          marketplaceIds: string[],
          body: UpdateReservationRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • updateSchedule: (
          resourceId: string,
          marketplaceIds: string[],
          body: UpdateScheduleRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

Settings

Member Visibility