Package-level declarations

Types

Link copied to clipboard
data class AdditionalConfigurationResponse(val hierarchyInformation: HierarchyInformationResponse, val quantity: Int)

Additional Configuration details.

Link copied to clipboard
data class AddressDetailsResponse(val forwardAddress: AddressPropertiesResponse, val returnAddress: AddressPropertiesResponse)

Address details for an order item.

Link copied to clipboard
data class AddressPropertiesResponse(val addressValidationStatus: String, val contactDetails: ContactDetailsResponse, val shippingAddress: ShippingAddressResponse? = null)

Address Properties

Link copied to clipboard
data class AvailabilityInformationResponse(val availabilityStage: String, val disabledReason: String, val disabledReasonMessage: String)

Availability information of a product system.

Link copied to clipboard
data class BillingMeterDetailsResponse(val frequency: String, val meterDetails: Either<Pav2MeterDetailsResponse, PurchaseMeterDetailsResponse>, val meteringType: String, val name: String)

Holds billing meter details for each type of billing.

Link copied to clipboard
data class CategoryInformationResponse(val categoryDisplayName: String? = null, val categoryName: String? = null, val description: String? = null, val links: List<LinkResponse>? = null)

Category related properties of a child configuration.

Link copied to clipboard
data class ChildConfigurationResponse(val availabilityInformation: AvailabilityInformationResponse, val childConfigurationType: String, val childConfigurationTypes: List<String>, val costInformation: CostInformationResponse, val description: DescriptionResponse, val dimensions: DimensionsResponse, val displayName: String, val filterableProperties: List<FilterablePropertyResponse>, val fulfilledBy: String, val groupedChildConfigurations: List<GroupedChildConfigurationsResponse>, val hierarchyInformation: HierarchyInformationResponse, val imageInformation: List<ImageInformationResponse>, val isPartOfBaseConfiguration: Boolean, val maximumQuantity: Int, val minimumQuantity: Int, val specifications: List<SpecificationResponse>)

Child configuration object.

Link copied to clipboard
data class ConfigurationDeviceDetailsResponse(val deviceDetails: List<DeviceDetailsResponse>, val displayInfo: DisplayInfoResponse? = null, val hierarchyInformation: HierarchyInformationResponse, val identificationType: String, val quantity: Int)

Device details for configuration.

Link copied to clipboard
data class ConfigurationResponse(val availabilityInformation: AvailabilityInformationResponse, val childConfigurationTypes: List<String>, val costInformation: CostInformationResponse, val description: DescriptionResponse, val dimensions: DimensionsResponse, val displayName: String, val filterableProperties: List<FilterablePropertyResponse>, val fulfilledBy: String, val groupedChildConfigurations: List<GroupedChildConfigurationsResponse>, val hierarchyInformation: HierarchyInformationResponse, val imageInformation: List<ImageInformationResponse>, val specifications: List<SpecificationResponse>)

Configuration object.

Link copied to clipboard
data class ContactDetailsResponse(val contactName: String, val emailList: List<String>, val mobile: String? = null, val phone: String, val phoneExtension: String? = null)

Contact Details.

Link copied to clipboard
data class CostInformationResponse(val billingInfoUrl: String, val billingMeterDetails: List<BillingMeterDetailsResponse>)

Cost information for the product system.

Link copied to clipboard
data class DescriptionResponse(val attributes: List<String>, val descriptionType: String, val keywords: List<String>, val links: List<LinkResponse>, val longDescription: String, val shortDescription: String)

Description related properties of a product system.

Link copied to clipboard
data class DeviceDetailsResponse(val managementResourceId: String, val managementResourceTenantId: String, val serialNumber: String)

Device details.

Link copied to clipboard
data class DimensionsResponse(val depth: Double, val height: Double, val length: Double, val lengthHeightUnit: String, val weight: Double, val weightUnit: String, val width: Double)

Dimensions of a configuration.

Link copied to clipboard
data class DisplayInfoResponse(val configurationDisplayName: String, val productFamilyDisplayName: String)

Describes product display information

Link copied to clipboard
data class EncryptionPreferencesResponse(val doubleEncryptionStatus: String? = null)

Preferences related to the double encryption

Link copied to clipboard
data class ErrorAdditionalInfoResponse(val info: Any, val type: String)

The resource management error additional info.

Link copied to clipboard
data class ErrorDetailResponse(val additionalInfo: List<ErrorAdditionalInfoResponse>, val code: String, val details: List<ErrorDetailResponse>, val message: String, val target: String)

The error detail.

Link copied to clipboard
data class FilterablePropertyResponse(val supportedValues: List<String>, val type: String)

Different types of filters supported and its values.

Link copied to clipboard
data class ForwardShippingDetailsResponse(val carrierDisplayName: String, val carrierName: String, val trackingId: String, val trackingUrl: String)

Forward shipment details.

Link copied to clipboard
data class GetAddressByNameResult(val addressValidationStatus: String, val contactDetails: ContactDetailsResponse, val id: String, val location: String, val name: String, val shippingAddress: ShippingAddressResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Address Resource.

Link copied to clipboard
data class GetAddressResult(val addressValidationStatus: String, val contactDetails: ContactDetailsResponse, val id: String, val location: String, val name: String, val shippingAddress: ShippingAddressResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Address Resource.

Link copied to clipboard
data class GetOrderItemByNameResult(val addressDetails: AddressDetailsResponse, val id: String, val location: String, val name: String, val orderId: String, val orderItemDetails: OrderItemDetailsResponse, val startTime: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents order item contract

Link copied to clipboard
data class GetOrderItemResult(val addressDetails: AddressDetailsResponse, val id: String, val location: String, val name: String, val orderId: String, val orderItemDetails: OrderItemDetailsResponse, val startTime: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents order item resource.

Link copied to clipboard
data class GroupedChildConfigurationsResponse(val categoryInformation: CategoryInformationResponse, val childConfigurations: List<ChildConfigurationResponse>)

Grouped child configuration object.

Link copied to clipboard
data class HierarchyInformationResponse(val configurationName: String? = null, val productFamilyName: String? = null, val productLineName: String? = null, val productName: String? = null)

Holds details about product hierarchy information.

Link copied to clipboard
data class ImageInformationResponse(val imageType: String, val imageUrl: String)

Image for the product.

Link copied to clipboard
data class LinkResponse(val linkType: String, val linkUrl: String)

Returns link related to the product.

Link copied to clipboard
data class ListConfigurationsResult(val nextLink: String? = null, val value: List<ConfigurationResponse>)

The list of configurations.

Link copied to clipboard
data class ListProductFamiliesResult(val nextLink: String? = null, val value: List<ProductFamilyResponse>)

The list of product families.

The list of product families.

Link copied to clipboard
data class ListProductsAndConfigurationsResult(val nextLink: String? = null, val value: List<ConfigurationResponse>)

The list of configurations.

Link copied to clipboard
data class ManagementResourcePreferencesResponse(val preferredManagementResourceId: String? = null)

Management resource preference to link device

Link copied to clipboard
data class NotificationPreferenceResponse(val sendNotification: Boolean, val stageName: String)

Notification preference for a job stage.

Link copied to clipboard
data class OrderItemDetailsResponse(val cancellationReason: String, val cancellationStatus: String, val currentStage: StageDetailsResponse, val deletionStatus: String, val error: ErrorDetailResponse, val forwardShippingDetails: ForwardShippingDetailsResponse, val managementRpDetails: ResourceProviderDetailsResponse, val managementRpDetailsList: List<ResourceProviderDetailsResponse>, val notificationEmailList: List<String>? = null, val orderItemMode: String? = null, val orderItemStageHistory: List<StageDetailsResponse>, val orderItemType: String, val preferences: PreferencesResponse? = null, val productDetails: ProductDetailsResponse, val returnReason: String, val returnStatus: String, val reverseShippingDetails: ReverseShippingDetailsResponse)

Order item details

Link copied to clipboard
data class Pav2MeterDetailsResponse(val billingType: String, val chargingType: String, val meterGuid: String, val multiplier: Double)

Billing type PAV2 meter details.

Link copied to clipboard
data class PreferencesResponse(val encryptionPreferences: EncryptionPreferencesResponse? = null, val managementResourcePreferences: ManagementResourcePreferencesResponse? = null, val notificationPreferences: List<NotificationPreferenceResponse>? = null, val transportPreferences: TransportPreferencesResponse? = null)

Preferences related to the order

Link copied to clipboard
data class ProductDetailsResponse(val childConfigurationDeviceDetails: List<ConfigurationDeviceDetailsResponse>? = null, val count: Int, val deviceDetails: List<DeviceDetailsResponse>, val displayInfo: DisplayInfoResponse? = null, val hierarchyInformation: HierarchyInformationResponse, val identificationType: String? = null, val optInAdditionalConfigurations: List<AdditionalConfigurationResponse>? = null, val parentDeviceDetails: DeviceDetailsResponse? = null, val productDoubleEncryptionStatus: String)

Represents product details

Link copied to clipboard
data class ProductFamilyResponse(val availabilityInformation: AvailabilityInformationResponse, val costInformation: CostInformationResponse, val description: DescriptionResponse, val displayName: String, val filterableProperties: List<FilterablePropertyResponse>, val fulfilledBy: String, val hierarchyInformation: HierarchyInformationResponse, val imageInformation: List<ImageInformationResponse>, val productLines: List<ProductLineResponse>, val resourceProviderDetails: List<ResourceProviderDetailsResponse>? = null)

Product Family.

Link copied to clipboard
data class ProductLineResponse(val availabilityInformation: AvailabilityInformationResponse, val costInformation: CostInformationResponse, val description: DescriptionResponse, val displayName: String, val filterableProperties: List<FilterablePropertyResponse>, val fulfilledBy: String, val hierarchyInformation: HierarchyInformationResponse, val imageInformation: List<ImageInformationResponse>, val products: List<ProductResponse>)

Product line.

Link copied to clipboard
data class ProductResponse(val availabilityInformation: AvailabilityInformationResponse, val configurations: List<ConfigurationResponse>, val costInformation: CostInformationResponse, val description: DescriptionResponse, val displayName: String, val filterableProperties: List<FilterablePropertyResponse>, val fulfilledBy: String, val hierarchyInformation: HierarchyInformationResponse, val imageInformation: List<ImageInformationResponse>)

Represents a product.

Link copied to clipboard
data class PurchaseMeterDetailsResponse(val billingType: String, val chargingType: String, val multiplier: Double, val productId: String, val skuId: String, val termId: String)

Billing type Purchase meter details.

Link copied to clipboard
data class ResourceProviderDetailsResponse(val resourceProviderNamespace: String)

Management RP details.

Link copied to clipboard
data class ReverseShippingDetailsResponse(val carrierDisplayName: String, val carrierName: String, val sasKeyForLabel: String, val trackingId: String, val trackingUrl: String)

Reverse shipment details.

Link copied to clipboard
data class ShippingAddressResponse(val addressType: String? = null, val city: String? = null, val companyName: String? = null, val country: String, val postalCode: String? = null, val stateOrProvince: String? = null, val streetAddress1: String, val streetAddress2: String? = null, val streetAddress3: String? = null, val zipExtendedCode: String? = null)

Shipping address where customer wishes to receive the device.

Link copied to clipboard
data class SpecificationResponse(val name: String, val value: String)

Specification of the configurations.

Link copied to clipboard
data class StageDetailsResponse(val displayName: String, val stageName: String, val stageStatus: String, val startTime: String)

Resource stage details.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TransportPreferencesResponse(val preferredShipmentType: String)

Preferences related to the shipment logistics of the sku