@sp-api-sdk/services-api-v1 1.10.9 → 1.10.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -939,198 +939,156 @@ const ServiceApiFactory = function (configuration, basePath, axios) {
939
939
  return {
940
940
  /**
941
941
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
942
- * @param {string} serviceJobId An Amazon defined service job identifier.
943
- * @param {AddAppointmentRequest} body Add appointment operation input details.
942
+ * @param {ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
944
943
  * @param {*} [options] Override http request option.
945
944
  * @throws {RequiredError}
946
945
  */
947
- addAppointmentForServiceJobByServiceJobId(serviceJobId, body, options) {
948
- return localVarFp.addAppointmentForServiceJobByServiceJobId(serviceJobId, body, options).then((request) => request(axios, basePath));
946
+ addAppointmentForServiceJobByServiceJobId(requestParameters, options) {
947
+ return localVarFp.addAppointmentForServiceJobByServiceJobId(requestParameters.serviceJobId, requestParameters.body, options).then((request) => request(axios, basePath));
949
948
  },
950
949
  /**
951
950
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
952
- * @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
953
- * @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
954
- * @param {AssignAppointmentResourcesRequest} body
951
+ * @param {ServiceApiAssignAppointmentResourcesRequest} requestParameters Request parameters.
955
952
  * @param {*} [options] Override http request option.
956
953
  * @throws {RequiredError}
957
954
  */
958
- assignAppointmentResources(serviceJobId, appointmentId, body, options) {
959
- return localVarFp.assignAppointmentResources(serviceJobId, appointmentId, body, options).then((request) => request(axios, basePath));
955
+ assignAppointmentResources(requestParameters, options) {
956
+ return localVarFp.assignAppointmentResources(requestParameters.serviceJobId, requestParameters.appointmentId, requestParameters.body, options).then((request) => request(axios, basePath));
960
957
  },
961
958
  /**
962
959
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
963
- * @param {string} reservationId Reservation Identifier
964
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
960
+ * @param {ServiceApiCancelReservationRequest} requestParameters Request parameters.
965
961
  * @param {*} [options] Override http request option.
966
962
  * @throws {RequiredError}
967
963
  */
968
- cancelReservation(reservationId, marketplaceIds, options) {
969
- return localVarFp.cancelReservation(reservationId, marketplaceIds, options).then((request) => request(axios, basePath));
964
+ cancelReservation(requestParameters, options) {
965
+ return localVarFp.cancelReservation(requestParameters.reservationId, requestParameters.marketplaceIds, options).then((request) => request(axios, basePath));
970
966
  },
971
967
  /**
972
968
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
973
- * @param {string} serviceJobId An Amazon defined service job identifier.
974
- * @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
969
+ * @param {ServiceApiCancelServiceJobByServiceJobIdRequest} requestParameters Request parameters.
975
970
  * @param {*} [options] Override http request option.
976
971
  * @throws {RequiredError}
977
972
  */
978
- cancelServiceJobByServiceJobId(serviceJobId, cancellationReasonCode, options) {
979
- return localVarFp.cancelServiceJobByServiceJobId(serviceJobId, cancellationReasonCode, options).then((request) => request(axios, basePath));
973
+ cancelServiceJobByServiceJobId(requestParameters, options) {
974
+ return localVarFp.cancelServiceJobByServiceJobId(requestParameters.serviceJobId, requestParameters.cancellationReasonCode, options).then((request) => request(axios, basePath));
980
975
  },
981
976
  /**
982
977
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
983
- * @param {string} serviceJobId An Amazon defined service job identifier.
978
+ * @param {ServiceApiCompleteServiceJobByServiceJobIdRequest} requestParameters Request parameters.
984
979
  * @param {*} [options] Override http request option.
985
980
  * @throws {RequiredError}
986
981
  */
987
- completeServiceJobByServiceJobId(serviceJobId, options) {
988
- return localVarFp.completeServiceJobByServiceJobId(serviceJobId, options).then((request) => request(axios, basePath));
982
+ completeServiceJobByServiceJobId(requestParameters, options) {
983
+ return localVarFp.completeServiceJobByServiceJobId(requestParameters.serviceJobId, options).then((request) => request(axios, basePath));
989
984
  },
990
985
  /**
991
986
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
992
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
993
- * @param {CreateReservationRequest} body Reservation details
987
+ * @param {ServiceApiCreateReservationRequest} requestParameters Request parameters.
994
988
  * @param {*} [options] Override http request option.
995
989
  * @throws {RequiredError}
996
990
  */
997
- createReservation(marketplaceIds, body, options) {
998
- return localVarFp.createReservation(marketplaceIds, body, options).then((request) => request(axios, basePath));
991
+ createReservation(requestParameters, options) {
992
+ return localVarFp.createReservation(requestParameters.marketplaceIds, requestParameters.body, options).then((request) => request(axios, basePath));
999
993
  },
1000
994
  /**
1001
995
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1002
- * @param {ServiceUploadDocument} body Upload document operation input details.
996
+ * @param {ServiceApiCreateServiceDocumentUploadDestinationRequest} requestParameters Request parameters.
1003
997
  * @param {*} [options] Override http request option.
1004
998
  * @throws {RequiredError}
1005
999
  */
1006
- createServiceDocumentUploadDestination(body, options) {
1007
- return localVarFp.createServiceDocumentUploadDestination(body, options).then((request) => request(axios, basePath));
1000
+ createServiceDocumentUploadDestination(requestParameters, options) {
1001
+ return localVarFp.createServiceDocumentUploadDestination(requestParameters.body, options).then((request) => request(axios, basePath));
1008
1002
  },
1009
1003
  /**
1010
1004
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1011
- * @param {string} asin ASIN associated with the service.
1012
- * @param {string} storeId Store identifier defining the region scope to retrive appointment slots.
1013
- * @param {Array<string>} marketplaceIds An identifier for the marketplace for which appointment slots are queried
1014
- * @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;startTime&#x60; is provided, &#x60;endTime&#x60; should also be provided. Default value is as per business configuration.
1015
- * @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;endTime&#x60; is provided, &#x60;startTime&#x60; should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
1005
+ * @param {ServiceApiGetAppointmentSlotsRequest} requestParameters Request parameters.
1016
1006
  * @param {*} [options] Override http request option.
1017
1007
  * @throws {RequiredError}
1018
1008
  */
1019
- getAppointmentSlots(asin, storeId, marketplaceIds, startTime, endTime, options) {
1020
- return localVarFp.getAppointmentSlots(asin, storeId, marketplaceIds, startTime, endTime, options).then((request) => request(axios, basePath));
1009
+ getAppointmentSlots(requestParameters, options) {
1010
+ return localVarFp.getAppointmentSlots(requestParameters.asin, requestParameters.storeId, requestParameters.marketplaceIds, requestParameters.startTime, requestParameters.endTime, options).then((request) => request(axios, basePath));
1021
1011
  },
1022
1012
  /**
1023
1013
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1024
- * @param {string} serviceJobId A service job identifier to retrive appointment slots for associated service.
1025
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
1026
- * @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;startTime&#x60; is provided, &#x60;endTime&#x60; should also be provided. Default value is as per business configuration.
1027
- * @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;endTime&#x60; is provided, &#x60;startTime&#x60; should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
1014
+ * @param {ServiceApiGetAppointmmentSlotsByJobIdRequest} requestParameters Request parameters.
1028
1015
  * @param {*} [options] Override http request option.
1029
1016
  * @throws {RequiredError}
1030
1017
  */
1031
- getAppointmmentSlotsByJobId(serviceJobId, marketplaceIds, startTime, endTime, options) {
1032
- return localVarFp.getAppointmmentSlotsByJobId(serviceJobId, marketplaceIds, startTime, endTime, options).then((request) => request(axios, basePath));
1018
+ getAppointmmentSlotsByJobId(requestParameters, options) {
1019
+ return localVarFp.getAppointmmentSlotsByJobId(requestParameters.serviceJobId, requestParameters.marketplaceIds, requestParameters.startTime, requestParameters.endTime, options).then((request) => request(axios, basePath));
1033
1020
  },
1034
1021
  /**
1035
1022
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1036
- * @param {string} resourceId Resource Identifier.
1037
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
1038
- * @param {FixedSlotCapacityQuery} body Request body.
1039
- * @param {string} [nextPageToken] Next page token returned in the response of your previous request.
1023
+ * @param {ServiceApiGetFixedSlotCapacityRequest} requestParameters Request parameters.
1040
1024
  * @param {*} [options] Override http request option.
1041
1025
  * @throws {RequiredError}
1042
1026
  */
1043
- getFixedSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options) {
1044
- return localVarFp.getFixedSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options).then((request) => request(axios, basePath));
1027
+ getFixedSlotCapacity(requestParameters, options) {
1028
+ return localVarFp.getFixedSlotCapacity(requestParameters.resourceId, requestParameters.marketplaceIds, requestParameters.body, requestParameters.nextPageToken, options).then((request) => request(axios, basePath));
1045
1029
  },
1046
1030
  /**
1047
1031
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1048
- * @param {string} resourceId Resource Identifier.
1049
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
1050
- * @param {RangeSlotCapacityQuery} body Request body.
1051
- * @param {string} [nextPageToken] Next page token returned in the response of your previous request.
1032
+ * @param {ServiceApiGetRangeSlotCapacityRequest} requestParameters Request parameters.
1052
1033
  * @param {*} [options] Override http request option.
1053
1034
  * @throws {RequiredError}
1054
1035
  */
1055
- getRangeSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options) {
1056
- return localVarFp.getRangeSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options).then((request) => request(axios, basePath));
1036
+ getRangeSlotCapacity(requestParameters, options) {
1037
+ return localVarFp.getRangeSlotCapacity(requestParameters.resourceId, requestParameters.marketplaceIds, requestParameters.body, requestParameters.nextPageToken, options).then((request) => request(axios, basePath));
1057
1038
  },
1058
1039
  /**
1059
1040
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1060
- * @param {string} serviceJobId A service job identifier.
1041
+ * @param {ServiceApiGetServiceJobByServiceJobIdRequest} requestParameters Request parameters.
1061
1042
  * @param {*} [options] Override http request option.
1062
1043
  * @throws {RequiredError}
1063
1044
  */
1064
- getServiceJobByServiceJobId(serviceJobId, options) {
1065
- return localVarFp.getServiceJobByServiceJobId(serviceJobId, options).then((request) => request(axios, basePath));
1045
+ getServiceJobByServiceJobId(requestParameters, options) {
1046
+ return localVarFp.getServiceJobByServiceJobId(requestParameters.serviceJobId, options).then((request) => request(axios, basePath));
1066
1047
  },
1067
1048
  /**
1068
1049
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1069
- * @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
1070
- * @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
1071
- * @param {Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>} [serviceJobStatus] A list of one or more job status by which to filter the list of jobs.
1072
- * @param {string} [pageToken] String returned in the response of your previous request.
1073
- * @param {number} [pageSize] A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.
1074
- * @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
1075
- * @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
1076
- * @param {string} [createdAfter] A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if &#x60;LastUpdatedAfter&#x60; is not specified. Specifying both &#x60;CreatedAfter&#x60; and &#x60;LastUpdatedAfter&#x60; returns an error.
1077
- * @param {string} [createdBefore] A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.
1078
- * @param {string} [lastUpdatedAfter] A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if &#x60;createdAfter&#x60; is not specified. Specifying both &#x60;CreatedAfter&#x60; and &#x60;LastUpdatedAfter&#x60; returns an error.
1079
- * @param {string} [lastUpdatedBefore] A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.
1080
- * @param {string} [scheduleStartDate] A date used for filtering jobs schedules at or after a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.
1081
- * @param {string} [scheduleEndDate] A date used for filtering jobs schedules at or before a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.
1082
- * @param {Array<string>} [asins] List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.
1083
- * @param {Array<string>} [requiredSkills] A defined set of related knowledge, skills, experience, tools, materials, and work processes common to service delivery for a set of products and/or service scenarios. Max values supported is 20.
1084
- * @param {Array<string>} [storeIds] List of Amazon-defined identifiers for the region scope. Max values supported is 50.
1050
+ * @param {ServiceApiGetServiceJobsRequest} requestParameters Request parameters.
1085
1051
  * @param {*} [options] Override http request option.
1086
1052
  * @throws {RequiredError}
1087
1053
  */
1088
- getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, asins, requiredSkills, storeIds, options) {
1089
- return localVarFp.getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, asins, requiredSkills, storeIds, options).then((request) => request(axios, basePath));
1054
+ getServiceJobs(requestParameters, options) {
1055
+ return localVarFp.getServiceJobs(requestParameters.marketplaceIds, requestParameters.serviceOrderIds, requestParameters.serviceJobStatus, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortField, requestParameters.sortOrder, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.scheduleStartDate, requestParameters.scheduleEndDate, requestParameters.asins, requestParameters.requiredSkills, requestParameters.storeIds, options).then((request) => request(axios, basePath));
1090
1056
  },
1091
1057
  /**
1092
1058
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1093
- * @param {string} serviceJobId An Amazon defined service job identifier.
1094
- * @param {string} appointmentId An existing appointment identifier for the Service Job.
1095
- * @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
1059
+ * @param {ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
1096
1060
  * @param {*} [options] Override http request option.
1097
1061
  * @throws {RequiredError}
1098
1062
  */
1099
- rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId, appointmentId, body, options) {
1100
- return localVarFp.rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId, appointmentId, body, options).then((request) => request(axios, basePath));
1063
+ rescheduleAppointmentForServiceJobByServiceJobId(requestParameters, options) {
1064
+ return localVarFp.rescheduleAppointmentForServiceJobByServiceJobId(requestParameters.serviceJobId, requestParameters.appointmentId, requestParameters.body, options).then((request) => request(axios, basePath));
1101
1065
  },
1102
1066
  /**
1103
1067
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1104
- * @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the &#x60;getServiceJobs&#x60; operation of the Services API.
1105
- * @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
1106
- * @param {SetAppointmentFulfillmentDataRequest} body Appointment fulfillment data collection details.
1068
+ * @param {ServiceApiSetAppointmentFulfillmentDataRequest} requestParameters Request parameters.
1107
1069
  * @param {*} [options] Override http request option.
1108
1070
  * @throws {RequiredError}
1109
1071
  */
1110
- setAppointmentFulfillmentData(serviceJobId, appointmentId, body, options) {
1111
- return localVarFp.setAppointmentFulfillmentData(serviceJobId, appointmentId, body, options).then((request) => request(axios, basePath));
1072
+ setAppointmentFulfillmentData(requestParameters, options) {
1073
+ return localVarFp.setAppointmentFulfillmentData(requestParameters.serviceJobId, requestParameters.appointmentId, requestParameters.body, options).then((request) => request(axios, basePath));
1112
1074
  },
1113
1075
  /**
1114
1076
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1115
- * @param {string} reservationId Reservation Identifier
1116
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
1117
- * @param {UpdateReservationRequest} body Reservation details
1077
+ * @param {ServiceApiUpdateReservationRequest} requestParameters Request parameters.
1118
1078
  * @param {*} [options] Override http request option.
1119
1079
  * @throws {RequiredError}
1120
1080
  */
1121
- updateReservation(reservationId, marketplaceIds, body, options) {
1122
- return localVarFp.updateReservation(reservationId, marketplaceIds, body, options).then((request) => request(axios, basePath));
1081
+ updateReservation(requestParameters, options) {
1082
+ return localVarFp.updateReservation(requestParameters.reservationId, requestParameters.marketplaceIds, requestParameters.body, options).then((request) => request(axios, basePath));
1123
1083
  },
1124
1084
  /**
1125
1085
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1126
- * @param {string} resourceId Resource (store) Identifier
1127
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
1128
- * @param {UpdateScheduleRequest} body Schedule details
1086
+ * @param {ServiceApiUpdateScheduleRequest} requestParameters Request parameters.
1129
1087
  * @param {*} [options] Override http request option.
1130
1088
  * @throws {RequiredError}
1131
1089
  */
1132
- updateSchedule(resourceId, marketplaceIds, body, options) {
1133
- return localVarFp.updateSchedule(resourceId, marketplaceIds, body, options).then((request) => request(axios, basePath));
1090
+ updateSchedule(requestParameters, options) {
1091
+ return localVarFp.updateSchedule(requestParameters.resourceId, requestParameters.marketplaceIds, requestParameters.body, options).then((request) => request(axios, basePath));
1134
1092
  },
1135
1093
  };
1136
1094
  };
@@ -15,8 +15,6 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
17
17
  const tslib_1 = require("tslib");
18
- // Some imports not used depending on template conditions
19
- // @ts-ignore
20
18
  const axios_1 = tslib_1.__importDefault(require("axios"));
21
19
  exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
22
20
  /**
@@ -57,10 +55,10 @@ exports.BaseAPI = BaseAPI;
57
55
  */
58
56
  class RequiredError extends Error {
59
57
  field;
60
- name = "RequiredError";
61
58
  constructor(field, msg) {
62
59
  super(msg);
63
60
  this.field = field;
61
+ this.name = "RequiredError";
64
62
  }
65
63
  }
66
64
  exports.RequiredError = RequiredError;
@@ -81,6 +81,8 @@ const setOAuthToObject = async function (object, name, scopes, configuration) {
81
81
  };
82
82
  exports.setOAuthToObject = setOAuthToObject;
83
83
  function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
84
+ if (parameter == null)
85
+ return;
84
86
  if (typeof parameter === "object") {
85
87
  if (Array.isArray(parameter)) {
86
88
  parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
@@ -933,198 +933,156 @@ export const ServiceApiFactory = function (configuration, basePath, axios) {
933
933
  return {
934
934
  /**
935
935
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
936
- * @param {string} serviceJobId An Amazon defined service job identifier.
937
- * @param {AddAppointmentRequest} body Add appointment operation input details.
936
+ * @param {ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
938
937
  * @param {*} [options] Override http request option.
939
938
  * @throws {RequiredError}
940
939
  */
941
- addAppointmentForServiceJobByServiceJobId(serviceJobId, body, options) {
942
- return localVarFp.addAppointmentForServiceJobByServiceJobId(serviceJobId, body, options).then((request) => request(axios, basePath));
940
+ addAppointmentForServiceJobByServiceJobId(requestParameters, options) {
941
+ return localVarFp.addAppointmentForServiceJobByServiceJobId(requestParameters.serviceJobId, requestParameters.body, options).then((request) => request(axios, basePath));
943
942
  },
944
943
  /**
945
944
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
946
- * @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the &#x60;getServiceJobs&#x60; operation of the Services API.
947
- * @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
948
- * @param {AssignAppointmentResourcesRequest} body
945
+ * @param {ServiceApiAssignAppointmentResourcesRequest} requestParameters Request parameters.
949
946
  * @param {*} [options] Override http request option.
950
947
  * @throws {RequiredError}
951
948
  */
952
- assignAppointmentResources(serviceJobId, appointmentId, body, options) {
953
- return localVarFp.assignAppointmentResources(serviceJobId, appointmentId, body, options).then((request) => request(axios, basePath));
949
+ assignAppointmentResources(requestParameters, options) {
950
+ return localVarFp.assignAppointmentResources(requestParameters.serviceJobId, requestParameters.appointmentId, requestParameters.body, options).then((request) => request(axios, basePath));
954
951
  },
955
952
  /**
956
953
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
957
- * @param {string} reservationId Reservation Identifier
958
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
954
+ * @param {ServiceApiCancelReservationRequest} requestParameters Request parameters.
959
955
  * @param {*} [options] Override http request option.
960
956
  * @throws {RequiredError}
961
957
  */
962
- cancelReservation(reservationId, marketplaceIds, options) {
963
- return localVarFp.cancelReservation(reservationId, marketplaceIds, options).then((request) => request(axios, basePath));
958
+ cancelReservation(requestParameters, options) {
959
+ return localVarFp.cancelReservation(requestParameters.reservationId, requestParameters.marketplaceIds, options).then((request) => request(axios, basePath));
964
960
  },
965
961
  /**
966
962
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
967
- * @param {string} serviceJobId An Amazon defined service job identifier.
968
- * @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
963
+ * @param {ServiceApiCancelServiceJobByServiceJobIdRequest} requestParameters Request parameters.
969
964
  * @param {*} [options] Override http request option.
970
965
  * @throws {RequiredError}
971
966
  */
972
- cancelServiceJobByServiceJobId(serviceJobId, cancellationReasonCode, options) {
973
- return localVarFp.cancelServiceJobByServiceJobId(serviceJobId, cancellationReasonCode, options).then((request) => request(axios, basePath));
967
+ cancelServiceJobByServiceJobId(requestParameters, options) {
968
+ return localVarFp.cancelServiceJobByServiceJobId(requestParameters.serviceJobId, requestParameters.cancellationReasonCode, options).then((request) => request(axios, basePath));
974
969
  },
975
970
  /**
976
971
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
977
- * @param {string} serviceJobId An Amazon defined service job identifier.
972
+ * @param {ServiceApiCompleteServiceJobByServiceJobIdRequest} requestParameters Request parameters.
978
973
  * @param {*} [options] Override http request option.
979
974
  * @throws {RequiredError}
980
975
  */
981
- completeServiceJobByServiceJobId(serviceJobId, options) {
982
- return localVarFp.completeServiceJobByServiceJobId(serviceJobId, options).then((request) => request(axios, basePath));
976
+ completeServiceJobByServiceJobId(requestParameters, options) {
977
+ return localVarFp.completeServiceJobByServiceJobId(requestParameters.serviceJobId, options).then((request) => request(axios, basePath));
983
978
  },
984
979
  /**
985
980
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
986
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
987
- * @param {CreateReservationRequest} body Reservation details
981
+ * @param {ServiceApiCreateReservationRequest} requestParameters Request parameters.
988
982
  * @param {*} [options] Override http request option.
989
983
  * @throws {RequiredError}
990
984
  */
991
- createReservation(marketplaceIds, body, options) {
992
- return localVarFp.createReservation(marketplaceIds, body, options).then((request) => request(axios, basePath));
985
+ createReservation(requestParameters, options) {
986
+ return localVarFp.createReservation(requestParameters.marketplaceIds, requestParameters.body, options).then((request) => request(axios, basePath));
993
987
  },
994
988
  /**
995
989
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
996
- * @param {ServiceUploadDocument} body Upload document operation input details.
990
+ * @param {ServiceApiCreateServiceDocumentUploadDestinationRequest} requestParameters Request parameters.
997
991
  * @param {*} [options] Override http request option.
998
992
  * @throws {RequiredError}
999
993
  */
1000
- createServiceDocumentUploadDestination(body, options) {
1001
- return localVarFp.createServiceDocumentUploadDestination(body, options).then((request) => request(axios, basePath));
994
+ createServiceDocumentUploadDestination(requestParameters, options) {
995
+ return localVarFp.createServiceDocumentUploadDestination(requestParameters.body, options).then((request) => request(axios, basePath));
1002
996
  },
1003
997
  /**
1004
998
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1005
- * @param {string} asin ASIN associated with the service.
1006
- * @param {string} storeId Store identifier defining the region scope to retrive appointment slots.
1007
- * @param {Array<string>} marketplaceIds An identifier for the marketplace for which appointment slots are queried
1008
- * @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;startTime&#x60; is provided, &#x60;endTime&#x60; should also be provided. Default value is as per business configuration.
1009
- * @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;endTime&#x60; is provided, &#x60;startTime&#x60; should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
999
+ * @param {ServiceApiGetAppointmentSlotsRequest} requestParameters Request parameters.
1010
1000
  * @param {*} [options] Override http request option.
1011
1001
  * @throws {RequiredError}
1012
1002
  */
1013
- getAppointmentSlots(asin, storeId, marketplaceIds, startTime, endTime, options) {
1014
- return localVarFp.getAppointmentSlots(asin, storeId, marketplaceIds, startTime, endTime, options).then((request) => request(axios, basePath));
1003
+ getAppointmentSlots(requestParameters, options) {
1004
+ return localVarFp.getAppointmentSlots(requestParameters.asin, requestParameters.storeId, requestParameters.marketplaceIds, requestParameters.startTime, requestParameters.endTime, options).then((request) => request(axios, basePath));
1015
1005
  },
1016
1006
  /**
1017
1007
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1018
- * @param {string} serviceJobId A service job identifier to retrive appointment slots for associated service.
1019
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
1020
- * @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;startTime&#x60; is provided, &#x60;endTime&#x60; should also be provided. Default value is as per business configuration.
1021
- * @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;endTime&#x60; is provided, &#x60;startTime&#x60; should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
1008
+ * @param {ServiceApiGetAppointmmentSlotsByJobIdRequest} requestParameters Request parameters.
1022
1009
  * @param {*} [options] Override http request option.
1023
1010
  * @throws {RequiredError}
1024
1011
  */
1025
- getAppointmmentSlotsByJobId(serviceJobId, marketplaceIds, startTime, endTime, options) {
1026
- return localVarFp.getAppointmmentSlotsByJobId(serviceJobId, marketplaceIds, startTime, endTime, options).then((request) => request(axios, basePath));
1012
+ getAppointmmentSlotsByJobId(requestParameters, options) {
1013
+ return localVarFp.getAppointmmentSlotsByJobId(requestParameters.serviceJobId, requestParameters.marketplaceIds, requestParameters.startTime, requestParameters.endTime, options).then((request) => request(axios, basePath));
1027
1014
  },
1028
1015
  /**
1029
1016
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1030
- * @param {string} resourceId Resource Identifier.
1031
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
1032
- * @param {FixedSlotCapacityQuery} body Request body.
1033
- * @param {string} [nextPageToken] Next page token returned in the response of your previous request.
1017
+ * @param {ServiceApiGetFixedSlotCapacityRequest} requestParameters Request parameters.
1034
1018
  * @param {*} [options] Override http request option.
1035
1019
  * @throws {RequiredError}
1036
1020
  */
1037
- getFixedSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options) {
1038
- return localVarFp.getFixedSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options).then((request) => request(axios, basePath));
1021
+ getFixedSlotCapacity(requestParameters, options) {
1022
+ return localVarFp.getFixedSlotCapacity(requestParameters.resourceId, requestParameters.marketplaceIds, requestParameters.body, requestParameters.nextPageToken, options).then((request) => request(axios, basePath));
1039
1023
  },
1040
1024
  /**
1041
1025
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1042
- * @param {string} resourceId Resource Identifier.
1043
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
1044
- * @param {RangeSlotCapacityQuery} body Request body.
1045
- * @param {string} [nextPageToken] Next page token returned in the response of your previous request.
1026
+ * @param {ServiceApiGetRangeSlotCapacityRequest} requestParameters Request parameters.
1046
1027
  * @param {*} [options] Override http request option.
1047
1028
  * @throws {RequiredError}
1048
1029
  */
1049
- getRangeSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options) {
1050
- return localVarFp.getRangeSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options).then((request) => request(axios, basePath));
1030
+ getRangeSlotCapacity(requestParameters, options) {
1031
+ return localVarFp.getRangeSlotCapacity(requestParameters.resourceId, requestParameters.marketplaceIds, requestParameters.body, requestParameters.nextPageToken, options).then((request) => request(axios, basePath));
1051
1032
  },
1052
1033
  /**
1053
1034
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1054
- * @param {string} serviceJobId A service job identifier.
1035
+ * @param {ServiceApiGetServiceJobByServiceJobIdRequest} requestParameters Request parameters.
1055
1036
  * @param {*} [options] Override http request option.
1056
1037
  * @throws {RequiredError}
1057
1038
  */
1058
- getServiceJobByServiceJobId(serviceJobId, options) {
1059
- return localVarFp.getServiceJobByServiceJobId(serviceJobId, options).then((request) => request(axios, basePath));
1039
+ getServiceJobByServiceJobId(requestParameters, options) {
1040
+ return localVarFp.getServiceJobByServiceJobId(requestParameters.serviceJobId, options).then((request) => request(axios, basePath));
1060
1041
  },
1061
1042
  /**
1062
1043
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1063
- * @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
1064
- * @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
1065
- * @param {Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>} [serviceJobStatus] A list of one or more job status by which to filter the list of jobs.
1066
- * @param {string} [pageToken] String returned in the response of your previous request.
1067
- * @param {number} [pageSize] A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.
1068
- * @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
1069
- * @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
1070
- * @param {string} [createdAfter] A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if &#x60;LastUpdatedAfter&#x60; is not specified. Specifying both &#x60;CreatedAfter&#x60; and &#x60;LastUpdatedAfter&#x60; returns an error.
1071
- * @param {string} [createdBefore] A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.
1072
- * @param {string} [lastUpdatedAfter] A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if &#x60;createdAfter&#x60; is not specified. Specifying both &#x60;CreatedAfter&#x60; and &#x60;LastUpdatedAfter&#x60; returns an error.
1073
- * @param {string} [lastUpdatedBefore] A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.
1074
- * @param {string} [scheduleStartDate] A date used for filtering jobs schedules at or after a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.
1075
- * @param {string} [scheduleEndDate] A date used for filtering jobs schedules at or before a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.
1076
- * @param {Array<string>} [asins] List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.
1077
- * @param {Array<string>} [requiredSkills] A defined set of related knowledge, skills, experience, tools, materials, and work processes common to service delivery for a set of products and/or service scenarios. Max values supported is 20.
1078
- * @param {Array<string>} [storeIds] List of Amazon-defined identifiers for the region scope. Max values supported is 50.
1044
+ * @param {ServiceApiGetServiceJobsRequest} requestParameters Request parameters.
1079
1045
  * @param {*} [options] Override http request option.
1080
1046
  * @throws {RequiredError}
1081
1047
  */
1082
- getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, asins, requiredSkills, storeIds, options) {
1083
- return localVarFp.getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, asins, requiredSkills, storeIds, options).then((request) => request(axios, basePath));
1048
+ getServiceJobs(requestParameters, options) {
1049
+ return localVarFp.getServiceJobs(requestParameters.marketplaceIds, requestParameters.serviceOrderIds, requestParameters.serviceJobStatus, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortField, requestParameters.sortOrder, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.scheduleStartDate, requestParameters.scheduleEndDate, requestParameters.asins, requestParameters.requiredSkills, requestParameters.storeIds, options).then((request) => request(axios, basePath));
1084
1050
  },
1085
1051
  /**
1086
1052
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1087
- * @param {string} serviceJobId An Amazon defined service job identifier.
1088
- * @param {string} appointmentId An existing appointment identifier for the Service Job.
1089
- * @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
1053
+ * @param {ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
1090
1054
  * @param {*} [options] Override http request option.
1091
1055
  * @throws {RequiredError}
1092
1056
  */
1093
- rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId, appointmentId, body, options) {
1094
- return localVarFp.rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId, appointmentId, body, options).then((request) => request(axios, basePath));
1057
+ rescheduleAppointmentForServiceJobByServiceJobId(requestParameters, options) {
1058
+ return localVarFp.rescheduleAppointmentForServiceJobByServiceJobId(requestParameters.serviceJobId, requestParameters.appointmentId, requestParameters.body, options).then((request) => request(axios, basePath));
1095
1059
  },
1096
1060
  /**
1097
1061
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1098
- * @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the &#x60;getServiceJobs&#x60; operation of the Services API.
1099
- * @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
1100
- * @param {SetAppointmentFulfillmentDataRequest} body Appointment fulfillment data collection details.
1062
+ * @param {ServiceApiSetAppointmentFulfillmentDataRequest} requestParameters Request parameters.
1101
1063
  * @param {*} [options] Override http request option.
1102
1064
  * @throws {RequiredError}
1103
1065
  */
1104
- setAppointmentFulfillmentData(serviceJobId, appointmentId, body, options) {
1105
- return localVarFp.setAppointmentFulfillmentData(serviceJobId, appointmentId, body, options).then((request) => request(axios, basePath));
1066
+ setAppointmentFulfillmentData(requestParameters, options) {
1067
+ return localVarFp.setAppointmentFulfillmentData(requestParameters.serviceJobId, requestParameters.appointmentId, requestParameters.body, options).then((request) => request(axios, basePath));
1106
1068
  },
1107
1069
  /**
1108
1070
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1109
- * @param {string} reservationId Reservation Identifier
1110
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
1111
- * @param {UpdateReservationRequest} body Reservation details
1071
+ * @param {ServiceApiUpdateReservationRequest} requestParameters Request parameters.
1112
1072
  * @param {*} [options] Override http request option.
1113
1073
  * @throws {RequiredError}
1114
1074
  */
1115
- updateReservation(reservationId, marketplaceIds, body, options) {
1116
- return localVarFp.updateReservation(reservationId, marketplaceIds, body, options).then((request) => request(axios, basePath));
1075
+ updateReservation(requestParameters, options) {
1076
+ return localVarFp.updateReservation(requestParameters.reservationId, requestParameters.marketplaceIds, requestParameters.body, options).then((request) => request(axios, basePath));
1117
1077
  },
1118
1078
  /**
1119
1079
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1120
- * @param {string} resourceId Resource (store) Identifier
1121
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
1122
- * @param {UpdateScheduleRequest} body Schedule details
1080
+ * @param {ServiceApiUpdateScheduleRequest} requestParameters Request parameters.
1123
1081
  * @param {*} [options] Override http request option.
1124
1082
  * @throws {RequiredError}
1125
1083
  */
1126
- updateSchedule(resourceId, marketplaceIds, body, options) {
1127
- return localVarFp.updateSchedule(resourceId, marketplaceIds, body, options).then((request) => request(axios, basePath));
1084
+ updateSchedule(requestParameters, options) {
1085
+ return localVarFp.updateSchedule(requestParameters.resourceId, requestParameters.marketplaceIds, requestParameters.body, options).then((request) => request(axios, basePath));
1128
1086
  },
1129
1087
  };
1130
1088
  };
@@ -11,8 +11,6 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- // Some imports not used depending on template conditions
15
- // @ts-ignore
16
14
  import globalAxios from 'axios';
17
15
  export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
18
16
  /**
@@ -52,9 +50,9 @@ export class BaseAPI {
52
50
  */
53
51
  export class RequiredError extends Error {
54
52
  field;
55
- name = "RequiredError";
56
53
  constructor(field, msg) {
57
54
  super(msg);
58
55
  this.field = field;
56
+ this.name = "RequiredError";
59
57
  }
60
58
  }
@@ -73,6 +73,8 @@ export const setOAuthToObject = async function (object, name, scopes, configurat
73
73
  }
74
74
  };
75
75
  function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
76
+ if (parameter == null)
77
+ return;
76
78
  if (typeof parameter === "object") {
77
79
  if (Array.isArray(parameter)) {
78
80
  parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
@@ -9,8 +9,8 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
- import { Configuration } from '../configuration';
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { AddAppointmentRequest } from '../models';
16
16
  import { AssignAppointmentResourcesRequest } from '../models';
@@ -377,165 +377,123 @@ export declare const ServiceApiFp: (configuration?: Configuration) => {
377
377
  export declare const ServiceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
378
378
  /**
379
379
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
380
- * @param {string} serviceJobId An Amazon defined service job identifier.
381
- * @param {AddAppointmentRequest} body Add appointment operation input details.
380
+ * @param {ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
382
381
  * @param {*} [options] Override http request option.
383
382
  * @throws {RequiredError}
384
383
  */
385
- addAppointmentForServiceJobByServiceJobId(serviceJobId: string, body: AddAppointmentRequest, options?: any): AxiosPromise<SetAppointmentResponse>;
384
+ addAppointmentForServiceJobByServiceJobId(requestParameters: ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest, options?: AxiosRequestConfig): AxiosPromise<SetAppointmentResponse>;
386
385
  /**
387
386
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
388
- * @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the &#x60;getServiceJobs&#x60; operation of the Services API.
389
- * @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
390
- * @param {AssignAppointmentResourcesRequest} body
387
+ * @param {ServiceApiAssignAppointmentResourcesRequest} requestParameters Request parameters.
391
388
  * @param {*} [options] Override http request option.
392
389
  * @throws {RequiredError}
393
390
  */
394
- assignAppointmentResources(serviceJobId: string, appointmentId: string, body: AssignAppointmentResourcesRequest, options?: any): AxiosPromise<AssignAppointmentResourcesResponse>;
391
+ assignAppointmentResources(requestParameters: ServiceApiAssignAppointmentResourcesRequest, options?: AxiosRequestConfig): AxiosPromise<AssignAppointmentResourcesResponse>;
395
392
  /**
396
393
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
397
- * @param {string} reservationId Reservation Identifier
398
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
394
+ * @param {ServiceApiCancelReservationRequest} requestParameters Request parameters.
399
395
  * @param {*} [options] Override http request option.
400
396
  * @throws {RequiredError}
401
397
  */
402
- cancelReservation(reservationId: string, marketplaceIds: Array<string>, options?: any): AxiosPromise<CancelReservationResponse>;
398
+ cancelReservation(requestParameters: ServiceApiCancelReservationRequest, options?: AxiosRequestConfig): AxiosPromise<CancelReservationResponse>;
403
399
  /**
404
400
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
405
- * @param {string} serviceJobId An Amazon defined service job identifier.
406
- * @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
401
+ * @param {ServiceApiCancelServiceJobByServiceJobIdRequest} requestParameters Request parameters.
407
402
  * @param {*} [options] Override http request option.
408
403
  * @throws {RequiredError}
409
404
  */
410
- cancelServiceJobByServiceJobId(serviceJobId: string, cancellationReasonCode: string, options?: any): AxiosPromise<CancelServiceJobByServiceJobIdResponse>;
405
+ cancelServiceJobByServiceJobId(requestParameters: ServiceApiCancelServiceJobByServiceJobIdRequest, options?: AxiosRequestConfig): AxiosPromise<CancelServiceJobByServiceJobIdResponse>;
411
406
  /**
412
407
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
413
- * @param {string} serviceJobId An Amazon defined service job identifier.
408
+ * @param {ServiceApiCompleteServiceJobByServiceJobIdRequest} requestParameters Request parameters.
414
409
  * @param {*} [options] Override http request option.
415
410
  * @throws {RequiredError}
416
411
  */
417
- completeServiceJobByServiceJobId(serviceJobId: string, options?: any): AxiosPromise<CompleteServiceJobByServiceJobIdResponse>;
412
+ completeServiceJobByServiceJobId(requestParameters: ServiceApiCompleteServiceJobByServiceJobIdRequest, options?: AxiosRequestConfig): AxiosPromise<CompleteServiceJobByServiceJobIdResponse>;
418
413
  /**
419
414
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
420
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
421
- * @param {CreateReservationRequest} body Reservation details
415
+ * @param {ServiceApiCreateReservationRequest} requestParameters Request parameters.
422
416
  * @param {*} [options] Override http request option.
423
417
  * @throws {RequiredError}
424
418
  */
425
- createReservation(marketplaceIds: Array<string>, body: CreateReservationRequest, options?: any): AxiosPromise<CreateReservationResponse>;
419
+ createReservation(requestParameters: ServiceApiCreateReservationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateReservationResponse>;
426
420
  /**
427
421
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
428
- * @param {ServiceUploadDocument} body Upload document operation input details.
422
+ * @param {ServiceApiCreateServiceDocumentUploadDestinationRequest} requestParameters Request parameters.
429
423
  * @param {*} [options] Override http request option.
430
424
  * @throws {RequiredError}
431
425
  */
432
- createServiceDocumentUploadDestination(body: ServiceUploadDocument, options?: any): AxiosPromise<CreateServiceDocumentUploadDestination>;
426
+ createServiceDocumentUploadDestination(requestParameters: ServiceApiCreateServiceDocumentUploadDestinationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateServiceDocumentUploadDestination>;
433
427
  /**
434
428
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
435
- * @param {string} asin ASIN associated with the service.
436
- * @param {string} storeId Store identifier defining the region scope to retrive appointment slots.
437
- * @param {Array<string>} marketplaceIds An identifier for the marketplace for which appointment slots are queried
438
- * @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;startTime&#x60; is provided, &#x60;endTime&#x60; should also be provided. Default value is as per business configuration.
439
- * @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;endTime&#x60; is provided, &#x60;startTime&#x60; should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
429
+ * @param {ServiceApiGetAppointmentSlotsRequest} requestParameters Request parameters.
440
430
  * @param {*} [options] Override http request option.
441
431
  * @throws {RequiredError}
442
432
  */
443
- getAppointmentSlots(asin: string, storeId: string, marketplaceIds: Array<string>, startTime?: string, endTime?: string, options?: any): AxiosPromise<GetAppointmentSlotsResponse>;
433
+ getAppointmentSlots(requestParameters: ServiceApiGetAppointmentSlotsRequest, options?: AxiosRequestConfig): AxiosPromise<GetAppointmentSlotsResponse>;
444
434
  /**
445
435
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
446
- * @param {string} serviceJobId A service job identifier to retrive appointment slots for associated service.
447
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
448
- * @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;startTime&#x60; is provided, &#x60;endTime&#x60; should also be provided. Default value is as per business configuration.
449
- * @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;endTime&#x60; is provided, &#x60;startTime&#x60; should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
436
+ * @param {ServiceApiGetAppointmmentSlotsByJobIdRequest} requestParameters Request parameters.
450
437
  * @param {*} [options] Override http request option.
451
438
  * @throws {RequiredError}
452
439
  */
453
- getAppointmmentSlotsByJobId(serviceJobId: string, marketplaceIds: Array<string>, startTime?: string, endTime?: string, options?: any): AxiosPromise<GetAppointmentSlotsResponse>;
440
+ getAppointmmentSlotsByJobId(requestParameters: ServiceApiGetAppointmmentSlotsByJobIdRequest, options?: AxiosRequestConfig): AxiosPromise<GetAppointmentSlotsResponse>;
454
441
  /**
455
442
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
456
- * @param {string} resourceId Resource Identifier.
457
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
458
- * @param {FixedSlotCapacityQuery} body Request body.
459
- * @param {string} [nextPageToken] Next page token returned in the response of your previous request.
443
+ * @param {ServiceApiGetFixedSlotCapacityRequest} requestParameters Request parameters.
460
444
  * @param {*} [options] Override http request option.
461
445
  * @throws {RequiredError}
462
446
  */
463
- getFixedSlotCapacity(resourceId: string, marketplaceIds: Array<string>, body: FixedSlotCapacityQuery, nextPageToken?: string, options?: any): AxiosPromise<FixedSlotCapacity>;
447
+ getFixedSlotCapacity(requestParameters: ServiceApiGetFixedSlotCapacityRequest, options?: AxiosRequestConfig): AxiosPromise<FixedSlotCapacity>;
464
448
  /**
465
449
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
466
- * @param {string} resourceId Resource Identifier.
467
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
468
- * @param {RangeSlotCapacityQuery} body Request body.
469
- * @param {string} [nextPageToken] Next page token returned in the response of your previous request.
450
+ * @param {ServiceApiGetRangeSlotCapacityRequest} requestParameters Request parameters.
470
451
  * @param {*} [options] Override http request option.
471
452
  * @throws {RequiredError}
472
453
  */
473
- getRangeSlotCapacity(resourceId: string, marketplaceIds: Array<string>, body: RangeSlotCapacityQuery, nextPageToken?: string, options?: any): AxiosPromise<RangeSlotCapacity>;
454
+ getRangeSlotCapacity(requestParameters: ServiceApiGetRangeSlotCapacityRequest, options?: AxiosRequestConfig): AxiosPromise<RangeSlotCapacity>;
474
455
  /**
475
456
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
476
- * @param {string} serviceJobId A service job identifier.
457
+ * @param {ServiceApiGetServiceJobByServiceJobIdRequest} requestParameters Request parameters.
477
458
  * @param {*} [options] Override http request option.
478
459
  * @throws {RequiredError}
479
460
  */
480
- getServiceJobByServiceJobId(serviceJobId: string, options?: any): AxiosPromise<GetServiceJobByServiceJobIdResponse>;
461
+ getServiceJobByServiceJobId(requestParameters: ServiceApiGetServiceJobByServiceJobIdRequest, options?: AxiosRequestConfig): AxiosPromise<GetServiceJobByServiceJobIdResponse>;
481
462
  /**
482
463
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
483
- * @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
484
- * @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
485
- * @param {Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>} [serviceJobStatus] A list of one or more job status by which to filter the list of jobs.
486
- * @param {string} [pageToken] String returned in the response of your previous request.
487
- * @param {number} [pageSize] A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.
488
- * @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
489
- * @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
490
- * @param {string} [createdAfter] A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if &#x60;LastUpdatedAfter&#x60; is not specified. Specifying both &#x60;CreatedAfter&#x60; and &#x60;LastUpdatedAfter&#x60; returns an error.
491
- * @param {string} [createdBefore] A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.
492
- * @param {string} [lastUpdatedAfter] A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if &#x60;createdAfter&#x60; is not specified. Specifying both &#x60;CreatedAfter&#x60; and &#x60;LastUpdatedAfter&#x60; returns an error.
493
- * @param {string} [lastUpdatedBefore] A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.
494
- * @param {string} [scheduleStartDate] A date used for filtering jobs schedules at or after a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.
495
- * @param {string} [scheduleEndDate] A date used for filtering jobs schedules at or before a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.
496
- * @param {Array<string>} [asins] List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.
497
- * @param {Array<string>} [requiredSkills] A defined set of related knowledge, skills, experience, tools, materials, and work processes common to service delivery for a set of products and/or service scenarios. Max values supported is 20.
498
- * @param {Array<string>} [storeIds] List of Amazon-defined identifiers for the region scope. Max values supported is 50.
464
+ * @param {ServiceApiGetServiceJobsRequest} requestParameters Request parameters.
499
465
  * @param {*} [options] Override http request option.
500
466
  * @throws {RequiredError}
501
467
  */
502
- getServiceJobs(marketplaceIds: Array<string>, serviceOrderIds?: Array<string>, serviceJobStatus?: Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>, pageToken?: string, pageSize?: number, sortField?: 'JOB_DATE' | 'JOB_STATUS', sortOrder?: 'ASC' | 'DESC', createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, scheduleStartDate?: string, scheduleEndDate?: string, asins?: Array<string>, requiredSkills?: Array<string>, storeIds?: Array<string>, options?: any): AxiosPromise<GetServiceJobsResponse>;
468
+ getServiceJobs(requestParameters: ServiceApiGetServiceJobsRequest, options?: AxiosRequestConfig): AxiosPromise<GetServiceJobsResponse>;
503
469
  /**
504
470
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
505
- * @param {string} serviceJobId An Amazon defined service job identifier.
506
- * @param {string} appointmentId An existing appointment identifier for the Service Job.
507
- * @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
471
+ * @param {ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
508
472
  * @param {*} [options] Override http request option.
509
473
  * @throws {RequiredError}
510
474
  */
511
- rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId: string, appointmentId: string, body: RescheduleAppointmentRequest, options?: any): AxiosPromise<SetAppointmentResponse>;
475
+ rescheduleAppointmentForServiceJobByServiceJobId(requestParameters: ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest, options?: AxiosRequestConfig): AxiosPromise<SetAppointmentResponse>;
512
476
  /**
513
477
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
514
- * @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the &#x60;getServiceJobs&#x60; operation of the Services API.
515
- * @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
516
- * @param {SetAppointmentFulfillmentDataRequest} body Appointment fulfillment data collection details.
478
+ * @param {ServiceApiSetAppointmentFulfillmentDataRequest} requestParameters Request parameters.
517
479
  * @param {*} [options] Override http request option.
518
480
  * @throws {RequiredError}
519
481
  */
520
- setAppointmentFulfillmentData(serviceJobId: string, appointmentId: string, body: SetAppointmentFulfillmentDataRequest, options?: any): AxiosPromise<string>;
482
+ setAppointmentFulfillmentData(requestParameters: ServiceApiSetAppointmentFulfillmentDataRequest, options?: AxiosRequestConfig): AxiosPromise<string>;
521
483
  /**
522
484
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
523
- * @param {string} reservationId Reservation Identifier
524
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
525
- * @param {UpdateReservationRequest} body Reservation details
485
+ * @param {ServiceApiUpdateReservationRequest} requestParameters Request parameters.
526
486
  * @param {*} [options] Override http request option.
527
487
  * @throws {RequiredError}
528
488
  */
529
- updateReservation(reservationId: string, marketplaceIds: Array<string>, body: UpdateReservationRequest, options?: any): AxiosPromise<UpdateReservationResponse>;
489
+ updateReservation(requestParameters: ServiceApiUpdateReservationRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateReservationResponse>;
530
490
  /**
531
491
  * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
532
- * @param {string} resourceId Resource (store) Identifier
533
- * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
534
- * @param {UpdateScheduleRequest} body Schedule details
492
+ * @param {ServiceApiUpdateScheduleRequest} requestParameters Request parameters.
535
493
  * @param {*} [options] Override http request option.
536
494
  * @throws {RequiredError}
537
495
  */
538
- updateSchedule(resourceId: string, marketplaceIds: Array<string>, body: UpdateScheduleRequest, options?: any): AxiosPromise<UpdateScheduleResponse>;
496
+ updateSchedule(requestParameters: ServiceApiUpdateScheduleRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateScheduleResponse>;
539
497
  };
540
498
  /**
541
499
  * Request parameters for addAppointmentForServiceJobByServiceJobId operation in ServiceApi.
@@ -9,8 +9,8 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { Configuration } from "./configuration";
13
- import { AxiosInstance, AxiosRequestConfig } from 'axios';
12
+ import type { Configuration } from './configuration';
13
+ import type { AxiosInstance, AxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
15
  /**
16
16
  *
@@ -50,6 +50,5 @@ export declare class BaseAPI {
50
50
  */
51
51
  export declare class RequiredError extends Error {
52
52
  field: string;
53
- name: "RequiredError";
54
53
  constructor(field: string, msg?: string);
55
54
  }
@@ -10,9 +10,9 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /// <reference types="node" />
13
- import { Configuration } from "./configuration";
14
- import { RequestArgs } from "./base";
15
- import { AxiosInstance, AxiosResponse } from 'axios';
13
+ import type { Configuration } from "./configuration";
14
+ import type { RequestArgs } from "./base";
15
+ import type { AxiosInstance, AxiosResponse } from 'axios';
16
16
  /**
17
17
  *
18
18
  * @export
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/services-api-v1",
3
3
  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
4
  "description": "With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.",
5
- "version": "1.10.9",
5
+ "version": "1.10.10",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -26,7 +26,7 @@
26
26
  "test": "jest"
27
27
  },
28
28
  "dependencies": {
29
- "@sp-api-sdk/common": "^1.9.21",
29
+ "@sp-api-sdk/common": "^1.9.22",
30
30
  "axios": "^0.27.2"
31
31
  },
32
32
  "repository": {
@@ -51,5 +51,5 @@
51
51
  "typedoc": {
52
52
  "entryPoint": "./index.ts"
53
53
  },
54
- "gitHead": "4aae180b5a1395b37b673b93c285065ddba25470"
54
+ "gitHead": "19982f06cbbd770bfc7b9f1bc8a42f59b57baead"
55
55
  }