From 57b24b2bcaab90957eb98d2f64119c0bf07cfda0 Mon Sep 17 00:00:00 2001 From: Christopher Gallo Date: Fri, 16 Feb 2024 13:15:48 -0600 Subject: [PATCH] 20240216 release notes and updates --- ...tLayer_Account_Regional_Registry_Detail.md | 4 +- ...count_Regional_Registry_Detail_Property.md | 4 +- ..._Regional_Registry_Detail_Property_Type.md | 4 +- ...r_Account_Regional_Registry_Detail_Type.md | 4 +- ...Registry_Detail_Version4_Person_Default.md | 4 +- .../SoftLayer_Account_Rwhois_Handle.md | 4 +- .../SoftLayer_Billing_Item_Gateway_License.md | 14 + ...ntainer_Dns_Domain_Registration_Contact.md | 14 - ...s_Domain_Registration_ExtendedAttribute.md | 14 - ...tration_ExtendedAttribute_Configuration.md | 14 - ...n_Registration_ExtendedAttribute_Option.md | 14 - ...ration_ExtendedAttribute_Option_Require.md | 14 - ...ner_Dns_Domain_Registration_Information.md | 14 - ..._Container_Dns_Domain_Registration_List.md | 14 - ...ontainer_Dns_Domain_Registration_Lookup.md | 14 - ...er_Dns_Domain_Registration_Lookup_Items.md | 14 - ...iner_Dns_Domain_Registration_Nameserver.md | 14 - ...Dns_Domain_Registration_Nameserver_List.md | 14 - ...on_Registrant_Verification_StatusDetail.md | 14 - ...omain_Registration_Transfer_Information.md | 14 - ...r_Product_Order_Dns_Domain_Registration.md | 14 - ...ainer_Product_Order_Dns_Domain_Reseller.md | 14 - .../SoftLayer_Dns_Domain_Registration.md | 14 - ...stration_Registrant_Verification_Status.md | 24 - ...oftLayer_Dns_Domain_Registration_Status.md | 23 - ...SoftLayer_Network_CdnMarketplace_Vendor.md | 2 +- .../SoftLayer_Network_Subnet_Registration.md | 4 +- ...Layer_Network_Subnet_Registration_Apnic.md | 4 +- ...tLayer_Network_Subnet_Registration_Arin.md | 4 +- ...yer_Network_Subnet_Registration_Details.md | 4 +- ...Layer_Network_Subnet_Registration_Event.md | 4 +- ..._Network_Subnet_Registration_Event_Type.md | 4 +- ...tLayer_Network_Subnet_Registration_Ripe.md | 4 +- ...ayer_Network_Subnet_Registration_Status.md | 4 +- .../getDomainRegistrations.md | 20 - .../_index.md | 4 +- .../createObject.md | 4 +- .../deleteObject.md | 4 +- .../editObject.md | 4 +- .../getAccount.md | 2 +- .../getDetailType.md | 2 +- .../getDetails.md | 2 +- .../getProperties.md | 2 +- .../getRegionalInternetRegistryHandle.md | 2 +- .../updateReferencedRegistrations.md | 4 +- .../validatePersonForAllRegistrars.md | 4 +- .../_index.md | 4 +- .../createObject.md | 4 +- .../createObjects.md | 4 +- .../deleteObject.md | 4 +- .../editObject.md | 4 +- .../editObjects.md | 4 +- .../getDetail.md | 2 +- .../getPropertyType.md | 2 +- .../_index.md | 14 - .../addNameserversToDomain.md | 20 - .../deleteRegisteredNameserver.md | 20 - .../getAccount.md | 20 - .../getAuthenticationCode.md | 20 - .../getDomainInformation.md | 20 - .../getDomainNameservers.md | 20 - .../getDomainRegistrationStatus.md | 20 - .../getExtendedAttributes.md | 20 - .../getObject.md | 20 - .../getRegisteredNameserver.md | 20 - .../getRegistrantVerificationStatus.md | 20 - .../getRegistrantVerificationStatusDetail.md | 20 - .../getServiceProvider.md | 20 - .../getTransferInformation.md | 20 - .../lockDomain.md | 22 - .../lookupDomain.md | 20 - .../modifyContact.md | 20 - .../modifyRegisteredNameserver.md | 20 - .../registerNameserver.md | 20 - .../removeNameserversFromDomain.md | 20 - .../sendAuthenticationCode.md | 20 - .../sendRegistrantVerificationEmail.md | 20 - .../sendTransferApprovalEmail.md | 20 - .../setAuthenticationCode.md | 20 - .../unlockDomain.md | 20 - .../_index.md | 14 - .../getAllObjects.md | 20 - .../getObject.md | 20 - .../_index.md | 14 - .../getAllObjects.md | 20 - .../getObject.md | 20 - .../_index.md | 2 +- .../_index.md | 4 +- .../clearRegistration.md | 4 +- .../createObject.md | 4 +- .../createObjects.md | 4 +- .../editObject.md | 4 +- .../editRegistrationAttachedDetails.md | 4 +- .../getAccount.md | 2 +- .../getDetailReferences.md | 2 +- .../getEvents.md | 2 +- .../getNetworkDetail.md | 2 +- .../getPersonDetail.md | 2 +- .../getRegionalInternetRegistry.md | 2 +- .../getRegionalInternetRegistryHandle.md | 2 +- .../getStatus.md | 2 +- .../getSubnet.md | 2 +- .../createObject.md | 4 +- .../deleteObject.md | 4 +- .../getDetail.md | 2 +- .../getRegistration.md | 2 +- .../SoftLayer_Product_Order/placeOrder.md | 1 - data/sldn_metadata.json | 8103 ++++++++--------- 108 files changed, 3741 insertions(+), 5468 deletions(-) create mode 100644 content/reference/datatypes/SoftLayer_Billing_Item_Gateway_License.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller.md delete mode 100644 content/reference/datatypes/SoftLayer_Dns_Domain_Registration.md delete mode 100644 content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status.md delete mode 100644 content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status.md delete mode 100644 content/reference/services/SoftLayer_Account/getDomainRegistrations.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/_index.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getAccount.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getObject.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration_Status/_index.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects.md delete mode 100644 content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject.md diff --git a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail.md b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail.md index e172da46a9..eda1c4fb42 100644 --- a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail.md +++ b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail.md @@ -1,8 +1,6 @@ --- title: "SoftLayer_Account_Regional_Registry_Detail" -description: " - - +description: "The subnet registration detail type has been deprecated. " date: "2018-02-12" diff --git a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property.md b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property.md index ebe1c9d080..297618ad12 100644 --- a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property.md +++ b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Account_Regional_Registry_Detail_Property" -description: "Subnet registration properties are used to define various attributes of the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). These properties are defined by the [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) objects, which describe the available value formats. " +description: "The subnet registration detail property type has been deprecated. + +Subnet registration properties are used to define various attributes of the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). These properties are defined by the [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) objects, which describe the available value formats. " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type.md b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type.md index 895f704b70..b3ce536597 100644 --- a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type.md +++ b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Account_Regional_Registry_Detail_Property_Type" -description: "Subnet Registration Detail Property Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) object. These types use [http://php.net/pcre.pattern.php Perl-Compatible Regular Expressions] to validate the value of a property object. " +description: "The subnet registration detail property type type has been deprecated. + +Subnet Registration Detail Property Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) object. These types use [http://php.net/pcre.pattern.php Perl-Compatible Regular Expressions] to validate the value of a property object. " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type.md b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type.md index e866f08795..00143930ca 100644 --- a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type.md +++ b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Account_Regional_Registry_Detail_Type" -description: "Subnet Registration Detail Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object. +description: "The subnet registration detail type type has been deprecated. + +Subnet Registration Detail Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object. The standard values for these objects are as follows: " date: "2018-02-12" diff --git a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default.md b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default.md index d402e93e53..4ef8eaaf7d 100644 --- a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default.md +++ b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default" -description: "The SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default data type contains general information relating to a single SoftLayer RIR account. RIR account information in this type such as names, addresses, and phone numbers are assigned to the registry only and not to users belonging to the account. " +description: "The subnet registration default person detail type has been deprecated. + +The SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default data type contains general information relating to a single SoftLayer RIR account. RIR account information in this type such as names, addresses, and phone numbers are assigned to the registry only and not to users belonging to the account. " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Account_Rwhois_Handle.md b/content/reference/datatypes/SoftLayer_Account_Rwhois_Handle.md index 3b41fb5fbe..18e67df4f9 100644 --- a/content/reference/datatypes/SoftLayer_Account_Rwhois_Handle.md +++ b/content/reference/datatypes/SoftLayer_Account_Rwhois_Handle.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Account_Rwhois_Handle" -description: "Provides a means of tracking handle identifiers at the various regional internet registries (RIRs). These objects are used by the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) objects to identify a customer or organization when a subnet is registered. " +description: "The subnet registration handle type has been deprecated. + +Provides a means of tracking handle identifiers at the various regional internet registries (RIRs). These objects are used by the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) objects to identify a customer or organization when a subnet is registered. " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Gateway_License.md b/content/reference/datatypes/SoftLayer_Billing_Item_Gateway_License.md new file mode 100644 index 0000000000..7054eedb62 --- /dev/null +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Gateway_License.md @@ -0,0 +1,14 @@ +--- +title: "SoftLayer_Billing_Item_Gateway_License" +description: "The SoftLayer_Billing_Item_Gateway_License data type contains general information relating to a single SoftLayer billing item for a bare_metal_gateway_license " +date: "2018-02-12" +tags: + - "datatype" + - "sldn" + - "Billing" +classes: + - "SoftLayer_Billing_Item_Gateway_License" +type: "reference" +layout: "datatype" +mainService : "SoftLayer_Billing_Item_Gateway_License" +--- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact.md deleted file mode 100644 index 4e5187ac82..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_Contact" -description: "Contact information container for domain registration " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_Contact" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_Contact" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute.md deleted file mode 100644 index a8bba3e5f8..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute" -description: "This container data type contains extended attributes information for a domain of country code TLD. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration.md deleted file mode 100644 index 0f99db61b7..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration" -description: "This is the data type that may need to be populated to complete registraton for domains that are country code TLD's. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option.md deleted file mode 100644 index 84267b4b14..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option" -description: "This container data type contains extended attribute options information for a domain of country code TLD. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require.md deleted file mode 100644 index ccc9182458..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require" -description: "This container data type contains the extended attribute name that is required by an extended attribute option. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information.md deleted file mode 100644 index dc2cf5f390..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_Information" -description: "Information container for domain registration " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_Information" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_Information" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List.md deleted file mode 100644 index e404e875d6..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_List" -description: "" -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_List" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_List" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup.md deleted file mode 100644 index 753be2642d..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_Lookup" -description: "Lookup domain container for domain registration " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_Lookup" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_Lookup" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items.md deleted file mode 100644 index 9844d34553..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_Lookup_Items" -description: "Lookup items container for domain registration " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_Lookup_Items" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_Lookup_Items" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver.md deleted file mode 100644 index dfa05ea215..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_Nameserver" -description: "Nameserver container for domain registration " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_Nameserver" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_Nameserver" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List.md deleted file mode 100644 index ec13c8ede7..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_Nameserver_List" -description: "Nameservers list container for domain registration " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_Nameserver_List" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_Nameserver_List" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail.md deleted file mode 100644 index 30fae685f9..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail" -description: "" -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information.md deleted file mode 100644 index 62203bfce6..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Dns_Domain_Registration_Transfer_Information" -description: "Transfer Information container for domain registration " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Dns_Domain_Registration_Transfer_Information" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Dns_Domain_Registration_Transfer_Information" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration.md deleted file mode 100644 index 9af2fe6d4e..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Product_Order_Dns_Domain_Registration" -description: "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Dns_Domain_Registration datatype contains everything required to place a domain registration order with SoftLayer. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Product_Order_Dns_Domain_Registration" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Product_Order_Dns_Domain_Registration" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller.md deleted file mode 100644 index ac31c951cd..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Container_Product_Order_Dns_Domain_Reseller" -description: "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Dns_Domain_Reseller datatype contains everything required to place a domain reseller credit order with SoftLayer. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Product_Order_Dns_Domain_Reseller" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Product_Order_Dns_Domain_Reseller" ---- diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration.md b/content/reference/datatypes/SoftLayer_Dns_Domain_Registration.md deleted file mode 100644 index f1bb47b0e5..0000000000 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Dns_Domain_Registration" -description: "The SoftLayer_Dns_Domain_Registration data type represents a domain registration record. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Dns_Domain_Registration" ---- diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status.md b/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status.md deleted file mode 100644 index abfa54df00..0000000000 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status" -description: "[DEPRECATED] SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status models the state of the registrant. Here are the following status codes: - - -*'''Admin Reviewing''': The registrant data has been submitted and being reviewed by compliance team. -*'''Pending''': The verification process has been inititated, and verification email will be sent. -*'''Suspended''': The registrant has failed verification and the domain has been suspended. -*'''Verified''': The registrant has been validated. -*'''Verifying''': The verification process has been initiated and is waiting for registrant response. -*'''Unverified''': The verification process has not been inititated. - -" -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status" ---- diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status.md b/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status.md deleted file mode 100644 index f09f3db1d7..0000000000 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "SoftLayer_Dns_Domain_Registration_Status" -description: "[DEPRECATED] SoftLayer_Dns_Domain_Registration_Status models the state of domain name. Here are the following status codes: - - -*'''Active''': This domain name is active. -*'''Pending Owner Approval''': Pending owner approval for completion of transfer. -*'''Pending Admin Review''': Pending admin review for transfer. -*'''Pending Registry''': Pending registry for transfer. -*'''Expired''': Domain name has expired. - -" -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration_Status" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Dns_Domain_Registration_Status" ---- diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor.md index 02a78fad1d..b84908ffd0 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor.md @@ -1,6 +1,6 @@ --- title: "SoftLayer_Network_CdnMarketplace_Vendor" -description: "The SoftLayer_Network_CdnMarketplace_Vendor contains information regarding
 a CDN Vendor. This class is associated with
 SoftLayer_Network_CdnMarketplace_Vendor_Attribute class.
 " +description: "The SoftLayer_Network_CdnMarketplace_Vendor contains information regarding a CDN Vendor. This class is associated with SoftLayer_Network_CdnMarketplace_Vendor_Attribute class. " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration.md index 26c9626b5b..a8e5c85631 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Network_Subnet_Registration" -description: "The subnet registration data type contains general information relating to a single subnet registration instance. These registration instances can be updated to reflect changes, and will record the changes in the [SoftLayer_Network_Subnet_Registration_Event](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event). " +description: "The subnet registration service has been deprecated. + +The subnet registration data type contains general information relating to a single subnet registration instance. These registration instances can be updated to reflect changes, and will record the changes in the [SoftLayer_Network_Subnet_Registration_Event](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event). " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic.md index fb117e9fcd..ec8ad8a466 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Network_Subnet_Registration_Apnic" -description: "APNIC-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). " +description: "The APNIC subnet registration type has been deprecated. + +APNIC-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin.md index dda923a6ca..dffd8981d8 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Network_Subnet_Registration_Arin" -description: "ARIN-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). " +description: "The ARIN subnet registration type has been deprecated. + +ARIN-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details.md index d1299f3bed..907cb375be 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Network_Subnet_Registration_Details" -description: "The SoftLayer_Network_Subnet_Registration_Details objects are used to relate [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object. This allows for easy reuse of registration details. It is important to note that only one detail object per type may be associated to a registration object. " +description: "The subnet registration details type has been deprecated. + +The SoftLayer_Network_Subnet_Registration_Details objects are used to relate [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object. This allows for easy reuse of registration details. It is important to note that only one detail object per type may be associated to a registration object. " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event.md index f92a1f84b7..77af396031 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Network_Subnet_Registration_Event" -description: "Each time a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object is created or modified, the system will generate an event for it. Additional actions that would create an event include RIR responses and error cases. * " +description: "The subnet registration event type has been deprecated. + +Each time a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object is created or modified, the system will generate an event for it. Additional actions that would create an event include RIR responses and error cases. * " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type.md index aa61e15efb..7679d2fd68 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Network_Subnet_Registration_Event_Type" -description: "Subnet Registration Event Type objects describe the nature of a [SoftLayer_Network_Subnet_Registration_Event](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event) +description: "The subnet registration event type type has been deprecated. + +Subnet Registration Event Type objects describe the nature of a [SoftLayer_Network_Subnet_Registration_Event](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event) The standard values for these objects are as follows: " date: "2018-02-12" diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe.md index 0b99cdbab6..61a2bd15a0 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Network_Subnet_Registration_Ripe" -description: "RIPE-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). " +description: "The RIPE subnet registration type has been deprecated. + +RIPE-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status.md index 2f3593ad69..d8bc38f8b6 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Network_Subnet_Registration_Status" -description: "Subnet Registration Status objects describe the current status of a subnet registration. +description: "The subnet registration status type has been deprecated. + +Subnet Registration Status objects describe the current status of a subnet registration. The standard values for these objects are as follows: " date: "2018-02-12" diff --git a/content/reference/services/SoftLayer_Account/getDomainRegistrations.md b/content/reference/services/SoftLayer_Account/getDomainRegistrations.md deleted file mode 100644 index 4de254cf4c..0000000000 --- a/content/reference/services/SoftLayer_Account/getDomainRegistrations.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getDomainRegistrations" -description: "" -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Account" -classes: - - "SoftLayer_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Account" ---- - -### [REST Example](#getDomainRegistrations-example) {#getDomainRegistrations-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getDomainRegistrations' -``` diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/_index.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/_index.md index 540c42ab75..11128ebdf0 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/_index.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/_index.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Account_Regional_Registry_Detail" -description: "Regional Registry Detail objects are used to specify the information you wish to use when registering subnets with the appropriate Regional Internet Registries. " +description: "The subnet registration detail service has been deprecated. + +Regional Registry Detail objects are used to specify the information you wish to use when registering subnets with the appropriate Regional Internet Registries. " date: "2018-02-12" tags: - "service" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject.md index ca5d6a5e13..ef117dd766 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject.md @@ -1,6 +1,8 @@ --- title: "createObject" -description: " This method will create a new SoftLayer_Account_Regional_Registry_Detail object. +description: "The subnet registration detail service has been deprecated. + + This method will create a new SoftLayer_Account_Regional_Registry_Detail object. Input - [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) " date: "2018-02-12" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject.md index c73169d49d..da032d53e6 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject.md @@ -1,6 +1,8 @@ --- title: "deleteObject" -description: "This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. " +description: "The subnet registration detail service has been deprecated. + +This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject.md index 73db592945..7a3ffe7e3f 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject.md @@ -1,6 +1,8 @@ --- title: "editObject" -description: "This method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail::createObject](/reference/datatypes/$1/#$2). " +description: "The subnet registration detail service has been deprecated. + +This method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail::createObject](/reference/datatypes/$1/#$2). " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount.md index bc2d51e686..f3ab7026c5 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount.md @@ -1,6 +1,6 @@ --- title: "getAccount" -description: "The account that this detail object belongs to." +description: "[Deprecated] The account that this detail object belongs to." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType.md index 7157f1c3f3..535d3b6957 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType.md @@ -1,6 +1,6 @@ --- title: "getDetailType" -description: "The associated type of this detail object." +description: "[Deprecated] The associated type of this detail object." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails.md index 50692ce7db..4a531a8c49 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails.md @@ -1,6 +1,6 @@ --- title: "getDetails" -description: "References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object." +description: "[Deprecated] References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties.md index 81e7b40597..9e170b3ba0 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties.md @@ -1,6 +1,6 @@ --- title: "getProperties" -description: "The individual properties that define this detail object's values." +description: "[Deprecated] The individual properties that define this detail object's values." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle.md index 88ee94dfc8..1cf5e0cdd5 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle.md @@ -1,6 +1,6 @@ --- title: "getRegionalInternetRegistryHandle" -description: "The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary." +description: "[Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations.md index 524816801c..544c29de50 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations.md @@ -1,6 +1,8 @@ --- title: "updateReferencedRegistrations" -description: "This method will create a bulk transaction to update any registrations that reference this detail object. It should only be called from a child class such as [SoftLayer_Account_Regional_Registry_Detail_Person](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Person) or [SoftLayer_Account_Regional_Registry_Detail_Network](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Network). The registrations should be in the Open or Registration_Complete status. " +description: "The subnet registration detail service has been deprecated. + +This method will create a bulk transaction to update any registrations that reference this detail object. It should only be called from a child class such as [SoftLayer_Account_Regional_Registry_Detail_Person](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Person) or [SoftLayer_Account_Regional_Registry_Detail_Network](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Network). The registrations should be in the Open or Registration_Complete status. " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars.md index 93343e91a9..4fa44484ac 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars.md @@ -1,6 +1,8 @@ --- title: "validatePersonForAllRegistrars" -description: "Validates this person detail against all supported external registrars (APNIC/ARIN/RIPE). The validation uses the most restrictive rules ensuring that any person detail passing this validation would be acceptable to any supported registrar. +description: "The subnet registration detail service has been deprecated. + +Validates this person detail against all supported external registrars (APNIC/ARIN/RIPE). The validation uses the most restrictive rules ensuring that any person detail passing this validation would be acceptable to any supported registrar. The person detail properties are validated against - Non-emptiness - Minimum length - Maximum length - Maximum words - Supported characters - Format of data diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md index 36bbd22ea8..9a5d4b62e3 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Account_Regional_Registry_Detail_Property" -description: "The subnet registration property is used to define various attributes of [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). For more information, please see the [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property). " +description: "The subnet registration detail property service has been deprecated. + +The subnet registration property is used to define various attributes of [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). For more information, please see the [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property). " date: "2018-02-12" tags: - "service" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject.md index eb991c92b6..18a599e631 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject.md @@ -1,6 +1,8 @@ --- title: "createObject" -description: " This method will create a new SoftLayer_Account_Regional_Registry_Detail_Property object. +description: "The subnet registration detail property service has been deprecated. + + This method will create a new SoftLayer_Account_Regional_Registry_Detail_Property object. Input - [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) " date: "2018-02-12" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects.md index 80f477603b..437462d9a2 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects.md @@ -1,6 +1,8 @@ --- title: "createObjects" -description: "Edit multiple [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) objects. " +description: "The subnet registration detail property service has been deprecated. + +Edit multiple [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) objects. " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject.md index 3664ca3eac..1e8092eeb4 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject.md @@ -1,6 +1,8 @@ --- title: "deleteObject" -description: "This method will delete an existing SoftLayer_Account_Regional_Registry_Detail_Property object. " +description: "The subnet registration detail property service has been deprecated. + +This method will delete an existing SoftLayer_Account_Regional_Registry_Detail_Property object. " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject.md index 88b3d02441..310ea375bb 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject.md @@ -1,6 +1,8 @@ --- title: "editObject" -description: "This method will edit an existing SoftLayer_Account_Regional_Registry_Detail_Property object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail_Property::createObject](/reference/datatypes/$1/#$2). " +description: "The subnet registration detail property service has been deprecated. + +This method will edit an existing SoftLayer_Account_Regional_Registry_Detail_Property object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail_Property::createObject](/reference/datatypes/$1/#$2). " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects.md index 209b9f7b2d..2206093a80 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects.md @@ -1,6 +1,8 @@ --- title: "editObjects" -description: "Edit multiple [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) objects. " +description: "The subnet registration detail property service has been deprecated. + +Edit multiple [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) objects. " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail.md index 47be0d25ef..aa1a10df16 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail.md @@ -1,6 +1,6 @@ --- title: "getDetail" -description: "The [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object this property belongs to" +description: "[Deprecated] The [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object this property belongs to" date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType.md index 06d2784d69..40056c5626 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType.md @@ -1,6 +1,6 @@ --- title: "getPropertyType" -description: "The [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) object this property belongs to" +description: "[Deprecated] The [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) object this property belongs to" date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/_index.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/_index.md deleted file mode 100644 index 7ac698b3e5..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/_index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Dns_Domain_Registration" -description: "[DEPRECATED] Registration and management of domain names and domain related services. " -date: "2018-02-12" -tags: - - "service" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "service" -mainService : "SoftLayer_Dns_Domain_Registration" ---- diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain.md deleted file mode 100644 index d2e92cae30..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "addNameserversToDomain" -description: "The addNameserversToDomain method adds nameservers to a domain for a domain that already has nameservers assigned to it. This method does not create a nameserver; the nameserver must already exist. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#addNameserversToDomain-example) {#addNameserversToDomain-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/addNameserversToDomain' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver.md deleted file mode 100644 index cd7246e73c..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "deleteRegisteredNameserver" -description: "The deleteRegisteredNameserver method deletes a nameserver that was registered, provided it is not currently serving a domain " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#deleteRegisteredNameserver-example) {#deleteRegisteredNameserver-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/deleteRegisteredNameserver' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getAccount.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getAccount.md deleted file mode 100644 index 9e246d7e0c..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getAccount.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getAccount" -description: "The SoftLayer customer account that the domain is registered to." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getAccount-example) {#getAccount-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getAccount' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode.md deleted file mode 100644 index 88ec818173..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getAuthenticationCode" -description: "The getAuthenticationCode method retrieves the authentication code for the domain. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getAuthenticationCode-example) {#getAuthenticationCode-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getAuthenticationCode' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation.md deleted file mode 100644 index abfffd5231..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getDomainInformation" -description: "The getDomainInformation method retrieves all the information for a domain. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getDomainInformation-example) {#getDomainInformation-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getDomainInformation' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers.md deleted file mode 100644 index f971fba0be..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getDomainNameservers" -description: "The getDomainNameservers method retrieve nameservers information for domain. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getDomainNameservers-example) {#getDomainNameservers-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getDomainNameservers' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus.md deleted file mode 100644 index 75342aaf9c..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getDomainRegistrationStatus" -description: "The domain registration status." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getDomainRegistrationStatus-example) {#getDomainRegistrationStatus-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getDomainRegistrationStatus' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes.md deleted file mode 100644 index 0c9041f5aa..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getExtendedAttributes" -description: "The getExtendedAttributes method determines if a country code top level domain requires extended attributes. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getExtendedAttributes-example) {#getExtendedAttributes-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/getExtendedAttributes' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getObject.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getObject.md deleted file mode 100644 index 2480425735..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getObject.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getObject" -description: "getObject retrieves the SoftLayer_Dns_Domain_Registration object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_Registration service. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getObject-example) {#getObject-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getObject' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver.md deleted file mode 100644 index 9dfc531664..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getRegisteredNameserver" -description: "The getRegisteredNameserver method retrieves registered nameservers. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getRegisteredNameserver-example) {#getRegisteredNameserver-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getRegisteredNameserver' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus.md deleted file mode 100644 index b9970950a8..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getRegistrantVerificationStatus" -description: "The registrant verification status." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getRegistrantVerificationStatus-example) {#getRegistrantVerificationStatus-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getRegistrantVerificationStatus' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail.md deleted file mode 100644 index c6d6d0d529..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getRegistrantVerificationStatusDetail" -description: "When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct. This method returns the current state of the verification request. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getRegistrantVerificationStatusDetail-example) {#getRegistrantVerificationStatusDetail-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getRegistrantVerificationStatusDetail' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider.md deleted file mode 100644 index 42e6dbe9e5..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getServiceProvider" -description: "" -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getServiceProvider-example) {#getServiceProvider-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getServiceProvider' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation.md deleted file mode 100644 index 86f8ebc154..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getTransferInformation" -description: "The getTransferInformation method checks to see if the domain can be transferred and also can be used to check the status of the last transfer request. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#getTransferInformation-example) {#getTransferInformation-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/getTransferInformation' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain.md deleted file mode 100644 index 29b4397fe1..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "lockDomain" -description: "The lockDomain method locks a domain to prevent unauthorized, unwanted or accidental changes to the domain name. When set, the following actions are prohibited: -* Transferring of the domain name -* Deletion of the domain name" -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#lockDomain-example) {#lockDomain-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/lockDomain' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain.md deleted file mode 100644 index d90758db6f..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "lookupDomain" -description: "The lookupDomain method checks whether a specified domain name is available for registration in TLD's, and suggests other similar domain names, and checks whether they are available as well. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#lookupDomain-example) {#lookupDomain-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/lookupDomain' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact.md deleted file mode 100644 index b67bda1dac..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "modifyContact" -description: "The modifyContact method modifies contact information (admin, billing, owner, technical) for a domain. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#modifyContact-example) {#modifyContact-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Dns_Domain_Registration_Contact]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/modifyContact' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver.md deleted file mode 100644 index 2cfb46e998..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "modifyRegisteredNameserver" -description: "The modifyRegisteredNameserver method modifies a nameserver that was registered. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#modifyRegisteredNameserver-example) {#modifyRegisteredNameserver-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string, string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/modifyRegisteredNameserver' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver.md deleted file mode 100644 index 3c091e649a..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "registerNameserver" -description: "The registerNameserver method creates a nameserver for the domain. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#registerNameserver-example) {#registerNameserver-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/registerNameserver' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain.md deleted file mode 100644 index 3f957e603d..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "removeNameserversFromDomain" -description: "The removeNameserversFromDomain method removes nameservers from a domain for a domain that already has nameservers assigned to it. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#removeNameserversFromDomain-example) {#removeNameserversFromDomain-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/removeNameserversFromDomain' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode.md deleted file mode 100644 index fe23d76534..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "sendAuthenticationCode" -description: "The sendAuthenticationCode method sends the authentication code to the administrative contact for the domain. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#sendAuthenticationCode-example) {#sendAuthenticationCode-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/sendAuthenticationCode' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail.md deleted file mode 100644 index 6bb4e0e2af..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "sendRegistrantVerificationEmail" -description: "When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct. This method sends the verification email to the registrant. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#sendRegistrantVerificationEmail-example) {#sendRegistrantVerificationEmail-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/sendRegistrantVerificationEmail' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail.md deleted file mode 100644 index ebfaff033e..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "sendTransferApprovalEmail" -description: "The sendTransferApprovalEmail method resends a transfer approval email message for a transfer that is in 'pending owner approval' state, to the admin contact listed for the domain at the time that the transfer request was submitted " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#sendTransferApprovalEmail-example) {#sendTransferApprovalEmail-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/sendTransferApprovalEmail' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode.md deleted file mode 100644 index aa64bc6f4a..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "setAuthenticationCode" -description: "The setAuthenticationCode method sets the authentication code for the domain. The authentication code is a transfer key and provides an extra level of security, safeguarding domain names from unauthorized transfers. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#setAuthenticationCode-example) {#setAuthenticationCode-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/setAuthenticationCode' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain.md deleted file mode 100644 index b9c4d8fe1e..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "unlockDomain" -description: "The unlockDomain method unlocks a domain " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration" ---- - -### [REST Example](#unlockDomain-example) {#unlockDomain-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/unlockDomain' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md deleted file mode 100644 index 2e9ec5bb1a..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status" -description: "" -date: "2018-02-12" -tags: - - "service" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status" -type: "reference" -layout: "service" -mainService : "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status" ---- diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects.md deleted file mode 100644 index d71e89b35d..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getAllObjects" -description: "" -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status" ---- - -### [REST Example](#getAllObjects-example) {#getAllObjects-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject.md deleted file mode 100644 index b753aec312..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getObject" -description: "Retrieve a SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status record." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status" ---- - -### [REST Example](#getObject-example) {#getObject-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/{SoftLayer_Dns_Domain_Registration_Registrant_Verification_StatusID}/getObject' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/_index.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/_index.md deleted file mode 100644 index 1414c69160..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/_index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Dns_Domain_Registration_Status" -description: "" -date: "2018-02-12" -tags: - - "service" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration_Status" -type: "reference" -layout: "service" -mainService : "SoftLayer_Dns_Domain_Registration_Status" ---- diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects.md deleted file mode 100644 index 67a2e50239..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getAllObjects" -description: "" -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration_Status" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration_Status" ---- - -### [REST Example](#getAllObjects-example) {#getAllObjects-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration_Status/getAllObjects' -``` diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject.md deleted file mode 100644 index b16558c94e..0000000000 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getObject" -description: "Retrieve a SoftLayer_Dns_Domain_Registration_Status record." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Dns" -classes: - - "SoftLayer_Dns_Domain_Registration_Status" -type: "reference" -layout: "method" -mainService : "SoftLayer_Dns_Domain_Registration_Status" ---- - -### [REST Example](#getObject-example) {#getObject-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration_Status/{SoftLayer_Dns_Domain_Registration_StatusID}/getObject' -``` diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/_index.md index 1fa9e76937..35081ed970 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/_index.md @@ -1,6 +1,6 @@ --- title: "SoftLayer_Network_CdnMarketplace_Vendor" -description: "This service allows internal users to create, read, update, and delete
 vendor instances. " +description: "This service allows internal users to create, read, update, and delete vendor instances. " date: "2018-02-12" tags: - "service" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/_index.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/_index.md index badd1298c2..9323c69822 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/_index.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/_index.md @@ -1,6 +1,8 @@ --- title: "SoftLayer_Network_Subnet_Registration" -description: "Subnet registration objects are used to request and track registration of the subnet with the appropriate Regional Internet Registry (RIR). Registration for public subnets can be requested any time after assignment of the subnet. +description: "The subnet registration service has been deprecated. + +Subnet registration objects are used to request and track registration of the subnet with the appropriate Regional Internet Registry (RIR). Registration for public subnets can be requested any time after assignment of the subnet. Subnet Registration objects can be updated any time after they are created. This will result in the information being submitted to the RIR and the records on their end being refreshed. " date: "2018-02-12" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration.md index 1de69cb0ba..d556d3ebdb 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration.md @@ -1,6 +1,8 @@ --- title: "clearRegistration" -description: "This method will initiate the removal of a subnet registration. " +description: "The subnet registration service has been deprecated. + +This method will initiate the removal of a subnet registration. " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/createObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/createObject.md index 5a787698cd..0c60c09425 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/createObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/createObject.md @@ -1,6 +1,8 @@ --- title: "createObject" -description: "Create registration with a global registrar to associate an assigned subnet with the provided contact details. +description: "The subnet registration service has been deprecated. + +Create registration with a global registrar to associate an assigned subnet with the provided contact details. Contact information is provided in the form of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/createObjects.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/createObjects.md index 08ff526f84..42e704c207 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/createObjects.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/createObjects.md @@ -1,6 +1,8 @@ --- title: "createObjects" -description: "Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details. " +description: "The subnet registration service has been deprecated. + +Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details. " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/editObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/editObject.md index 96568bf36c..d8299dfbf7 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/editObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/editObject.md @@ -1,6 +1,8 @@ --- title: "editObject" -description: "This method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2). " +description: "The subnet registration service has been deprecated. + +This method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2). " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails.md index 8570222068..ce9fd85bd4 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails.md @@ -1,6 +1,8 @@ --- title: "editRegistrationAttachedDetails" -description: "This method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration. " +description: "The subnet registration service has been deprecated. + +This method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration. " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getAccount.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getAccount.md index d0edfb797f..6c3a069ab1 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getAccount.md @@ -1,6 +1,6 @@ --- title: "getAccount" -description: "The account that this registration belongs to." +description: "[Deprecated] The account that this registration belongs to." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences.md index cdd125f770..626e6875f5 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences.md @@ -1,6 +1,6 @@ --- title: "getDetailReferences" -description: "The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." +description: "[Deprecated] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getEvents.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getEvents.md index b045d24c7c..242f9eb1b2 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getEvents.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getEvents.md @@ -1,6 +1,6 @@ --- title: "getEvents" -description: "The related registration events." +description: "[Deprecated] The related registration events." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail.md index 82ca3bf86c..6048e5c891 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail.md @@ -1,6 +1,6 @@ --- title: "getNetworkDetail" -description: "The 'network' detail object." +description: "[Deprecated] The 'network' detail object." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail.md index b6e50b8488..9b176fa2f3 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail.md @@ -1,6 +1,6 @@ --- title: "getPersonDetail" -description: "The 'person' detail object." +description: "[Deprecated] The 'person' detail object." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry.md index 9d02432f27..e285915372 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry.md @@ -1,6 +1,6 @@ --- title: "getRegionalInternetRegistry" -description: "The related Regional Internet Registry." +description: "[Deprecated] The related Regional Internet Registry." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle.md index feb13eb3ff..af7b660c1a 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle.md @@ -1,6 +1,6 @@ --- title: "getRegionalInternetRegistryHandle" -description: "The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete." +description: "[Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getStatus.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getStatus.md index 3ff18794f4..bc4b0dc34b 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getStatus.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getStatus.md @@ -1,6 +1,6 @@ --- title: "getStatus" -description: "The status of this registration." +description: "[Deprecated] The status of this registration." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet.md index abfbf53e88..9f5c710951 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet.md @@ -1,6 +1,6 @@ --- title: "getSubnet" -description: "The subnet that this registration pertains to." +description: "[Deprecated] The subnet that this registration pertains to." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject.md index bec4072f39..029c82985f 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject.md @@ -1,6 +1,8 @@ --- title: "createObject" -description: " This method will create a new SoftLayer_Network_Subnet_Registration_Details object. +description: "The subnet registration details service has been deprecated. + + This method will create a new SoftLayer_Network_Subnet_Registration_Details object. Input - [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) " date: "2018-02-12" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject.md index 4325a320e9..4a18031f76 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject.md @@ -1,6 +1,8 @@ --- title: "deleteObject" -description: "This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. " +description: "The subnet registration details service has been deprecated. + +This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail.md index 02c587250c..e03e435a98 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail.md @@ -1,6 +1,6 @@ --- title: "getDetail" -description: "The related [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail)." +description: "[Deprecated] The related [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail)." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration.md index 93a8b715e0..42156ea9a7 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration.md @@ -1,6 +1,6 @@ --- title: "getRegistration" -description: "The related [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration)." +description: "[Deprecated] The related [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration)." date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Product_Order/placeOrder.md b/content/reference/services/SoftLayer_Product_Order/placeOrder.md index 8bef0f694c..7865a971a8 100644 --- a/content/reference/services/SoftLayer_Product_Order/placeOrder.md +++ b/content/reference/services/SoftLayer_Product_Order/placeOrder.md @@ -36,7 +36,6 @@ from being provisioned in a timely manner. Some common order containers are incl | Bare metal server by CPU | [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) | BARE_METAL_CPU | | Bare metal server by core | [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) | BARE_METAL_CORE | | Virtual server | [SoftLayer_Container_Product_Order_Virtual_Guest](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest) | VIRTUAL_SERVER_INSTANCE | -| DNS domain registration | [SoftLayer_Container_Product_Order_Dns_Domain_Registrationn](/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registrationn) | ADDITIONAL_SERVICES | | Local & dedicated load balancers | [SoftLayer_Container_Product_Order_Network_LoadBalancer](/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer) | ADDITIONAL_SERVICES_LOAD_BALANCER | | Content delivery network | [SoftLayer_Container_Product_Order_Network_ContentDelivery_Account](/reference/datatypes/SoftLayer_Container_Product_Order_Network_ContentDelivery_Account) | ADDITIONAL_SERVICES_CDN | | Content delivery network Addon | [SoftLayer_Container_Product_Order_Network_ContentDelivery_Account_Addon](/reference/datatypes/SoftLayer_Container_Product_Order_Network_ContentDelivery_Account_Addon) | ADDITIONAL_SERVICES_CDN_ADDON | diff --git a/data/sldn_metadata.json b/data/sldn_metadata.json index 496d9f77a1..0b513f47b2 100644 --- a/data/sldn_metadata.json +++ b/data/sldn_metadata.json @@ -2716,18 +2716,6 @@ "deprecated": false, "limitable": true }, - "getDomainRegistrations": { - "doc": "", - "docOverview": "", - "name": "getDomainRegistrations", - "type": "SoftLayer_Dns_Domain_Registration", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": true, - "limitable": true - }, "getDomains": { "doc": "The DNS domains associated with an account.", "docOverview": "", @@ -4702,7 +4690,7 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, + "deprecated": true, "limitable": true }, "getSubnetRegistrations": { @@ -4714,7 +4702,7 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, + "deprecated": true, "limitable": true }, "getSubnets": { @@ -5471,13 +5459,6 @@ "typeArray": true, "doc": "The SoftLayer employees that an account is assigned to." }, - "domainRegistrations": { - "name": "domainRegistrations", - "type": "SoftLayer_Dns_Domain_Registration", - "form": "relational", - "typeArray": true, - "deprecated": true - }, "domains": { "name": "domains", "type": "SoftLayer_Dns_Domain", @@ -6593,13 +6574,15 @@ "name": "subnetRegistrationDetails", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "typeArray": true + "typeArray": true, + "deprecated": true }, "subnetRegistrations": { "name": "subnetRegistrations", "type": "SoftLayer_Network_Subnet_Registration", "form": "relational", - "typeArray": true + "typeArray": true, + "deprecated": true }, "subnets": { "name": "subnets", @@ -7201,12 +7184,6 @@ "form": "count", "doc": "A count of the DNS domains associated with an account." }, - "domainRegistrationCount": { - "name": "domainRegistrationCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, "domainsWithoutSecondaryDnsRecordCount": { "name": "domainsWithoutSecondaryDnsRecordCount", "type": "unsignedLong", @@ -12401,15 +12378,16 @@ "SoftLayer_Account_Regional_Registry_Detail": { "name": "SoftLayer_Account_Regional_Registry_Detail", "base": "SoftLayer_Entity", - "serviceDoc": "Regional Registry Detail objects are used to specify the information you wish to use when registering subnets with the appropriate Regional Internet Registries. ", + "serviceDoc": "The subnet registration detail service has been deprecated. \n\nRegional Registry Detail objects are used to specify the information you wish to use when registering subnets with the appropriate Regional Internet Registries. ", "methods": { "createObject": { "name": "createObject", "type": "SoftLayer_Account_Regional_Registry_Detail", - "doc": " This method will create a new SoftLayer_Account_Regional_Registry_Detail object. \n\nInput - [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) ", - "docOverview": "Create a new detail object", + "doc": "The subnet registration detail service has been deprecated. \n\n This method will create a new SoftLayer_Account_Regional_Registry_Detail object. \n\nInput - [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) ", + "docOverview": "[Deprecated] Create a new detail object", "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -12421,14 +12399,16 @@ "deleteObject": { "name": "deleteObject", "type": "boolean", - "doc": "This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. ", - "docOverview": "Delete an existing detail object" + "doc": "The subnet registration detail service has been deprecated. \n\nThis method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. ", + "docOverview": "[Deprecated] Delete an existing detail object", + "deprecated": true }, "editObject": { "name": "editObject", "type": "boolean", - "doc": "This method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail::createObject](/reference/datatypes/$1/#$2). ", - "docOverview": "Edit an existing detail object", + "doc": "The subnet registration detail service has been deprecated. \n\nThis method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail::createObject](/reference/datatypes/$1/#$2). ", + "docOverview": "[Deprecated] Edit an existing detail object", + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -12447,18 +12427,20 @@ "updateReferencedRegistrations": { "name": "updateReferencedRegistrations", "type": "SoftLayer_Container_Network_Subnet_Registration_TransactionDetails", - "doc": "This method will create a bulk transaction to update any registrations that reference this detail object. It should only be called from a child class such as [SoftLayer_Account_Regional_Registry_Detail_Person](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Person) or [SoftLayer_Account_Regional_Registry_Detail_Network](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Network). The registrations should be in the Open or Registration_Complete status. ", - "docOverview": "Create a transaction to update the registrations that reference this detail object." + "doc": "The subnet registration detail service has been deprecated. \n\nThis method will create a bulk transaction to update any registrations that reference this detail object. It should only be called from a child class such as [SoftLayer_Account_Regional_Registry_Detail_Person](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Person) or [SoftLayer_Account_Regional_Registry_Detail_Network](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Network). The registrations should be in the Open or Registration_Complete status. ", + "docOverview": "[Deprecated] Create a transaction to update the registrations that reference this detail object.", + "deprecated": true }, "validatePersonForAllRegistrars": { "name": "validatePersonForAllRegistrars", "type": "SoftLayer_Container_Message", "typeArray": true, - "doc": "Validates this person detail against all supported external registrars (APNIC/ARIN/RIPE). The validation uses the most restrictive rules ensuring that any person detail passing this validation would be acceptable to any supported registrar. \n\nThe person detail properties are validated against - Non-emptiness - Minimum length - Maximum length - Maximum words - Supported characters - Format of data \n\nIf the person detail validation succeeds, then an empty list is returned indicating no errors were found and that this person detail would work against all three registrars during a subnet registration. \n\nIf the person detail validation fails, then an array of validation errors (SoftLayer_Container_Message[]) is returned. Each message container contains error messages grouped by property type and a message type indicating the person detail property type object which failed validation. It is possible to create a subnet registration using a person detail which does not pass this validation, but at least one registrar would reject it for being invalid. ", - "docOverview": "Validate an existing person detail object." + "doc": "The subnet registration detail service has been deprecated. \n\nValidates this person detail against all supported external registrars (APNIC/ARIN/RIPE). The validation uses the most restrictive rules ensuring that any person detail passing this validation would be acceptable to any supported registrar. \n\nThe person detail properties are validated against - Non-emptiness - Minimum length - Maximum length - Maximum words - Supported characters - Format of data \n\nIf the person detail validation succeeds, then an empty list is returned indicating no errors were found and that this person detail would work against all three registrars during a subnet registration. \n\nIf the person detail validation fails, then an array of validation errors (SoftLayer_Container_Message[]) is returned. Each message container contains error messages grouped by property type and a message type indicating the person detail property type object which failed validation. It is possible to create a subnet registration using a person detail which does not pass this validation, but at least one registrar would reject it for being invalid. ", + "docOverview": "[Deprecated] Validate an existing person detail object.", + "deprecated": true }, "getAccount": { - "doc": "The account that this detail object belongs to.", + "doc": "[Deprecated] The account that this detail object belongs to.", "docOverview": "", "name": "getAccount", "type": "SoftLayer_Account", @@ -12466,10 +12448,10 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true }, "getDetailType": { - "doc": "The associated type of this detail object.", + "doc": "[Deprecated] The associated type of this detail object.", "docOverview": "", "name": "getDetailType", "type": "SoftLayer_Account_Regional_Registry_Detail_Type", @@ -12477,10 +12459,10 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true }, "getDetails": { - "doc": "References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object.", + "doc": "[Deprecated] References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object.", "docOverview": "", "name": "getDetails", "type": "SoftLayer_Network_Subnet_Registration_Details", @@ -12488,11 +12470,11 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, + "deprecated": true, "limitable": true }, "getProperties": { - "doc": "The individual properties that define this detail object's values.", + "doc": "[Deprecated] The individual properties that define this detail object's values.", "docOverview": "", "name": "getProperties", "type": "SoftLayer_Account_Regional_Registry_Detail_Property", @@ -12500,11 +12482,11 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, + "deprecated": true, "limitable": true }, "getRegionalInternetRegistryHandle": { - "doc": "The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.", + "doc": "[Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.", "docOverview": "", "name": "getRegionalInternetRegistryHandle", "type": "SoftLayer_Account_Rwhois_Handle", @@ -12512,42 +12494,47 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true } }, - "typeDoc": "\n\n\n\n", + "typeDoc": "The subnet registration detail type has been deprecated. \n\n", "properties": { "account": { "name": "account", "type": "SoftLayer_Account", "form": "relational", - "doc": "The account that this detail object belongs to." + "doc": "[Deprecated] The account that this detail object belongs to.", + "deprecated": true }, "detailType": { "name": "detailType", "type": "SoftLayer_Account_Regional_Registry_Detail_Type", "form": "relational", - "doc": "The associated type of this detail object." + "doc": "[Deprecated] The associated type of this detail object.", + "deprecated": true }, "details": { "name": "details", "type": "SoftLayer_Network_Subnet_Registration_Details", "form": "relational", "typeArray": true, - "doc": "References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object." + "doc": "[Deprecated] References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object.", + "deprecated": true }, "properties": { "name": "properties", "type": "SoftLayer_Account_Regional_Registry_Detail_Property", "form": "relational", "typeArray": true, - "doc": "The individual properties that define this detail object's values." + "doc": "[Deprecated] The individual properties that define this detail object's values.", + "deprecated": true }, "regionalInternetRegistryHandle": { "name": "regionalInternetRegistryHandle", "type": "SoftLayer_Account_Rwhois_Handle", "form": "relational", - "doc": "The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary." + "doc": "[Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.", + "deprecated": true }, "accountId": { "name": "accountId", @@ -12589,28 +12576,30 @@ "name": "detailCount", "type": "unsignedLong", "form": "count", - "doc": "A count of references to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object." + "doc": "A count of [Deprecated] References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object." }, "propertyCount": { "name": "propertyCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the individual properties that define this detail object's values." + "doc": "A count of [Deprecated] The individual properties that define this detail object's values." } - } + }, + "deprecated": true }, "SoftLayer_Account_Regional_Registry_Detail_Property": { "name": "SoftLayer_Account_Regional_Registry_Detail_Property", "base": "SoftLayer_Entity", - "serviceDoc": "The subnet registration property is used to define various attributes of [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). For more information, please see the [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property). ", + "serviceDoc": "The subnet registration detail property service has been deprecated. \n\nThe subnet registration property is used to define various attributes of [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). For more information, please see the [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property). ", "methods": { "createObject": { "name": "createObject", "type": "SoftLayer_Account_Regional_Registry_Detail_Property", - "doc": " This method will create a new SoftLayer_Account_Regional_Registry_Detail_Property object. \n\nInput - [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) ", - "docOverview": "Create a new property object", + "doc": "The subnet registration detail property service has been deprecated. \n\n This method will create a new SoftLayer_Account_Regional_Registry_Detail_Property object. \n\nInput - [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) ", + "docOverview": "[Deprecated] Create a new property object", "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -12623,8 +12612,8 @@ "name": "createObjects", "type": "SoftLayer_Account_Regional_Registry_Detail_Property", "typeArray": true, - "doc": "Edit multiple [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) objects. ", - "docOverview": "Create multiple property objects.", + "doc": "The subnet registration detail property service has been deprecated. \n\nEdit multiple [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) objects. ", + "docOverview": "[Deprecated] Create multiple property objects.", "docAssociatedMethods": [ { "service": "SoftLayer_Account_Regional_Registry_Detail_Property", @@ -12633,6 +12622,7 @@ ], "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObjects", @@ -12645,14 +12635,16 @@ "deleteObject": { "name": "deleteObject", "type": "boolean", - "doc": "This method will delete an existing SoftLayer_Account_Regional_Registry_Detail_Property object. ", - "docOverview": "Delete an existing property object" + "doc": "The subnet registration detail property service has been deprecated. \n\nThis method will delete an existing SoftLayer_Account_Regional_Registry_Detail_Property object. ", + "docOverview": "[Deprecated] Delete an existing property object", + "deprecated": true }, "editObject": { "name": "editObject", "type": "boolean", - "doc": "This method will edit an existing SoftLayer_Account_Regional_Registry_Detail_Property object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail_Property::createObject](/reference/datatypes/$1/#$2). ", - "docOverview": "Edit an existing property object", + "doc": "The subnet registration detail property service has been deprecated. \n\nThis method will edit an existing SoftLayer_Account_Regional_Registry_Detail_Property object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail_Property::createObject](/reference/datatypes/$1/#$2). ", + "docOverview": "[Deprecated] Edit an existing property object", + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -12664,8 +12656,8 @@ "editObjects": { "name": "editObjects", "type": "boolean", - "doc": "Edit multiple [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) objects. ", - "docOverview": "Edit multiple property objects.", + "doc": "The subnet registration detail property service has been deprecated. \n\nEdit multiple [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) objects. ", + "docOverview": "[Deprecated] Edit multiple property objects.", "docAssociatedMethods": [ { "service": "SoftLayer_Account_Regional_Registry_Detail_Property", @@ -12673,6 +12665,7 @@ } ], "static": true, + "deprecated": true, "parameters": [ { "name": "templateObjects", @@ -12690,7 +12683,7 @@ "maskable": true }, "getDetail": { - "doc": "The [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object this property belongs to", + "doc": "[Deprecated] The [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object this property belongs to", "docOverview": "", "name": "getDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", @@ -12698,10 +12691,10 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true }, "getPropertyType": { - "doc": "The [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) object this property belongs to", + "doc": "[Deprecated] The [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) object this property belongs to", "docOverview": "", "name": "getPropertyType", "type": "SoftLayer_Account_Regional_Registry_Detail_Property_Type", @@ -12709,22 +12702,24 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true } }, - "typeDoc": "Subnet registration properties are used to define various attributes of the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). These properties are defined by the [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) objects, which describe the available value formats. ", + "typeDoc": "The subnet registration detail property type has been deprecated. \n\nSubnet registration properties are used to define various attributes of the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). These properties are defined by the [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) objects, which describe the available value formats. ", "properties": { "detail": { "name": "detail", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "doc": "The [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object this property belongs to" + "doc": "[Deprecated] The [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object this property belongs to", + "deprecated": true }, "propertyType": { "name": "propertyType", "type": "SoftLayer_Account_Regional_Registry_Detail_Property_Type", "form": "relational", - "doc": "The [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) object this property belongs to" + "doc": "[Deprecated] The [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) object this property belongs to", + "deprecated": true }, "createDate": { "name": "createDate", @@ -12766,7 +12761,8 @@ "form": "local", "doc": "The value of the property " } - } + }, + "deprecated": true }, "SoftLayer_Account_Regional_Registry_Detail_Property_Type": { "name": "SoftLayer_Account_Regional_Registry_Detail_Property_Type", @@ -12779,7 +12775,8 @@ "static": true, "limitable": true, "filterable": true, - "maskable": true + "maskable": true, + "deprecated": true }, "getObject": { "name": "getObject", @@ -12789,7 +12786,7 @@ "maskable": true } }, - "typeDoc": "Subnet Registration Detail Property Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) object. These types use [http://php.net/pcre.pattern.php Perl-Compatible Regular Expressions] to validate the value of a property object. ", + "typeDoc": "The subnet registration detail property type type has been deprecated. \n\nSubnet Registration Detail Property Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) object. These types use [http://php.net/pcre.pattern.php Perl-Compatible Regular Expressions] to validate the value of a property object. ", "properties": { "createDate": { "name": "createDate", @@ -12825,7 +12822,8 @@ "form": "local", "doc": "A Perl-compatible regular expression used to describe the valid format of the property " } - } + }, + "deprecated": true }, "SoftLayer_Account_Regional_Registry_Detail_Type": { "name": "SoftLayer_Account_Regional_Registry_Detail_Type", @@ -12838,7 +12836,8 @@ "static": true, "limitable": true, "filterable": true, - "maskable": true + "maskable": true, + "deprecated": true }, "getObject": { "name": "getObject", @@ -12848,7 +12847,7 @@ "maskable": true } }, - "typeDoc": "Subnet Registration Detail Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object. \n\nThe standard values for these objects are as follows: ", + "typeDoc": "The subnet registration detail type type has been deprecated. \n\nSubnet Registration Detail Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object. \n\nThe standard values for these objects are as follows: ", "properties": { "createDate": { "name": "createDate", @@ -12878,21 +12877,24 @@ "form": "local", "doc": "Human-readable name of the detail type " } - } + }, + "deprecated": true }, "SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default": { "name": "SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default", "base": "SoftLayer_Account_Regional_Registry_Detail", "noservice": true, - "typeDoc": "The SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default data type contains general information relating to a single SoftLayer RIR account. RIR account information in this type such as names, addresses, and phone numbers are assigned to the registry only and not to users belonging to the account. ", + "typeDoc": "The subnet registration default person detail type has been deprecated. \n\nThe SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default data type contains general information relating to a single SoftLayer RIR account. RIR account information in this type such as names, addresses, and phone numbers are assigned to the registry only and not to users belonging to the account. ", + "deprecated": true, "methods": { "createObject": { "name": "createObject", "type": "SoftLayer_Account_Regional_Registry_Detail", - "doc": " This method will create a new SoftLayer_Account_Regional_Registry_Detail object. \n\nInput - [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) ", - "docOverview": "Create a new detail object", + "doc": "The subnet registration detail service has been deprecated. \n\n This method will create a new SoftLayer_Account_Regional_Registry_Detail object. \n\nInput - [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) ", + "docOverview": "[Deprecated] Create a new detail object", "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -12904,14 +12906,16 @@ "deleteObject": { "name": "deleteObject", "type": "boolean", - "doc": "This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. ", - "docOverview": "Delete an existing detail object" + "doc": "The subnet registration detail service has been deprecated. \n\nThis method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. ", + "docOverview": "[Deprecated] Delete an existing detail object", + "deprecated": true }, "editObject": { "name": "editObject", "type": "boolean", - "doc": "This method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail::createObject](/reference/datatypes/$1/#$2). ", - "docOverview": "Edit an existing detail object", + "doc": "The subnet registration detail service has been deprecated. \n\nThis method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail::createObject](/reference/datatypes/$1/#$2). ", + "docOverview": "[Deprecated] Edit an existing detail object", + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -12930,15 +12934,17 @@ "updateReferencedRegistrations": { "name": "updateReferencedRegistrations", "type": "SoftLayer_Container_Network_Subnet_Registration_TransactionDetails", - "doc": "This method will create a bulk transaction to update any registrations that reference this detail object. It should only be called from a child class such as [SoftLayer_Account_Regional_Registry_Detail_Person](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Person) or [SoftLayer_Account_Regional_Registry_Detail_Network](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Network). The registrations should be in the Open or Registration_Complete status. ", - "docOverview": "Create a transaction to update the registrations that reference this detail object." + "doc": "The subnet registration detail service has been deprecated. \n\nThis method will create a bulk transaction to update any registrations that reference this detail object. It should only be called from a child class such as [SoftLayer_Account_Regional_Registry_Detail_Person](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Person) or [SoftLayer_Account_Regional_Registry_Detail_Network](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Network). The registrations should be in the Open or Registration_Complete status. ", + "docOverview": "[Deprecated] Create a transaction to update the registrations that reference this detail object.", + "deprecated": true }, "validatePersonForAllRegistrars": { "name": "validatePersonForAllRegistrars", "type": "SoftLayer_Container_Message", "typeArray": true, - "doc": "Validates this person detail against all supported external registrars (APNIC/ARIN/RIPE). The validation uses the most restrictive rules ensuring that any person detail passing this validation would be acceptable to any supported registrar. \n\nThe person detail properties are validated against - Non-emptiness - Minimum length - Maximum length - Maximum words - Supported characters - Format of data \n\nIf the person detail validation succeeds, then an empty list is returned indicating no errors were found and that this person detail would work against all three registrars during a subnet registration. \n\nIf the person detail validation fails, then an array of validation errors (SoftLayer_Container_Message[]) is returned. Each message container contains error messages grouped by property type and a message type indicating the person detail property type object which failed validation. It is possible to create a subnet registration using a person detail which does not pass this validation, but at least one registrar would reject it for being invalid. ", - "docOverview": "Validate an existing person detail object." + "doc": "The subnet registration detail service has been deprecated. \n\nValidates this person detail against all supported external registrars (APNIC/ARIN/RIPE). The validation uses the most restrictive rules ensuring that any person detail passing this validation would be acceptable to any supported registrar. \n\nThe person detail properties are validated against - Non-emptiness - Minimum length - Maximum length - Maximum words - Supported characters - Format of data \n\nIf the person detail validation succeeds, then an empty list is returned indicating no errors were found and that this person detail would work against all three registrars during a subnet registration. \n\nIf the person detail validation fails, then an array of validation errors (SoftLayer_Container_Message[]) is returned. Each message container contains error messages grouped by property type and a message type indicating the person detail property type object which failed validation. It is possible to create a subnet registration using a person detail which does not pass this validation, but at least one registrar would reject it for being invalid. ", + "docOverview": "[Deprecated] Validate an existing person detail object.", + "deprecated": true } }, "properties": { @@ -12946,33 +12952,38 @@ "name": "account", "type": "SoftLayer_Account", "form": "relational", - "doc": "The account that this detail object belongs to." + "doc": "[Deprecated] The account that this detail object belongs to.", + "deprecated": true }, "detailType": { "name": "detailType", "type": "SoftLayer_Account_Regional_Registry_Detail_Type", "form": "relational", - "doc": "The associated type of this detail object." + "doc": "[Deprecated] The associated type of this detail object.", + "deprecated": true }, "details": { "name": "details", "type": "SoftLayer_Network_Subnet_Registration_Details", "form": "relational", "typeArray": true, - "doc": "References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object." + "doc": "[Deprecated] References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object.", + "deprecated": true }, "properties": { "name": "properties", "type": "SoftLayer_Account_Regional_Registry_Detail_Property", "form": "relational", "typeArray": true, - "doc": "The individual properties that define this detail object's values." + "doc": "[Deprecated] The individual properties that define this detail object's values.", + "deprecated": true }, "regionalInternetRegistryHandle": { "name": "regionalInternetRegistryHandle", "type": "SoftLayer_Account_Rwhois_Handle", "form": "relational", - "doc": "The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary." + "doc": "[Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.", + "deprecated": true }, "accountId": { "name": "accountId", @@ -13014,13 +13025,13 @@ "name": "detailCount", "type": "unsignedLong", "form": "count", - "doc": "A count of references to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object." + "doc": "A count of [Deprecated] References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object." }, "propertyCount": { "name": "propertyCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the individual properties that define this detail object's values." + "doc": "A count of [Deprecated] The individual properties that define this detail object's values." } } }, @@ -13293,13 +13304,14 @@ "name": "SoftLayer_Account_Rwhois_Handle", "base": "SoftLayer_Entity", "noservice": true, - "typeDoc": "Provides a means of tracking handle identifiers at the various regional internet registries (RIRs). These objects are used by the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) objects to identify a customer or organization when a subnet is registered. ", + "typeDoc": "The subnet registration handle type has been deprecated. \n\nProvides a means of tracking handle identifiers at the various regional internet registries (RIRs). These objects are used by the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) objects to identify a customer or organization when a subnet is registered. ", "properties": { "account": { "name": "account", "type": "SoftLayer_Account", "form": "relational", - "doc": "The account that this handle belongs to." + "doc": "[Deprecated] The account that this handle belongs to.", + "deprecated": true }, "accountId": { "name": "accountId", @@ -13330,6 +13342,7 @@ "form": "local" } }, + "deprecated": true, "methods": {} }, "SoftLayer_Account_Shipment": { @@ -21756,116 +21769,16 @@ } } }, - "SoftLayer_Billing_Item_Hardware": { - "name": "SoftLayer_Billing_Item_Hardware", + "SoftLayer_Billing_Item_Gateway_License": { + "name": "SoftLayer_Billing_Item_Gateway_License", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. ", + "typeDoc": "The SoftLayer_Billing_Item_Gateway_License data type contains general information relating to a single SoftLayer billing item for a bare_metal_gateway_license ", "properties": { - "billingCycleBandwidthUsage": { - "name": "billingCycleBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." - }, - "billingCyclePrivateBandwidthUsage": { - "name": "billingCyclePrivateBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePrivateUsageIn": { - "name": "billingCyclePrivateUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePrivateUsageOut": { - "name": "billingCyclePrivateUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePrivateUsageTotal": { - "name": "billingCyclePrivateUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total private bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicBandwidthUsage": { - "name": "billingCyclePublicBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw public bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicUsageIn": { - "name": "billingCyclePublicUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicUsageTotal": { - "name": "billingCyclePublicUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total public bandwidth for this hardware for the current billing cycle." - }, - "lockboxNetworkStorage": { - "name": "lockboxNetworkStorage", - "type": "SoftLayer_Billing_Item_Network_Storage", - "form": "relational", - "doc": "A lockbox account associated with a server." - }, - "monitoringBillingItems": { - "name": "monitoringBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true - }, "resource": { "name": "resource", - "type": "SoftLayer_Hardware_Server", - "form": "relational", - "doc": "The resource for a server billing item." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a server billing item." - }, - "billingCycleBandwidthUsageCount": { - "name": "billingCycleBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." - }, - "billingCyclePrivateBandwidthUsageCount": { - "name": "billingCyclePrivateBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicBandwidthUsageCount": { - "name": "billingCyclePublicBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw public bandwidth usage data for the current billing cycle." - }, - "monitoringBillingItemCount": { - "name": "monitoringBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "type": "SoftLayer_Network_Gateway", + "form": "relational" }, "account": { "name": "account", @@ -22661,180 +22574,11 @@ } } }, - "SoftLayer_Billing_Item_Hardware_Colocation": { - "name": "SoftLayer_Billing_Item_Hardware_Colocation", - "base": "SoftLayer_Billing_Item_Hardware", + "SoftLayer_Billing_Item_Hardware": { + "name": "SoftLayer_Billing_Item_Hardware", + "base": "SoftLayer_Billing_Item", "noservice": true, "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, "properties": { "billingCycleBandwidthUsage": { "name": "billingCycleBandwidthUsage", @@ -23564,20 +23308,426 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } + }, + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } } }, - "SoftLayer_Billing_Item_Hardware_Component": { - "name": "SoftLayer_Billing_Item_Hardware_Component", - "base": "SoftLayer_Billing_Item", + "SoftLayer_Billing_Item_Hardware_Colocation": { + "name": "SoftLayer_Billing_Item_Hardware_Colocation", + "base": "SoftLayer_Billing_Item_Hardware", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components. ", + "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } + }, "properties": { + "billingCycleBandwidthUsage": { + "name": "billingCycleBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." + }, + "billingCyclePrivateBandwidthUsage": { + "name": "billingCyclePrivateBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw private bandwidth usage data for the current billing cycle." + }, + "billingCyclePrivateUsageIn": { + "name": "billingCyclePrivateUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePrivateUsageOut": { + "name": "billingCyclePrivateUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePrivateUsageTotal": { + "name": "billingCyclePrivateUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total private bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicBandwidthUsage": { + "name": "billingCyclePublicBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw public bandwidth usage data for the current billing cycle." + }, + "billingCyclePublicUsageIn": { + "name": "billingCyclePublicUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicUsageOut": { + "name": "billingCyclePublicUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicUsageTotal": { + "name": "billingCyclePublicUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total public bandwidth for this hardware for the current billing cycle." + }, + "lockboxNetworkStorage": { + "name": "lockboxNetworkStorage", + "type": "SoftLayer_Billing_Item_Network_Storage", + "form": "relational", + "doc": "A lockbox account associated with a server." + }, + "monitoringBillingItems": { + "name": "monitoringBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, "resource": { "name": "resource", - "type": "SoftLayer_Hardware_Component", + "type": "SoftLayer_Hardware_Server", "form": "relational", - "typeArray": true, - "doc": "The hardware component that this billing item points to." + "doc": "The resource for a server billing item." }, "resourceTableId": { "name": "resourceTableId", @@ -23585,11 +23735,29 @@ "form": "local", "doc": "The resource (unique identifier) for a server billing item." }, - "resourceCount": { - "name": "resourceCount", + "billingCycleBandwidthUsageCount": { + "name": "billingCycleBandwidthUsageCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the hardware component that this billing item points to." + "doc": "A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." + }, + "billingCyclePrivateBandwidthUsageCount": { + "name": "billingCyclePrivateBandwidthUsageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the raw private bandwidth usage data for the current billing cycle." + }, + "billingCyclePublicBandwidthUsageCount": { + "name": "billingCyclePublicBandwidthUsageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the raw public bandwidth usage data for the current billing cycle." + }, + "monitoringBillingItemCount": { + "name": "monitoringBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, "account": { "name": "account", @@ -24214,426 +24382,20 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Hardware_Security_Module": { - "name": "SoftLayer_Billing_Item_Hardware_Security_Module", - "base": "SoftLayer_Billing_Item_Hardware", + "SoftLayer_Billing_Item_Hardware_Component": { + "name": "SoftLayer_Billing_Item_Hardware_Component", + "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware_Security_Module data type contains general information relating to a single SoftLayer billing item for a hardware security module. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, + "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components. ", "properties": { - "billingCycleBandwidthUsage": { - "name": "billingCycleBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." - }, - "billingCyclePrivateBandwidthUsage": { - "name": "billingCyclePrivateBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePrivateUsageIn": { - "name": "billingCyclePrivateUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePrivateUsageOut": { - "name": "billingCyclePrivateUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePrivateUsageTotal": { - "name": "billingCyclePrivateUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total private bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicBandwidthUsage": { - "name": "billingCyclePublicBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw public bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicUsageIn": { - "name": "billingCyclePublicUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicUsageTotal": { - "name": "billingCyclePublicUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total public bandwidth for this hardware for the current billing cycle." - }, - "lockboxNetworkStorage": { - "name": "lockboxNetworkStorage", - "type": "SoftLayer_Billing_Item_Network_Storage", - "form": "relational", - "doc": "A lockbox account associated with a server." - }, - "monitoringBillingItems": { - "name": "monitoringBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true - }, "resource": { "name": "resource", - "type": "SoftLayer_Hardware_Server", + "type": "SoftLayer_Hardware_Component", "form": "relational", - "doc": "The resource for a server billing item." + "typeArray": true, + "doc": "The hardware component that this billing item points to." }, "resourceTableId": { "name": "resourceTableId", @@ -24641,29 +24403,11 @@ "form": "local", "doc": "The resource (unique identifier) for a server billing item." }, - "billingCycleBandwidthUsageCount": { - "name": "billingCycleBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." - }, - "billingCyclePrivateBandwidthUsageCount": { - "name": "billingCyclePrivateBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicBandwidthUsageCount": { - "name": "billingCyclePublicBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw public bandwidth usage data for the current billing cycle." - }, - "monitoringBillingItemCount": { - "name": "monitoringBillingItemCount", + "resourceCount": { + "name": "resourceCount", "type": "unsignedLong", "form": "count", - "doc": "A count of " + "doc": "A count of the hardware component that this billing item points to." }, "account": { "name": "account", @@ -25288,13 +25032,182 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } - } - }, - "SoftLayer_Billing_Item_Hardware_Server": { - "name": "SoftLayer_Billing_Item_Hardware_Server", - "base": "SoftLayer_Billing_Item_Hardware", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware_Server data type contains billing information about a bare metal server and its relationship to a particular customer account. ", + }, + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } + } + }, + "SoftLayer_Billing_Item_Hardware_Security_Module": { + "name": "SoftLayer_Billing_Item_Hardware_Security_Module", + "base": "SoftLayer_Billing_Item_Hardware", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Hardware_Security_Module data type contains general information relating to a single SoftLayer billing item for a hardware security module. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -26195,23 +26108,285 @@ } } }, - "SoftLayer_Billing_Item_Network_Application_Delivery_Controller": { - "name": "SoftLayer_Billing_Item_Network_Application_Delivery_Controller", - "base": "SoftLayer_Billing_Item", + "SoftLayer_Billing_Item_Hardware_Server": { + "name": "SoftLayer_Billing_Item_Hardware_Server", + "base": "SoftLayer_Billing_Item_Hardware", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to a NetScaler VPX ", + "typeDoc": "The SoftLayer_Billing_Item_Hardware_Server data type contains billing information about a bare metal server and its relationship to a particular customer account. ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } + }, "properties": { - "bandwidthAllotmentDetail": { - "name": "bandwidthAllotmentDetail", - "type": "SoftLayer_Network_Bandwidth_Version1_Allotment_Detail", + "billingCycleBandwidthUsage": { + "name": "billingCycleBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", "form": "relational", - "doc": "The bandwidth allotment detail for a billing item." + "typeArray": true, + "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." + }, + "billingCyclePrivateBandwidthUsage": { + "name": "billingCyclePrivateBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw private bandwidth usage data for the current billing cycle." + }, + "billingCyclePrivateUsageIn": { + "name": "billingCyclePrivateUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePrivateUsageOut": { + "name": "billingCyclePrivateUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePrivateUsageTotal": { + "name": "billingCyclePrivateUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total private bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicBandwidthUsage": { + "name": "billingCyclePublicBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw public bandwidth usage data for the current billing cycle." + }, + "billingCyclePublicUsageIn": { + "name": "billingCyclePublicUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicUsageOut": { + "name": "billingCyclePublicUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicUsageTotal": { + "name": "billingCyclePublicUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total public bandwidth for this hardware for the current billing cycle." + }, + "lockboxNetworkStorage": { + "name": "lockboxNetworkStorage", + "type": "SoftLayer_Billing_Item_Network_Storage", + "form": "relational", + "doc": "A lockbox account associated with a server." + }, + "monitoringBillingItems": { + "name": "monitoringBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true }, "resource": { "name": "resource", - "type": "SoftLayer_Network_Application_Delivery_Controller", + "type": "SoftLayer_Hardware_Server", "form": "relational", - "doc": "The network application controller that a billing item is associated with." + "doc": "The resource for a server billing item." + }, + "resourceTableId": { + "name": "resourceTableId", + "type": "int", + "form": "local", + "doc": "The resource (unique identifier) for a server billing item." + }, + "billingCycleBandwidthUsageCount": { + "name": "billingCycleBandwidthUsageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." + }, + "billingCyclePrivateBandwidthUsageCount": { + "name": "billingCyclePrivateBandwidthUsageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the raw private bandwidth usage data for the current billing cycle." + }, + "billingCyclePublicBandwidthUsageCount": { + "name": "billingCyclePublicBandwidthUsageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the raw public bandwidth usage data for the current billing cycle." + }, + "monitoringBillingItemCount": { + "name": "monitoringBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, "account": { "name": "account", @@ -26836,188 +27011,25 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress": { - "name": "SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress", + "SoftLayer_Billing_Item_Network_Application_Delivery_Controller": { + "name": "SoftLayer_Billing_Item_Network_Application_Delivery_Controller", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "A SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) instance. ", + "typeDoc": "The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to a NetScaler VPX ", "properties": { + "bandwidthAllotmentDetail": { + "name": "bandwidthAllotmentDetail", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment_Detail", + "form": "relational", + "doc": "The bandwidth allotment detail for a billing item." + }, "resource": { "name": "resource", - "type": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress", + "type": "SoftLayer_Network_Application_Delivery_Controller", "form": "relational", - "doc": "The load balancer that a load balancer billing item is associated with." + "doc": "The network application controller that a billing item is associated with." }, "account": { "name": "account", @@ -27813,181 +27825,18 @@ } } }, - "SoftLayer_Billing_Item_Network_Bandwidth": { - "name": "SoftLayer_Billing_Item_Network_Bandwidth", + "SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress": { + "name": "SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, + "typeDoc": "A SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) instance. ", "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress", + "form": "relational", + "doc": "The load balancer that a load balancer billing item is associated with." + }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -28611,20 +28460,352 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } + }, + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } } }, - "SoftLayer_Billing_Item_Network_Firewall": { - "name": "SoftLayer_Billing_Item_Network_Firewall", + "SoftLayer_Billing_Item_Network_Bandwidth": { + "name": "SoftLayer_Billing_Item_Network_Bandwidth", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Firewall data type contains general information relating to a single SoftLayer billing item whose item category code is 'firewall' ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Component_Firewall", - "form": "relational", - "doc": "The VLAN firewall that a VLAN firewall billing item is associated with." + "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } + }, + "properties": { "account": { "name": "account", "type": "SoftLayer_Account", @@ -29248,188 +29429,19 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Network_Firewall_Module_Context": { - "name": "SoftLayer_Billing_Item_Network_Firewall_Module_Context", + "SoftLayer_Billing_Item_Network_Firewall": { + "name": "SoftLayer_Billing_Item_Network_Firewall", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Firewall_Module_Context data type describes the billing items related to VLAN Firewalls. ", + "typeDoc": "The SoftLayer_Billing_Item_Network_Firewall data type contains general information relating to a single SoftLayer billing item whose item category code is 'firewall' ", "properties": { - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Component_Firewall", "form": "relational", - "doc": "The total public outbound bandwidth for this firewall for the current billing cycle." + "doc": "The VLAN firewall that a VLAN firewall billing item is associated with." }, "account": { "name": "account", @@ -30225,17 +30237,17 @@ } } }, - "SoftLayer_Billing_Item_Network_Interconnect": { - "name": "SoftLayer_Billing_Item_Network_Interconnect", + "SoftLayer_Billing_Item_Network_Firewall_Module_Context": { + "name": "SoftLayer_Billing_Item_Network_Firewall_Module_Context", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "A SoftLayer_Billing_Item_Network_Interconnect represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect instance. ", + "typeDoc": "The SoftLayer_Billing_Item_Network_Firewall_Module_Context data type describes the billing items related to VLAN Firewalls. ", "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Interconnect_Tenant", + "billingCyclePublicUsageOut": { + "name": "billingCyclePublicUsageOut", + "type": "decimal", "form": "relational", - "doc": "The interconnect tenant that the billing item is associated with." + "doc": "The total public outbound bandwidth for this firewall for the current billing cycle." }, "account": { "name": "account", @@ -31031,11 +31043,11 @@ } } }, - "SoftLayer_Billing_Item_Network_Interconnect_Routing": { - "name": "SoftLayer_Billing_Item_Network_Interconnect_Routing", + "SoftLayer_Billing_Item_Network_Interconnect": { + "name": "SoftLayer_Billing_Item_Network_Interconnect", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "A SoftLayer_Billing_Item_Network_Interconnect_Routing represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect global routing. ", + "typeDoc": "A SoftLayer_Billing_Item_Network_Interconnect represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect instance. ", "properties": { "resource": { "name": "resource", @@ -31837,181 +31849,18 @@ } } }, - "SoftLayer_Billing_Item_Network_LoadBalancer": { - "name": "SoftLayer_Billing_Item_Network_LoadBalancer", + "SoftLayer_Billing_Item_Network_Interconnect_Routing": { + "name": "SoftLayer_Billing_Item_Network_Interconnect_Routing", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "A SoftLayer_Billing_Item_Network_LoadBalancer represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_LoadBalancer](/reference/datatypes/SoftLayer_Network_LoadBalancer) instance. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, + "typeDoc": "A SoftLayer_Billing_Item_Network_Interconnect_Routing represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect global routing. ", "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Interconnect_Tenant", + "form": "relational", + "doc": "The interconnect tenant that the billing item is associated with." + }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -32635,20 +32484,352 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } + }, + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } } }, - "SoftLayer_Billing_Item_Network_LoadBalancer_Global": { - "name": "SoftLayer_Billing_Item_Network_LoadBalancer_Global", + "SoftLayer_Billing_Item_Network_LoadBalancer": { + "name": "SoftLayer_Billing_Item_Network_LoadBalancer", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The global load balancer service has been deprecated and is no longer available. \n\nThe SoftLayer_Billing_Item_Network_LoadBalancer_Global data type contains general information relating to a single SoftLayer billing item whose item category code is 'global_load_balancer' ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_LoadBalancer_Global_Account", - "form": "relational", - "doc": "The resource for a global load balancer billing item." + "typeDoc": "A SoftLayer_Billing_Item_Network_LoadBalancer represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_LoadBalancer](/reference/datatypes/SoftLayer_Network_LoadBalancer) instance. ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } + }, + "properties": { "account": { "name": "account", "type": "SoftLayer_Account", @@ -33272,189 +33453,19 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } - }, - "deprecated": true, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress": { - "name": "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress", + "SoftLayer_Billing_Item_Network_LoadBalancer_Global": { + "name": "SoftLayer_Billing_Item_Network_LoadBalancer_Global", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "A SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/datatypes/SoftLayer_Network_LoadBalancer_VirtualIpAddress) instance. ", + "typeDoc": "The global load balancer service has been deprecated and is no longer available. \n\nThe SoftLayer_Billing_Item_Network_LoadBalancer_Global data type contains general information relating to a single SoftLayer billing item whose item category code is 'global_load_balancer' ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_LoadBalancer_VirtualIpAddress", + "type": "SoftLayer_Network_LoadBalancer_Global_Account", "form": "relational", - "doc": "The load balancer's virtual IP address that the billing item is associated with." + "doc": "The resource for a global load balancer billing item." }, "account": { "name": "account", @@ -34080,6 +34091,7 @@ "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } }, + "deprecated": true, "methods": { "cancelItem": { "name": "cancelItem", @@ -34250,17 +34262,17 @@ } } }, - "SoftLayer_Billing_Item_Network_Message_Delivery": { - "name": "SoftLayer_Billing_Item_Network_Message_Delivery", + "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress": { + "name": "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Message_Delivery data describes the related billing item. ", + "typeDoc": "A SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/datatypes/SoftLayer_Network_LoadBalancer_VirtualIpAddress) instance. ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_Message_Delivery", + "type": "SoftLayer_Network_LoadBalancer_VirtualIpAddress", "form": "relational", - "doc": "The object this billing item is associated with." + "doc": "The load balancer's virtual IP address that the billing item is associated with." }, "account": { "name": "account", @@ -35056,186 +35068,17 @@ } } }, - "SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi": { - "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi", - "base": "SoftLayer_Billing_Item_Network_Storage", + "SoftLayer_Billing_Item_Network_Message_Delivery": { + "name": "SoftLayer_Billing_Item_Network_Message_Delivery", + "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi data type contains general information relating to a single SoftLayer billing item whose item category code is 'performance_storage_iscsi' ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, + "typeDoc": "The SoftLayer_Billing_Item_Network_Message_Delivery data describes the related billing item. ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_Storage", + "type": "SoftLayer_Network_Message_Delivery", "form": "relational", - "doc": "The StorageLayer account that a network storage billing item is associated with." + "doc": "The object this billing item is associated with." }, "account": { "name": "account", @@ -35860,13 +35703,182 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } + }, + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } } }, - "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs": { - "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs", + "SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi": { + "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi", "base": "SoftLayer_Billing_Item_Network_Storage", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs data type contains general information relating to a single SoftLayer billing item whose item category code is 'performance_storage_nfs' ", + "typeDoc": "The SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi data type contains general information relating to a single SoftLayer billing item whose item category code is 'performance_storage_iscsi' ", "methods": { "cancelItem": { "name": "cancelItem", @@ -36668,11 +36680,180 @@ } } }, - "SoftLayer_Billing_Item_Network_Storage": { - "name": "SoftLayer_Billing_Item_Network_Storage", - "base": "SoftLayer_Billing_Item", + "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs": { + "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs", + "base": "SoftLayer_Billing_Item_Network_Storage", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts. ", + "typeDoc": "The SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs data type contains general information relating to a single SoftLayer billing item whose item category code is 'performance_storage_nfs' ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } + }, "properties": { "resource": { "name": "resource", @@ -37303,351 +37484,13 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Network_Storage_Hub": { - "name": "SoftLayer_Billing_Item_Network_Storage_Hub", - "base": "SoftLayer_Billing_Item_Network_Storage", + "SoftLayer_Billing_Item_Network_Storage": { + "name": "SoftLayer_Billing_Item_Network_Storage", + "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Storage_Hub models all billing items related to hub-based StorageLayer offerings, such as CloudLayer storage. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, + "typeDoc": "The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts. ", "properties": { "resource": { "name": "resource", @@ -38278,13 +38121,182 @@ "form": "count", "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." } - } - }, - "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth": { - "name": "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth", - "base": "SoftLayer_Billing_Item_Network_Storage", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth data type models the billing items created when a CloudLayer storage account generates a bandwidth overage charge. ", + }, + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } + } + }, + "SoftLayer_Billing_Item_Network_Storage_Hub": { + "name": "SoftLayer_Billing_Item_Network_Storage_Hub", + "base": "SoftLayer_Billing_Item_Network_Storage", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Network_Storage_Hub models all billing items related to hub-based StorageLayer offerings, such as CloudLayer storage. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -39086,29 +39098,835 @@ } } }, - "SoftLayer_Billing_Item_Network_Subnet": { - "name": "SoftLayer_Billing_Item_Network_Subnet", - "base": "SoftLayer_Billing_Item", + "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth": { + "name": "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth", + "base": "SoftLayer_Billing_Item_Network_Storage", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Subnet data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: \n* pri_ip_address\n* static_sec_ip_addresses (static secondary)\n* sov_sec_ip_addresses (secondary on vlan, also known as \"portable ips\")\n* sov_sec_ip_addresses_pub (sov_sec_ip_addresses public only)\n* sov_sec_ip_addresses_priv (sov_sec_ip_addresses private only)\n* sec_ip_addresses (old style, secondary ip addresses)\n\n\nThese item categories denote that the billing item has subnet information attached. ", + "typeDoc": "The SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth data type models the billing items created when a CloudLayer storage account generates a bandwidth overage charge. ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] + }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service. \n\nIn order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] + }, + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + } + }, "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_Subnet", + "type": "SoftLayer_Network_Storage", "form": "relational", - "doc": "The resource for a subnet-related billing item." - }, - "resourceName": { - "name": "resourceName", - "type": "string", - "form": "local", - "doc": "The resource name for a subnet billing item." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a server billing item." + "doc": "The StorageLayer account that a network storage billing item is associated with." + }, + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "A billing item's associated parent. This is to be used for billing items that are \"floating\", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item." + }, + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." + }, + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." + }, + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." + }, + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " + }, + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" + }, + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "For product items which have a downgrade path defined, this will return those product items." + }, + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + }, + "hourlyFlag": { + "name": "hourlyFlag", + "type": "boolean", + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + }, + "invoiceItem": { + "name": "invoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "doc": "Invoice items associated with this billing item" + }, + "invoiceItems": { + "name": "invoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "typeArray": true, + "doc": "All invoice items associated with the billing item" + }, + "item": { + "name": "item", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + }, + "location": { + "name": "location", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information." + }, + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items and associated items'" + }, + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" + }, + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" + }, + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + }, + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", + "type": "float", + "form": "relational", + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + }, + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + }, + "orderItem": { + "name": "orderItem", + "type": "SoftLayer_Billing_Order_Item", + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + }, + "originalLocation": { + "name": "originalLocation", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." + }, + "package": { + "name": "package", + "type": "SoftLayer_Product_Package", + "form": "relational", + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + }, + "parent": { + "name": "parent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + }, + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + }, + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", + "type": "boolean", + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + }, + "pendingOrderItem": { + "name": "pendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "form": "relational", + "doc": "The new order item that will replace this billing item." + }, + "provisionTransaction": { + "name": "provisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "form": "relational", + "doc": "Provisioning transaction for this billing item" + }, + "softwareDescription": { + "name": "softwareDescription", + "type": "SoftLayer_Software_Description", + "form": "relational", + "doc": "A friendly description of software component" + }, + "upgradeItem": { + "name": "upgradeItem", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + }, + "upgradeItems": { + "name": "upgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." + }, + "allowCancellationFlag": { + "name": "allowCancellationFlag", + "type": "int", + "form": "local", + "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " + }, + "associatedBillingItemId": { + "name": "associatedBillingItemId", + "type": "string", + "form": "local", + "doc": "This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId](/reference/datatypes/$1/#$2). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. " + }, + "cancellationDate": { + "name": "cancellationDate", + "type": "dateTime", + "form": "local", + "doc": "A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. " + }, + "categoryCode": { + "name": "categoryCode", + "type": "string", + "form": "local", + "doc": "The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance." + }, + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date the billing item was created. You can see this date on the invoice." + }, + "currentHourlyCharge": { + "name": "currentHourlyCharge", + "type": "string", + "form": "local", + "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " + }, + "cycleStartDate": { + "name": "cycleStartDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." + }, + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "A brief description of a billing item." + }, + "domainName": { + "name": "domainName", + "type": "string", + "form": "local", + "doc": "The domain name is provided for server billing items." + }, + "hostName": { + "name": "hostName", + "type": "string", + "form": "local", + "doc": "The hostname is provided for server billing items" + }, + "hourlyRecurringFee": { + "name": "hourlyRecurringFee", + "type": "decimal", + "form": "local", + "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " + }, + "hoursUsed": { + "name": "hoursUsed", + "type": "string", + "form": "local", + "doc": "This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. " + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for this billing item." + }, + "laborFee": { + "name": "laborFee", + "type": "decimal", + "form": "local", + "doc": "The labor fee, if any. This is a one time charge." + }, + "laborFeeTaxRate": { + "name": "laborFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which labor fees are taxed if you are a taxable customer." + }, + "lastBillDate": { + "name": "lastBillDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." + }, + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "The date that a billing item was last modified." + }, + "nextBillDate": { + "name": "nextBillDate", + "type": "dateTime", + "form": "local", + "doc": "The date on which your account will be charged for this billing item. " + }, + "notes": { + "name": "notes", + "type": "string", + "form": "local", + "doc": "Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of." + }, + "oneTimeFee": { + "name": "oneTimeFee", + "type": "decimal", + "form": "local", + "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " + }, + "oneTimeFeeTaxRate": { + "name": "oneTimeFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which one time fees are taxed if you are a taxable customer." + }, + "orderItemId": { + "name": "orderItemId", + "type": "int", + "form": "local", + "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." + }, + "packageId": { + "name": "packageId", + "type": "int", + "form": "local", + "doc": "This is the package id for this billing item." + }, + "parentId": { + "name": "parentId", + "type": "int", + "form": "local", + "doc": "The unique identifier of the parent of this billing item." + }, + "recurringFee": { + "name": "recurringFee", + "type": "decimal", + "form": "local", + "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " + }, + "recurringFeeTaxRate": { + "name": "recurringFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which recurring fees are taxed if you are a taxable customer." + }, + "recurringMonths": { + "name": "recurringMonths", + "type": "int", + "form": "local", + "doc": "The number of months in which the recurring fees will be incurred." + }, + "serviceProviderId": { + "name": "serviceProviderId", + "type": "int", + "form": "local", + "doc": "This is the service provider for this billing item. " + }, + "setupFee": { + "name": "setupFee", + "type": "decimal", + "form": "local", + "doc": "The setup fee, if any. This is a one time charge." + }, + "setupFeeTaxRate": { + "name": "setupFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which setup fees are taxed if you are a taxable customer." + }, + "activeAssociatedChildrenCount": { + "name": "activeAssociatedChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItemCount": { + "name": "activeAssociatedGuestDiskBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "activeBundledItemCount": { + "name": "activeBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active bundled billing items." + }, + "activeChildrenCount": { + "name": "activeChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." + }, + "activeSparePoolAssociatedGuestDiskBillingItemCount": { + "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "activeSparePoolBundledItemCount": { + "name": "activeSparePoolBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's spare pool bundled billing items." + }, + "associatedBillingItemHistoryCount": { + "name": "associatedBillingItemHistoryCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a history of billing items which a billing item has been associated with." + }, + "associatedChildrenCount": { + "name": "associatedChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParentCount": { + "name": "associatedParentCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlanCount": { + "name": "availableMatchingVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "billableChildrenCount": { + "name": "billableChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItemCount": { + "name": "bundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's bundled billing items." + }, + "canceledChildrenCount": { + "name": "canceledChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." + }, + "cancellationRequestCount": { + "name": "cancellationRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of this will return any cancellation requests that are associated with this billing item." + }, + "childrenCount": { + "name": "childrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items'" + }, + "childrenWithActiveAgreementCount": { + "name": "childrenWithActiveAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." + }, + "downgradeItemCount": { + "name": "downgradeItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of for product items which have a downgrade path defined, this will return those product items." + }, + "filteredNextInvoiceChildrenCount": { + "name": "filteredNextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + }, + "invoiceItemCount": { + "name": "invoiceItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all invoice items associated with the billing item" + }, + "nextInvoiceChildrenCount": { + "name": "nextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items and associated items'" + }, + "nonZeroNextInvoiceChildrenCount": { + "name": "nonZeroNextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + }, + "upgradeItemCount": { + "name": "upgradeItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." + } + } + }, + "SoftLayer_Billing_Item_Network_Subnet": { + "name": "SoftLayer_Billing_Item_Network_Subnet", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Network_Subnet data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: \n* pri_ip_address\n* static_sec_ip_addresses (static secondary)\n* sov_sec_ip_addresses (secondary on vlan, also known as \"portable ips\")\n* sov_sec_ip_addresses_pub (sov_sec_ip_addresses public only)\n* sov_sec_ip_addresses_priv (sov_sec_ip_addresses private only)\n* sec_ip_addresses (old style, secondary ip addresses)\n\n\nThese item categories denote that the billing item has subnet information attached. ", + "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Subnet", + "form": "relational", + "doc": "The resource for a subnet-related billing item." + }, + "resourceName": { + "name": "resourceName", + "type": "string", + "form": "local", + "doc": "The resource name for a subnet billing item." + }, + "resourceTableId": { + "name": "resourceTableId", + "type": "int", + "form": "local", + "doc": "The resource (unique identifier) for a server billing item." }, "account": { "name": "account", @@ -68355,462 +69173,6 @@ } } }, - "SoftLayer_Dns_Domain_Registration": { - "name": "SoftLayer_Dns_Domain_Registration", - "base": "SoftLayer_Entity", - "serviceDoc": "[DEPRECATED] Registration and management of domain names and domain related services. ", - "methods": { - "addNameserversToDomain": { - "name": "addNameserversToDomain", - "type": "boolean", - "doc": "The addNameserversToDomain method adds nameservers to a domain for a domain that already has nameservers assigned to it. This method does not create a nameserver; the nameserver must already exist. ", - "docOverview": "Adds nameservers to a domain.", - "parameters": [ - { - "name": "nameservers", - "type": "string", - "typeArray": true, - "doc": "Array of fully qualified name of the nameservers" - } - ] - }, - "deleteRegisteredNameserver": { - "name": "deleteRegisteredNameserver", - "type": "boolean", - "doc": "The deleteRegisteredNameserver method deletes a nameserver that was registered, provided it is not currently serving a domain ", - "docOverview": "Deletes a registered nameserver.", - "parameters": [ - { - "name": "nameserver", - "type": "string", - "doc": "The fully qualified name of the nameserver" - } - ] - }, - "getAuthenticationCode": { - "name": "getAuthenticationCode", - "type": "string", - "doc": "The getAuthenticationCode method retrieves the authentication code for the domain. ", - "docOverview": "Get the authentication code for a domain." - }, - "getDomainInformation": { - "name": "getDomainInformation", - "type": "SoftLayer_Container_Dns_Domain_Registration_Information", - "doc": "The getDomainInformation method retrieves all the information for a domain. ", - "docOverview": "Retrieve all domain information." - }, - "getDomainNameservers": { - "name": "getDomainNameservers", - "type": "SoftLayer_Container_Dns_Domain_Registration_Nameserver", - "typeArray": true, - "doc": "The getDomainNameservers method retrieve nameservers information for domain. ", - "docOverview": "Retrieve domain nameservers." - }, - "getExtendedAttributes": { - "name": "getExtendedAttributes", - "type": "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute", - "typeArray": true, - "doc": "The getExtendedAttributes method determines if a country code top level domain requires extended attributes. ", - "docOverview": "Retrieves extended attributes.", - "static": true, - "parameters": [ - { - "name": "domainName", - "type": "string", - "doc": "The domain name (i.e. example.us)." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Dns_Domain_Registration", - "doc": "getObject retrieves the SoftLayer_Dns_Domain_Registration object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_Registration service. ", - "docOverview": "Retrieve a SoftLayer_Dns_Domain_Registration record.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_ObjectNotFound", - "description": "Throw the error \"Unable to find object with id of {id}.\" if the given initialization parameter has an invalid id field." - }, - { - "exception": "SoftLayer_Exception_AccessDenied", - "description": "Throw the error \"Access Denied.\" if the given initialization parameter id field is not the account id of the user making the API call." - } - ], - "filterable": true, - "maskable": true - }, - "getRegisteredNameserver": { - "name": "getRegisteredNameserver", - "type": "SoftLayer_Container_Dns_Domain_Registration_Nameserver", - "doc": "The getRegisteredNameserver method retrieves registered nameservers. ", - "docOverview": "Retrieves a registered nameserver." - }, - "getRegistrantVerificationStatusDetail": { - "name": "getRegistrantVerificationStatusDetail", - "type": "SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail", - "doc": "When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct. This method returns the current state of the verification request. ", - "docOverview": "Retrieves registrant verification status." - }, - "getTransferInformation": { - "name": "getTransferInformation", - "type": "SoftLayer_Container_Dns_Domain_Registration_Transfer_Information", - "doc": "The getTransferInformation method checks to see if the domain can be transferred and also can be used to check the status of the last transfer request. ", - "docOverview": "Retrieve domain transfer information.", - "static": true, - "parameters": [ - { - "name": "domainName", - "type": "string", - "doc": "Domain Name" - } - ] - }, - "lockDomain": { - "name": "lockDomain", - "type": "boolean", - "doc": "The lockDomain method locks a domain to prevent unauthorized, unwanted or accidental changes to the domain name. When set, the following actions are prohibited: \n* Transferring of the domain name\n* Deletion of the domain name", - "docOverview": "Locks a domain." - }, - "lookupDomain": { - "name": "lookupDomain", - "type": "SoftLayer_Container_Dns_Domain_Registration_Lookup", - "typeArray": true, - "doc": "The lookupDomain method checks whether a specified domain name is available for registration in TLD's, and suggests other similar domain names, and checks whether they are available as well. ", - "docOverview": "Lookup available domains and suggests other similar domain names", - "static": true, - "parameters": [ - { - "name": "domainName", - "type": "string", - "doc": "The domain name (i.e. example.com)." - } - ] - }, - "modifyContact": { - "name": "modifyContact", - "type": "boolean", - "doc": "The modifyContact method modifies contact information (admin, billing, owner, technical) for a domain. ", - "docOverview": "Modifies contact information for a domain.", - "parameters": [ - { - "name": "contact", - "type": "SoftLayer_Container_Dns_Domain_Registration_Contact", - "doc": "Contact information" - } - ] - }, - "modifyRegisteredNameserver": { - "name": "modifyRegisteredNameserver", - "type": "boolean", - "doc": "The modifyRegisteredNameserver method modifies a nameserver that was registered. ", - "docOverview": "Modifies a registered nameserver.", - "parameters": [ - { - "name": "oldNameserver", - "type": "string", - "doc": "The old, fully qualified domain name of the nameserver" - }, - { - "name": "newNameserver", - "type": "string", - "doc": "The new, fully qualified domain name for the nameserver" - }, - { - "name": "ipAddress", - "type": "string", - "doc": "The IP Address of the nameserver" - } - ] - }, - "registerNameserver": { - "name": "registerNameserver", - "type": "boolean", - "doc": "The registerNameserver method creates a nameserver for the domain. ", - "docOverview": "Creates a nameserver.", - "parameters": [ - { - "name": "nameserver", - "type": "string", - "doc": "The fully qualified name of the nameserver" - }, - { - "name": "ipAddress", - "type": "string", - "doc": "The IP Address of the nameserver" - } - ] - }, - "removeNameserversFromDomain": { - "name": "removeNameserversFromDomain", - "type": "boolean", - "doc": "The removeNameserversFromDomain method removes nameservers from a domain for a domain that already has nameservers assigned to it. ", - "docOverview": "Removes nameservers from a domain.", - "parameters": [ - { - "name": "nameservers", - "type": "string", - "typeArray": true, - "doc": "Array of fully qualified name of the nameservers" - } - ] - }, - "sendAuthenticationCode": { - "name": "sendAuthenticationCode", - "type": "boolean", - "doc": "The sendAuthenticationCode method sends the authentication code to the administrative contact for the domain. ", - "docOverview": "Sends the authentication code" - }, - "sendRegistrantVerificationEmail": { - "name": "sendRegistrantVerificationEmail", - "type": "boolean", - "doc": "When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct. This method sends the verification email to the registrant. ", - "docOverview": "Sends verification email to the registrant." - }, - "sendTransferApprovalEmail": { - "name": "sendTransferApprovalEmail", - "type": "boolean", - "doc": "The sendTransferApprovalEmail method resends a transfer approval email message for a transfer that is in 'pending owner approval' state, to the admin contact listed for the domain at the time that the transfer request was submitted ", - "docOverview": "Resends a transfer approval email message." - }, - "setAuthenticationCode": { - "name": "setAuthenticationCode", - "type": "boolean", - "doc": "The setAuthenticationCode method sets the authentication code for the domain. The authentication code is a transfer key and provides an extra level of security, safeguarding domain names from unauthorized transfers. ", - "docOverview": "Sets the authentication code for a domain.", - "parameters": [ - { - "name": "authenticationCode", - "type": "string", - "doc": "Authentication Code" - } - ] - }, - "unlockDomain": { - "name": "unlockDomain", - "type": "boolean", - "doc": "The unlockDomain method unlocks a domain ", - "docOverview": "Unlocks a domain." - }, - "getAccount": { - "doc": "The SoftLayer customer account that the domain is registered to.", - "docOverview": "", - "name": "getAccount", - "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - }, - "getDomainRegistrationStatus": { - "doc": "The domain registration status.", - "docOverview": "", - "name": "getDomainRegistrationStatus", - "type": "SoftLayer_Dns_Domain_Registration_Status", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - }, - "getRegistrantVerificationStatus": { - "doc": "The registrant verification status.", - "docOverview": "", - "name": "getRegistrantVerificationStatus", - "type": "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - }, - "getServiceProvider": { - "doc": "", - "docOverview": "", - "name": "getServiceProvider", - "type": "SoftLayer_Service_Provider", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - } - }, - "typeDoc": "The SoftLayer_Dns_Domain_Registration data type represents a domain registration record. ", - "properties": { - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational", - "doc": "The SoftLayer customer account that the domain is registered to." - }, - "domainRegistrationStatus": { - "name": "domainRegistrationStatus", - "type": "SoftLayer_Dns_Domain_Registration_Status", - "form": "relational", - "doc": "The domain registration status." - }, - "registrantVerificationStatus": { - "name": "registrantVerificationStatus", - "type": "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status", - "form": "relational", - "doc": "The registrant verification status." - }, - "serviceProvider": { - "name": "serviceProvider", - "type": "SoftLayer_Service_Provider", - "form": "relational" - }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local" - }, - "domainRegistrationStatusId": { - "name": "domainRegistrationStatusId", - "type": "int", - "form": "local" - }, - "expireDate": { - "name": "expireDate", - "type": "dateTime", - "form": "local", - "doc": "The date that the domain registration will expire." - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "A domain record's internal identifier." - }, - "lockedFlag": { - "name": "lockedFlag", - "type": "int", - "form": "local", - "doc": "Indicates whether a domain is locked or unlocked." - }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local" - }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "A domain's name, for example \"example.com\"." - }, - "registrantVerificationStatusId": { - "name": "registrantVerificationStatusId", - "type": "int", - "form": "local" - }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local" - } - }, - "deprecated": true - }, - "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status": { - "name": "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status", - "base": "SoftLayer_Entity", - "methods": { - "getAllObjects": { - "name": "getAllObjects", - "type": "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status", - "typeArray": true, - "static": true, - "filterable": true, - "maskable": true - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status", - "docOverview": "Retrieve a SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status record.", - "filterable": true, - "maskable": true - } - }, - "typeDoc": "[DEPRECATED] SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status models the state of the registrant. Here are the following status codes: \n\n\n*'''Admin Reviewing''': The registrant data has been submitted and being reviewed by compliance team.\n*'''Pending''': The verification process has been inititated, and verification email will be sent.\n*'''Suspended''': The registrant has failed verification and the domain has been suspended.\n*'''Verified''': The registrant has been validated.\n*'''Verifying''': The verification process has been initiated and is waiting for registrant response.\n*'''Unverified''': The verification process has not been inititated.\n\n", - "properties": { - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "The description of the registrant verification status." - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier of the registrant verification status" - }, - "keyName": { - "name": "keyName", - "type": "string", - "form": "local", - "doc": "The unique keyname of the registrant verification status." - }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "The name of the registrant verification status." - } - }, - "deprecated": true - }, - "SoftLayer_Dns_Domain_Registration_Status": { - "name": "SoftLayer_Dns_Domain_Registration_Status", - "base": "SoftLayer_Entity", - "methods": { - "getAllObjects": { - "name": "getAllObjects", - "type": "SoftLayer_Dns_Domain_Registration_Status", - "typeArray": true, - "static": true, - "filterable": true, - "maskable": true - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Dns_Domain_Registration_Status", - "docOverview": "Retrieve a SoftLayer_Dns_Domain_Registration_Status record.", - "filterable": true, - "maskable": true - } - }, - "typeDoc": "[DEPRECATED] SoftLayer_Dns_Domain_Registration_Status models the state of domain name. Here are the following status codes: \n\n\n*'''Active''': This domain name is active.\n*'''Pending Owner Approval''': Pending owner approval for completion of transfer.\n*'''Pending Admin Review''': Pending admin review for transfer.\n*'''Pending Registry''': Pending registry for transfer.\n*'''Expired''': Domain name has expired.\n\n", - "properties": { - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "The description of the domain registration status names." - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier of the domain registration status" - }, - "keyName": { - "name": "keyName", - "type": "string", - "form": "local", - "doc": "The unique keyname of the domain registration status." - }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "The name of the domain registration status." - } - }, - "deprecated": true - }, "SoftLayer_Dns_Domain_ResourceRecord": { "name": "SoftLayer_Dns_Domain_ResourceRecord", "base": "SoftLayer_Entity", @@ -126583,7 +126945,7 @@ "SoftLayer_Network_CdnMarketplace_Vendor": { "name": "SoftLayer_Network_CdnMarketplace_Vendor", "base": "SoftLayer_Entity", - "serviceDoc": "This service allows internal users to create, read, update, and delete\u2028 vendor instances. ", + "serviceDoc": "This service allows internal users to create, read, update, and delete vendor instances. ", "methods": { "getObject": { "name": "getObject", @@ -126600,7 +126962,7 @@ "static": true } }, - "typeDoc": "The SoftLayer_Network_CdnMarketplace_Vendor contains information regarding\u2028 a CDN Vendor. This class is associated with\u2028 SoftLayer_Network_CdnMarketplace_Vendor_Attribute class.\u2028 ", + "typeDoc": "The SoftLayer_Network_CdnMarketplace_Vendor contains information regarding a CDN Vendor. This class is associated with SoftLayer_Network_CdnMarketplace_Vendor_Attribute class. ", "properties": {} }, "SoftLayer_Network_Component": { @@ -176861,19 +177223,20 @@ "SoftLayer_Network_Subnet_Registration": { "name": "SoftLayer_Network_Subnet_Registration", "base": "SoftLayer_Entity", - "serviceDoc": "Subnet registration objects are used to request and track registration of the subnet with the appropriate Regional Internet Registry (RIR). Registration for public subnets can be requested any time after assignment of the subnet. \n\nSubnet Registration objects can be updated any time after they are created. This will result in the information being submitted to the RIR and the records on their end being refreshed. ", + "serviceDoc": "The subnet registration service has been deprecated. \n\nSubnet registration objects are used to request and track registration of the subnet with the appropriate Regional Internet Registry (RIR). Registration for public subnets can be requested any time after assignment of the subnet. \n\nSubnet Registration objects can be updated any time after they are created. This will result in the information being submitted to the RIR and the records on their end being refreshed. ", "methods": { "clearRegistration": { "name": "clearRegistration", "type": "boolean", - "doc": "This method will initiate the removal of a subnet registration. ", - "docOverview": "Clear an existing registration" + "doc": "The subnet registration service has been deprecated. \n\nThis method will initiate the removal of a subnet registration. ", + "docOverview": "[Deprecated] Clear an existing registration", + "deprecated": true }, "createObject": { "name": "createObject", "type": "SoftLayer_Network_Subnet_Registration", - "doc": "Create registration with a global registrar to associate an assigned subnet with the provided contact details. \n\nContact information is provided in the form of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). \n\nThe same applies to [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration. \n\nA template containing the following properties will create a subnet registration: \n\n\n* networkIdentifier\n* cidr\n* detailReferences\n\n\n``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects. ", - "docOverview": "Create a new subnet registration", + "doc": "The subnet registration service has been deprecated. \n\nCreate registration with a global registrar to associate an assigned subnet with the provided contact details. \n\nContact information is provided in the form of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). \n\nThe same applies to [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration. \n\nA template containing the following properties will create a subnet registration: \n\n\n* networkIdentifier\n* cidr\n* detailReferences\n\n\n``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects. ", + "docOverview": "[Deprecated] Create a new subnet registration", "docErrorHandling": [ { "exception": "SoftLayer_Exception_AlreadyExists", @@ -176908,6 +177271,7 @@ ], "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -176920,8 +177284,8 @@ "name": "createObjects", "type": "SoftLayer_Network_Subnet_Registration", "typeArray": true, - "doc": "Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details. ", - "docOverview": "Create registrations for multiple subnets", + "doc": "The subnet registration service has been deprecated. \n\nCreate registrations with respective registrars to associate multiple assigned subnets with the provided contact details. ", + "docOverview": "[Deprecated] Create registrations for multiple subnets", "docAssociatedMethods": [ { "service": "SoftLayer_Network_Subnet_Registration", @@ -176930,6 +177294,7 @@ ], "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObjects", @@ -176942,8 +177307,9 @@ "editObject": { "name": "editObject", "type": "boolean", - "doc": "This method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2). ", - "docOverview": "Edit an existing registration object", + "doc": "The subnet registration service has been deprecated. \n\nThis method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2). ", + "docOverview": "[Deprecated] Edit an existing registration object", + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -176955,9 +177321,10 @@ "editRegistrationAttachedDetails": { "name": "editRegistrationAttachedDetails", "type": "boolean", - "doc": "This method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration. ", - "docOverview": "Modify the link between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and two [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects simultaneously. ", + "doc": "The subnet registration service has been deprecated. \n\nThis method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration. ", + "docOverview": "[Deprecated] Modify the link between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and two [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects simultaneously. ", "static": true, + "deprecated": true, "parameters": [ { "name": "personObjectSkeleton", @@ -176977,7 +177344,7 @@ "maskable": true }, "getAccount": { - "doc": "The account that this registration belongs to.", + "doc": "[Deprecated] The account that this registration belongs to.", "docOverview": "", "name": "getAccount", "type": "SoftLayer_Account", @@ -176985,10 +177352,10 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true }, "getDetailReferences": { - "doc": "The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object.", + "doc": "[Deprecated] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object.", "docOverview": "", "name": "getDetailReferences", "type": "SoftLayer_Network_Subnet_Registration_Details", @@ -176996,11 +177363,11 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, + "deprecated": true, "limitable": true }, "getEvents": { - "doc": "The related registration events.", + "doc": "[Deprecated] The related registration events.", "docOverview": "", "name": "getEvents", "type": "SoftLayer_Network_Subnet_Registration_Event", @@ -177008,11 +177375,11 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, + "deprecated": true, "limitable": true }, "getNetworkDetail": { - "doc": "The \"network\" detail object.", + "doc": "[Deprecated] The \"network\" detail object.", "docOverview": "", "name": "getNetworkDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", @@ -177020,10 +177387,10 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true }, "getPersonDetail": { - "doc": "The \"person\" detail object.", + "doc": "[Deprecated] The \"person\" detail object.", "docOverview": "", "name": "getPersonDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", @@ -177031,10 +177398,10 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true }, "getRegionalInternetRegistry": { - "doc": "The related Regional Internet Registry.", + "doc": "[Deprecated] The related Regional Internet Registry.", "docOverview": "", "name": "getRegionalInternetRegistry", "type": "SoftLayer_Network_Regional_Internet_Registry", @@ -177042,10 +177409,10 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true }, "getRegionalInternetRegistryHandle": { - "doc": "The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.", + "doc": "[Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.", "docOverview": "", "name": "getRegionalInternetRegistryHandle", "type": "SoftLayer_Account_Rwhois_Handle", @@ -177053,10 +177420,10 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true }, "getStatus": { - "doc": "The status of this registration.", + "doc": "[Deprecated] The status of this registration.", "docOverview": "", "name": "getStatus", "type": "SoftLayer_Network_Subnet_Registration_Status", @@ -177064,10 +177431,10 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true }, "getSubnet": { - "doc": "The subnet that this registration pertains to.", + "doc": "[Deprecated] The subnet that this registration pertains to.", "docOverview": "", "name": "getSubnet", "type": "SoftLayer_Network_Subnet", @@ -177075,66 +177442,75 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true } }, - "typeDoc": "The subnet registration data type contains general information relating to a single subnet registration instance. These registration instances can be updated to reflect changes, and will record the changes in the [SoftLayer_Network_Subnet_Registration_Event](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event). ", + "typeDoc": "The subnet registration service has been deprecated. \n\nThe subnet registration data type contains general information relating to a single subnet registration instance. These registration instances can be updated to reflect changes, and will record the changes in the [SoftLayer_Network_Subnet_Registration_Event](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event). ", "properties": { "account": { "name": "account", "type": "SoftLayer_Account", "form": "relational", - "doc": "The account that this registration belongs to." + "doc": "[Deprecated] The account that this registration belongs to.", + "deprecated": true }, "detailReferences": { "name": "detailReferences", "type": "SoftLayer_Network_Subnet_Registration_Details", "form": "relational", "typeArray": true, - "doc": "The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." + "doc": "[Deprecated] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object.", + "deprecated": true }, "events": { "name": "events", "type": "SoftLayer_Network_Subnet_Registration_Event", "form": "relational", "typeArray": true, - "doc": "The related registration events." + "doc": "[Deprecated] The related registration events.", + "deprecated": true }, "networkDetail": { "name": "networkDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "doc": "The \"network\" detail object." + "doc": "[Deprecated] The \"network\" detail object.", + "deprecated": true }, "personDetail": { "name": "personDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "doc": "The \"person\" detail object." + "doc": "[Deprecated] The \"person\" detail object.", + "deprecated": true }, "regionalInternetRegistry": { "name": "regionalInternetRegistry", "type": "SoftLayer_Network_Regional_Internet_Registry", "form": "relational", - "doc": "The related Regional Internet Registry." + "doc": "[Deprecated] The related Regional Internet Registry.", + "deprecated": true }, "regionalInternetRegistryHandle": { "name": "regionalInternetRegistryHandle", "type": "SoftLayer_Account_Rwhois_Handle", "form": "relational", - "doc": "The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete." + "doc": "[Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.", + "deprecated": true }, "status": { "name": "status", "type": "SoftLayer_Network_Subnet_Registration_Status", "form": "relational", - "doc": "The status of this registration." + "doc": "[Deprecated] The status of this registration.", + "deprecated": true }, "subnet": { "name": "subnet", "type": "SoftLayer_Network_Subnet", "form": "relational", - "doc": "The subnet that this registration pertains to." + "doc": "[Deprecated] The subnet that this registration pertains to.", + "deprecated": true }, "accountId": { "name": "accountId", @@ -177198,33 +177574,36 @@ "name": "detailReferenceCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." + "doc": "A count of [Deprecated] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." }, "eventCount": { "name": "eventCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the related registration events." + "doc": "A count of [Deprecated] The related registration events." } - } + }, + "deprecated": true }, "SoftLayer_Network_Subnet_Registration_Apnic": { "name": "SoftLayer_Network_Subnet_Registration_Apnic", "base": "SoftLayer_Network_Subnet_Registration", "noservice": true, - "typeDoc": "APNIC-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). ", + "typeDoc": "The APNIC subnet registration type has been deprecated. \n\nAPNIC-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). ", + "deprecated": true, "methods": { "clearRegistration": { "name": "clearRegistration", "type": "boolean", - "doc": "This method will initiate the removal of a subnet registration. ", - "docOverview": "Clear an existing registration" + "doc": "The subnet registration service has been deprecated. \n\nThis method will initiate the removal of a subnet registration. ", + "docOverview": "[Deprecated] Clear an existing registration", + "deprecated": true }, "createObject": { "name": "createObject", "type": "SoftLayer_Network_Subnet_Registration", - "doc": "Create registration with a global registrar to associate an assigned subnet with the provided contact details. \n\nContact information is provided in the form of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). \n\nThe same applies to [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration. \n\nA template containing the following properties will create a subnet registration: \n\n\n* networkIdentifier\n* cidr\n* detailReferences\n\n\n``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects. ", - "docOverview": "Create a new subnet registration", + "doc": "The subnet registration service has been deprecated. \n\nCreate registration with a global registrar to associate an assigned subnet with the provided contact details. \n\nContact information is provided in the form of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). \n\nThe same applies to [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration. \n\nA template containing the following properties will create a subnet registration: \n\n\n* networkIdentifier\n* cidr\n* detailReferences\n\n\n``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects. ", + "docOverview": "[Deprecated] Create a new subnet registration", "docErrorHandling": [ { "exception": "SoftLayer_Exception_AlreadyExists", @@ -177259,6 +177638,7 @@ ], "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -177271,8 +177651,8 @@ "name": "createObjects", "type": "SoftLayer_Network_Subnet_Registration", "typeArray": true, - "doc": "Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details. ", - "docOverview": "Create registrations for multiple subnets", + "doc": "The subnet registration service has been deprecated. \n\nCreate registrations with respective registrars to associate multiple assigned subnets with the provided contact details. ", + "docOverview": "[Deprecated] Create registrations for multiple subnets", "docAssociatedMethods": [ { "service": "SoftLayer_Network_Subnet_Registration", @@ -177281,6 +177661,7 @@ ], "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObjects", @@ -177293,8 +177674,9 @@ "editObject": { "name": "editObject", "type": "boolean", - "doc": "This method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2). ", - "docOverview": "Edit an existing registration object", + "doc": "The subnet registration service has been deprecated. \n\nThis method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2). ", + "docOverview": "[Deprecated] Edit an existing registration object", + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -177306,9 +177688,10 @@ "editRegistrationAttachedDetails": { "name": "editRegistrationAttachedDetails", "type": "boolean", - "doc": "This method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration. ", - "docOverview": "Modify the link between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and two [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects simultaneously. ", + "doc": "The subnet registration service has been deprecated. \n\nThis method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration. ", + "docOverview": "[Deprecated] Modify the link between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and two [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects simultaneously. ", "static": true, + "deprecated": true, "parameters": [ { "name": "personObjectSkeleton", @@ -177333,57 +177716,66 @@ "name": "account", "type": "SoftLayer_Account", "form": "relational", - "doc": "The account that this registration belongs to." + "doc": "[Deprecated] The account that this registration belongs to.", + "deprecated": true }, "detailReferences": { "name": "detailReferences", "type": "SoftLayer_Network_Subnet_Registration_Details", "form": "relational", "typeArray": true, - "doc": "The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." + "doc": "[Deprecated] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object.", + "deprecated": true }, "events": { "name": "events", "type": "SoftLayer_Network_Subnet_Registration_Event", "form": "relational", "typeArray": true, - "doc": "The related registration events." + "doc": "[Deprecated] The related registration events.", + "deprecated": true }, "networkDetail": { "name": "networkDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "doc": "The \"network\" detail object." + "doc": "[Deprecated] The \"network\" detail object.", + "deprecated": true }, "personDetail": { "name": "personDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "doc": "The \"person\" detail object." + "doc": "[Deprecated] The \"person\" detail object.", + "deprecated": true }, "regionalInternetRegistry": { "name": "regionalInternetRegistry", "type": "SoftLayer_Network_Regional_Internet_Registry", "form": "relational", - "doc": "The related Regional Internet Registry." + "doc": "[Deprecated] The related Regional Internet Registry.", + "deprecated": true }, "regionalInternetRegistryHandle": { "name": "regionalInternetRegistryHandle", "type": "SoftLayer_Account_Rwhois_Handle", "form": "relational", - "doc": "The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete." + "doc": "[Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.", + "deprecated": true }, "status": { "name": "status", "type": "SoftLayer_Network_Subnet_Registration_Status", "form": "relational", - "doc": "The status of this registration." + "doc": "[Deprecated] The status of this registration.", + "deprecated": true }, "subnet": { "name": "subnet", "type": "SoftLayer_Network_Subnet", "form": "relational", - "doc": "The subnet that this registration pertains to." + "doc": "[Deprecated] The subnet that this registration pertains to.", + "deprecated": true }, "accountId": { "name": "accountId", @@ -177447,13 +177839,13 @@ "name": "detailReferenceCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." + "doc": "A count of [Deprecated] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." }, "eventCount": { "name": "eventCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the related registration events." + "doc": "A count of [Deprecated] The related registration events." } } }, @@ -177461,19 +177853,21 @@ "name": "SoftLayer_Network_Subnet_Registration_Arin", "base": "SoftLayer_Network_Subnet_Registration", "noservice": true, - "typeDoc": "ARIN-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). ", + "typeDoc": "The ARIN subnet registration type has been deprecated. \n\nARIN-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). ", + "deprecated": true, "methods": { "clearRegistration": { "name": "clearRegistration", "type": "boolean", - "doc": "This method will initiate the removal of a subnet registration. ", - "docOverview": "Clear an existing registration" + "doc": "The subnet registration service has been deprecated. \n\nThis method will initiate the removal of a subnet registration. ", + "docOverview": "[Deprecated] Clear an existing registration", + "deprecated": true }, "createObject": { "name": "createObject", "type": "SoftLayer_Network_Subnet_Registration", - "doc": "Create registration with a global registrar to associate an assigned subnet with the provided contact details. \n\nContact information is provided in the form of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). \n\nThe same applies to [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration. \n\nA template containing the following properties will create a subnet registration: \n\n\n* networkIdentifier\n* cidr\n* detailReferences\n\n\n``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects. ", - "docOverview": "Create a new subnet registration", + "doc": "The subnet registration service has been deprecated. \n\nCreate registration with a global registrar to associate an assigned subnet with the provided contact details. \n\nContact information is provided in the form of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). \n\nThe same applies to [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration. \n\nA template containing the following properties will create a subnet registration: \n\n\n* networkIdentifier\n* cidr\n* detailReferences\n\n\n``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects. ", + "docOverview": "[Deprecated] Create a new subnet registration", "docErrorHandling": [ { "exception": "SoftLayer_Exception_AlreadyExists", @@ -177508,6 +177902,7 @@ ], "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -177520,8 +177915,8 @@ "name": "createObjects", "type": "SoftLayer_Network_Subnet_Registration", "typeArray": true, - "doc": "Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details. ", - "docOverview": "Create registrations for multiple subnets", + "doc": "The subnet registration service has been deprecated. \n\nCreate registrations with respective registrars to associate multiple assigned subnets with the provided contact details. ", + "docOverview": "[Deprecated] Create registrations for multiple subnets", "docAssociatedMethods": [ { "service": "SoftLayer_Network_Subnet_Registration", @@ -177530,6 +177925,7 @@ ], "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObjects", @@ -177542,8 +177938,9 @@ "editObject": { "name": "editObject", "type": "boolean", - "doc": "This method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2). ", - "docOverview": "Edit an existing registration object", + "doc": "The subnet registration service has been deprecated. \n\nThis method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2). ", + "docOverview": "[Deprecated] Edit an existing registration object", + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -177555,9 +177952,10 @@ "editRegistrationAttachedDetails": { "name": "editRegistrationAttachedDetails", "type": "boolean", - "doc": "This method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration. ", - "docOverview": "Modify the link between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and two [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects simultaneously. ", + "doc": "The subnet registration service has been deprecated. \n\nThis method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration. ", + "docOverview": "[Deprecated] Modify the link between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and two [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects simultaneously. ", "static": true, + "deprecated": true, "parameters": [ { "name": "personObjectSkeleton", @@ -177582,57 +177980,66 @@ "name": "account", "type": "SoftLayer_Account", "form": "relational", - "doc": "The account that this registration belongs to." + "doc": "[Deprecated] The account that this registration belongs to.", + "deprecated": true }, "detailReferences": { "name": "detailReferences", "type": "SoftLayer_Network_Subnet_Registration_Details", "form": "relational", "typeArray": true, - "doc": "The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." + "doc": "[Deprecated] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object.", + "deprecated": true }, "events": { "name": "events", "type": "SoftLayer_Network_Subnet_Registration_Event", "form": "relational", "typeArray": true, - "doc": "The related registration events." + "doc": "[Deprecated] The related registration events.", + "deprecated": true }, "networkDetail": { "name": "networkDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "doc": "The \"network\" detail object." + "doc": "[Deprecated] The \"network\" detail object.", + "deprecated": true }, "personDetail": { "name": "personDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "doc": "The \"person\" detail object." + "doc": "[Deprecated] The \"person\" detail object.", + "deprecated": true }, "regionalInternetRegistry": { "name": "regionalInternetRegistry", "type": "SoftLayer_Network_Regional_Internet_Registry", "form": "relational", - "doc": "The related Regional Internet Registry." + "doc": "[Deprecated] The related Regional Internet Registry.", + "deprecated": true }, "regionalInternetRegistryHandle": { "name": "regionalInternetRegistryHandle", "type": "SoftLayer_Account_Rwhois_Handle", "form": "relational", - "doc": "The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete." + "doc": "[Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.", + "deprecated": true }, "status": { "name": "status", "type": "SoftLayer_Network_Subnet_Registration_Status", "form": "relational", - "doc": "The status of this registration." + "doc": "[Deprecated] The status of this registration.", + "deprecated": true }, "subnet": { "name": "subnet", "type": "SoftLayer_Network_Subnet", "form": "relational", - "doc": "The subnet that this registration pertains to." + "doc": "[Deprecated] The subnet that this registration pertains to.", + "deprecated": true }, "accountId": { "name": "accountId", @@ -177696,13 +178103,13 @@ "name": "detailReferenceCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." + "doc": "A count of [Deprecated] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." }, "eventCount": { "name": "eventCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the related registration events." + "doc": "A count of [Deprecated] The related registration events." } } }, @@ -177713,10 +178120,11 @@ "createObject": { "name": "createObject", "type": "SoftLayer_Network_Subnet_Registration_Details", - "doc": " This method will create a new SoftLayer_Network_Subnet_Registration_Details object. \n\nInput - [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) ", - "docOverview": "Create a new association between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object. ", + "doc": "The subnet registration details service has been deprecated. \n\n This method will create a new SoftLayer_Network_Subnet_Registration_Details object. \n\nInput - [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) ", + "docOverview": "[Deprecated] Create a new association between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object. ", "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -177728,8 +178136,9 @@ "deleteObject": { "name": "deleteObject", "type": "boolean", - "doc": "This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. ", - "docOverview": "Remove an existing association between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object. " + "doc": "The subnet registration details service has been deprecated. \n\nThis method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. ", + "docOverview": "[Deprecated] Remove an existing association between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object. ", + "deprecated": true }, "getObject": { "name": "getObject", @@ -177739,7 +178148,7 @@ "maskable": true }, "getDetail": { - "doc": "The related [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail).", + "doc": "[Deprecated] The related [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail).", "docOverview": "", "name": "getDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", @@ -177747,10 +178156,10 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true }, "getRegistration": { - "doc": "The related [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration).", + "doc": "[Deprecated] The related [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration).", "docOverview": "", "name": "getRegistration", "type": "SoftLayer_Network_Subnet_Registration", @@ -177758,22 +178167,24 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": true } }, - "typeDoc": "The SoftLayer_Network_Subnet_Registration_Details objects are used to relate [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object. This allows for easy reuse of registration details. It is important to note that only one detail object per type may be associated to a registration object. ", + "typeDoc": "The subnet registration details type has been deprecated. \n\nThe SoftLayer_Network_Subnet_Registration_Details objects are used to relate [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object. This allows for easy reuse of registration details. It is important to note that only one detail object per type may be associated to a registration object. ", "properties": { "detail": { "name": "detail", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "doc": "The related [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail)." + "doc": "[Deprecated] The related [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail).", + "deprecated": true }, "registration": { "name": "registration", "type": "SoftLayer_Network_Subnet_Registration", "form": "relational", - "doc": "The related [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration)." + "doc": "[Deprecated] The related [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration).", + "deprecated": true }, "createDate": { "name": "createDate", @@ -177803,25 +178214,28 @@ "form": "local", "doc": "Numeric ID of the related [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object " } - } + }, + "deprecated": true }, "SoftLayer_Network_Subnet_Registration_Event": { "name": "SoftLayer_Network_Subnet_Registration_Event", "base": "SoftLayer_Entity", "noservice": true, - "typeDoc": "Each time a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object is created or modified, the system will generate an event for it. Additional actions that would create an event include RIR responses and error cases. * ", + "typeDoc": "The subnet registration event type has been deprecated. \n\nEach time a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object is created or modified, the system will generate an event for it. Additional actions that would create an event include RIR responses and error cases. * ", "properties": { "registration": { "name": "registration", "type": "SoftLayer_Network_Subnet_Registration", "form": "relational", - "doc": "The registration this event pertains to." + "doc": "[Deprecated] The registration this event pertains to.", + "deprecated": true }, "type": { "name": "type", "type": "SoftLayer_Network_Subnet_Registration_Event_Type", "form": "relational", - "doc": "The type of this event." + "doc": "[Deprecated] The type of this event.", + "deprecated": true }, "createDate": { "name": "createDate", @@ -177858,13 +178272,14 @@ "doc": "The numeric ID of the associated [SoftLayer_Network_Subnet_Registration_Event_Type](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type) object " } }, + "deprecated": true, "methods": {} }, "SoftLayer_Network_Subnet_Registration_Event_Type": { "name": "SoftLayer_Network_Subnet_Registration_Event_Type", "base": "SoftLayer_Entity", "noservice": true, - "typeDoc": "Subnet Registration Event Type objects describe the nature of a [SoftLayer_Network_Subnet_Registration_Event](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event) \n\nThe standard values for these objects are as follows: ", + "typeDoc": "The subnet registration event type type has been deprecated. \n\nSubnet Registration Event Type objects describe the nature of a [SoftLayer_Network_Subnet_Registration_Event](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event) \n\nThe standard values for these objects are as follows: ", "properties": { "createDate": { "name": "createDate", @@ -177897,25 +178312,28 @@ "doc": "Human-readable name of the event type " } }, + "deprecated": true, "methods": {} }, "SoftLayer_Network_Subnet_Registration_Ripe": { "name": "SoftLayer_Network_Subnet_Registration_Ripe", "base": "SoftLayer_Network_Subnet_Registration", "noservice": true, - "typeDoc": "RIPE-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). ", + "typeDoc": "The RIPE subnet registration type has been deprecated. \n\nRIPE-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration). ", + "deprecated": true, "methods": { "clearRegistration": { "name": "clearRegistration", "type": "boolean", - "doc": "This method will initiate the removal of a subnet registration. ", - "docOverview": "Clear an existing registration" + "doc": "The subnet registration service has been deprecated. \n\nThis method will initiate the removal of a subnet registration. ", + "docOverview": "[Deprecated] Clear an existing registration", + "deprecated": true }, "createObject": { "name": "createObject", "type": "SoftLayer_Network_Subnet_Registration", - "doc": "Create registration with a global registrar to associate an assigned subnet with the provided contact details. \n\nContact information is provided in the form of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). \n\nThe same applies to [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration. \n\nA template containing the following properties will create a subnet registration: \n\n\n* networkIdentifier\n* cidr\n* detailReferences\n\n\n``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects. ", - "docOverview": "Create a new subnet registration", + "doc": "The subnet registration service has been deprecated. \n\nCreate registration with a global registrar to associate an assigned subnet with the provided contact details. \n\nContact information is provided in the form of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). \n\nThe same applies to [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration. \n\nA template containing the following properties will create a subnet registration: \n\n\n* networkIdentifier\n* cidr\n* detailReferences\n\n\n``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects. ", + "docOverview": "[Deprecated] Create a new subnet registration", "docErrorHandling": [ { "exception": "SoftLayer_Exception_AlreadyExists", @@ -177950,6 +178368,7 @@ ], "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -177962,8 +178381,8 @@ "name": "createObjects", "type": "SoftLayer_Network_Subnet_Registration", "typeArray": true, - "doc": "Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details. ", - "docOverview": "Create registrations for multiple subnets", + "doc": "The subnet registration service has been deprecated. \n\nCreate registrations with respective registrars to associate multiple assigned subnets with the provided contact details. ", + "docOverview": "[Deprecated] Create registrations for multiple subnets", "docAssociatedMethods": [ { "service": "SoftLayer_Network_Subnet_Registration", @@ -177972,6 +178391,7 @@ ], "static": true, "maskable": true, + "deprecated": true, "parameters": [ { "name": "templateObjects", @@ -177984,8 +178404,9 @@ "editObject": { "name": "editObject", "type": "boolean", - "doc": "This method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2). ", - "docOverview": "Edit an existing registration object", + "doc": "The subnet registration service has been deprecated. \n\nThis method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2). ", + "docOverview": "[Deprecated] Edit an existing registration object", + "deprecated": true, "parameters": [ { "name": "templateObject", @@ -177997,9 +178418,10 @@ "editRegistrationAttachedDetails": { "name": "editRegistrationAttachedDetails", "type": "boolean", - "doc": "This method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration. ", - "docOverview": "Modify the link between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and two [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects simultaneously. ", + "doc": "The subnet registration service has been deprecated. \n\nThis method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration. ", + "docOverview": "[Deprecated] Modify the link between a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and two [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects simultaneously. ", "static": true, + "deprecated": true, "parameters": [ { "name": "personObjectSkeleton", @@ -178024,57 +178446,66 @@ "name": "account", "type": "SoftLayer_Account", "form": "relational", - "doc": "The account that this registration belongs to." + "doc": "[Deprecated] The account that this registration belongs to.", + "deprecated": true }, "detailReferences": { "name": "detailReferences", "type": "SoftLayer_Network_Subnet_Registration_Details", "form": "relational", "typeArray": true, - "doc": "The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." + "doc": "[Deprecated] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object.", + "deprecated": true }, "events": { "name": "events", "type": "SoftLayer_Network_Subnet_Registration_Event", "form": "relational", "typeArray": true, - "doc": "The related registration events." + "doc": "[Deprecated] The related registration events.", + "deprecated": true }, "networkDetail": { "name": "networkDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "doc": "The \"network\" detail object." + "doc": "[Deprecated] The \"network\" detail object.", + "deprecated": true }, "personDetail": { "name": "personDetail", "type": "SoftLayer_Account_Regional_Registry_Detail", "form": "relational", - "doc": "The \"person\" detail object." + "doc": "[Deprecated] The \"person\" detail object.", + "deprecated": true }, "regionalInternetRegistry": { "name": "regionalInternetRegistry", "type": "SoftLayer_Network_Regional_Internet_Registry", "form": "relational", - "doc": "The related Regional Internet Registry." + "doc": "[Deprecated] The related Regional Internet Registry.", + "deprecated": true }, "regionalInternetRegistryHandle": { "name": "regionalInternetRegistryHandle", "type": "SoftLayer_Account_Rwhois_Handle", "form": "relational", - "doc": "The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete." + "doc": "[Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.", + "deprecated": true }, "status": { "name": "status", "type": "SoftLayer_Network_Subnet_Registration_Status", "form": "relational", - "doc": "The status of this registration." + "doc": "[Deprecated] The status of this registration.", + "deprecated": true }, "subnet": { "name": "subnet", "type": "SoftLayer_Network_Subnet", "form": "relational", - "doc": "The subnet that this registration pertains to." + "doc": "[Deprecated] The subnet that this registration pertains to.", + "deprecated": true }, "accountId": { "name": "accountId", @@ -178138,13 +178569,13 @@ "name": "detailReferenceCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." + "doc": "A count of [Deprecated] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object." }, "eventCount": { "name": "eventCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the related registration events." + "doc": "A count of [Deprecated] The related registration events." } } }, @@ -178159,7 +178590,8 @@ "static": true, "limitable": true, "filterable": true, - "maskable": true + "maskable": true, + "deprecated": true }, "getObject": { "name": "getObject", @@ -178169,7 +178601,7 @@ "maskable": true } }, - "typeDoc": "Subnet Registration Status objects describe the current status of a subnet registration. \n\nThe standard values for these objects are as follows: ", + "typeDoc": "The subnet registration status type has been deprecated. \n\nSubnet Registration Status objects describe the current status of a subnet registration. \n\nThe standard values for these objects are as follows: ", "properties": { "createDate": { "name": "createDate", @@ -178201,7 +178633,8 @@ "form": "local", "doc": "Human-readable name of the status " } - } + }, + "deprecated": true }, "SoftLayer_Network_Subnet_Rwhois_Data": { "name": "SoftLayer_Network_Subnet_Rwhois_Data", @@ -187511,7 +187944,7 @@ "placeOrder": { "name": "placeOrder", "type": "SoftLayer_Container_Product_Order_Receipt", - "doc": "\nUse this method to place bare metal server, virtual server and additional service orders with SoftLayer. \nUpon success, your credit card or PayPal account will incur charges for the monthly order total \n(or prorated value if ordered mid billing cycle). If all products on the order are only billed hourly, \nyou will be charged on your billing anniversary date, which occurs monthly on the day you ordered your first \nservice with SoftLayer. For new customers, you are required to provide billing information when you place an order. \nFor existing customers, the credit card on file will be charged. If you're a PayPal customer, a URL will be \nreturned from the call to [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder) which is to be used to finish the authorization \nprocess. This authorization tells PayPal that you indeed want to place an order with SoftLayer. \nFrom PayPal's web site, you will be redirected back to SoftLayer for your order receipt. \n\n\nWhen an order is placed, your order will be in a \"pending approval\" state. When all internal checks pass, \nyour order will be automatically approved. For orders that may need extra attention, a Sales representative \nwill review the order and contact you if necessary. Once the order is approved, your server or service will \nbe provisioned and available to you shortly thereafter. Depending on the type of server or service ordered, \nprovisioning times will vary. \n\n\n## Order Containers\n\n\n\nWhen placing API orders, it's important to order your server and services on the appropriate \n[SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order). Failing to provide the correct container may delay your server or service \nfrom being provisioned in a timely manner. Some common order containers are included below. \n\n\n**Note:** `SoftLayer_Container_Product_Order_` has been removed from the containers in the table below for readability.\n\n\n| Product | Order Container | Package Type |\n| ------- | --------------- | ------------ |\n| Bare metal server by CPU | [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) | BARE_METAL_CPU |\n| Bare metal server by core | [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) | BARE_METAL_CORE |\n| Virtual server | [SoftLayer_Container_Product_Order_Virtual_Guest](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest) | VIRTUAL_SERVER_INSTANCE |\n| DNS domain registration | [SoftLayer_Container_Product_Order_Dns_Domain_Registrationn](/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registrationn) | ADDITIONAL_SERVICES |\n| Local & dedicated load balancers | [SoftLayer_Container_Product_Order_Network_LoadBalancer](/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer) | ADDITIONAL_SERVICES_LOAD_BALANCER |\n| Content delivery network | [SoftLayer_Container_Product_Order_Network_ContentDelivery_Account](/reference/datatypes/SoftLayer_Container_Product_Order_Network_ContentDelivery_Account) | ADDITIONAL_SERVICES_CDN |\n| Content delivery network Addon | [SoftLayer_Container_Product_Order_Network_ContentDelivery_Account_Addon](/reference/datatypes/SoftLayer_Container_Product_Order_Network_ContentDelivery_Account_Addon) | ADDITIONAL_SERVICES_CDN_ADDON |\n| Hardware & software firewalls | [SoftLayer_Container_Product_Order_Network_Protection_Firewall](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall) | ADDITIONAL_SERVICES_FIREWALL |\n| Dedicated firewall | [SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated) | ADDITIONAL_SERVICES_FIREWALL |\n| Object storage | [SoftLayer_Container_Product_Order_Network_Storage_Object](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Object) | ADDITIONAL_SERVICES_OBJECT_STORAGE |\n| Object storage (hub) | [SoftLayer_Container_Product_Order_Network_Storage_Hub](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub) | ADDITIONAL_SERVICES_OBJECT_STORAGE |\n| Network attached storage | [SoftLayer_Container_Product_Order_Network_Storage_Nas](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Nas) | ADDITIONAL_SERVICES_NETWORK_ATTACHED_STORAGE |\n| Iscsi storage | [SoftLayer_Container_Product_Order_Network_Storage_Iscsi](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi) | ADDITIONAL_SERVICES_ISCSI_STORAGE |\n| Evault | [SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault) | ADDITIONAL_SERVICES |\n| Evault Plugin | [SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin) | ADDITIONAL_SERVICES |\n| Application delivery appliance | [SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller) | ADDITIONAL_SERVICES_APPLICATION_DELIVERY_APPLIANCE |\n| Network subnet | [SoftLayer_Container_Product_Order_Network_Subnet](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet) | ADDITIONAL_SERVICES |\n| Global IPv4 | [SoftLayer_Container_Product_Order_Network_Subnet](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet) | ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES |\n| Global IPv6 | [SoftLayer_Container_Product_Order_Network_Subnet](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet) | ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES |\n| Network VLAN | [SoftLayer_Container_Product_Order_Network_Vlan](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlan) | ADDITIONAL_SERVICES_NETWORK_VLAN |\n| Portable storage | [SoftLayer_Container_Product_Order_Virtual_Disk_Image](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Disk_Image) | ADDITIONAL_SERVICES_PORTABLE_STORAGE |\n| SSL certificate | [SoftLayer_Container_Product_Order_Security_Certificate](/reference/datatypes/SoftLayer_Container_Product_Order_Security_Certificate) | ADDITIONAL_SERVICES_SSL_CERTIFICATE |\n| External authentication | [SoftLayer_Container_Product_Order_User_Customer_External_Binding](/reference/datatypes/SoftLayer_Container_Product_Order_User_Customer_External_Binding) | ADDITIONAL_SERVICES |\n| Dedicated Host | [SoftLayer_Container_Product_Order_Virtual_DedicatedHost](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_DedicatedHost) | DEDICATED_HOST |\n\n\n## Server example\n\n\n\nThis example includes a single bare metal server being ordered with monthly billing. \n\n\n**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the\n\navailable prices from the bare metal server [SoftLayer_Product_Package::getAllObjects](/reference/services/SoftLayer_Product_Package/getAllObjects), which have a \n[SoftLayer_Product_Package_Type](/reference/datatypes/SoftLayer_Product_Package_Type) of `BARE_METAL_CPU` or `BARE_METAL_CORE`. You can get a full list of \npackage types with [SoftLayer_Product_Package_Type::getAllObjects](/reference/services/SoftLayer_Product_Package_Type/getAllObjects). \n\n\n### Bare Metal Ordering\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n \n \n example.com \n server1 \n \n \n 138124 \n 142 \n \n \n 58 \n \n \n 22337 \n \n \n 21189 \n \n \n 876 \n \n \n 57 \n \n \n 55 \n \n \n 21190 \n \n \n 36381 \n \n \n 21 \n \n \n 22013 \n \n \n 906 \n \n \n 420 \n \n \n 418 \n \n \n 342 \n \n \n false \n \n \n \n \n \n``` \n\n\n## Virtual server example\n\n\n\nThis example includes 2 identical virtual servers (except for hostname) being ordered for hourly billing. \nIt includes an optional image template id and VLAN data specified on the virtualGuest objects - \n`primaryBackendNetworkComponent` and `primaryNetworkComponent`. \n\n\n**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the\n\navailable prices from the virtual server package with [SoftLayer_Product_Package::getAllObjects](/reference/services/SoftLayer_Product_Package/getAllObjects), \nwhich has a [SoftLayer_Product_Package_Type](/reference/datatypes/SoftLayer_Product_Package_Type) of `VIRTUAL_SERVER_INSTANCE`. \n\n\n#### Virtual Ordering\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n 13251 \n 37473 \n 46 \n \n \n 2159 \n \n \n 55 \n \n \n 13754 \n \n \n 1641 \n \n \n 905 \n \n \n 1800 \n \n \n 58 \n \n \n 21 \n \n \n 1645 \n \n \n 272 \n \n \n 57 \n \n \n 418 \n \n \n 420 \n \n \n 2 \n true \n \n \n example.com \n server1 \n \n \n 12345 \n \n \n \n \n 67890 \n \n \n \n \n example.com \n server2 \n \n \n 12345 \n \n \n \n \n 67890 \n \n \n \n \n \n \n \n \n \n``` \n\n\n## VLAN example\n\n\n**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the\n\navailable prices from the additional services pacakge with [SoftLayer_Product_Package::getAllObjects](/reference/services/SoftLayer_Product_Package/getAllObjects), \nwhich has a [SoftLayer_Product_Package_Type](/reference/datatypes/SoftLayer_Product_Package_Type) of `ADDITIONAL_SERVICES`. \nYou can get a full list of [SoftLayer_Product_Package_Type::getAllObjects](/reference/services/SoftLayer_Product_Package_Type/getAllObjects) to find other available additional \nservice packages.

\n\n\n### VLAN Ordering\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n 154820 \n 0 \n \n \n 2021 \n \n \n 2018 \n \n \n true \n \n \n \n \n \n``` \n\n\n## Multiple products example\n\n\n\nThis example includes a combination of the above examples in a single order. Note that all the configuration \noptions for each individual order container are the same as above, except now we encapsulate each one within \nthe `orderContainers` property on the base [SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order). \n\n\n**Warning:** not all products are available to be ordered with other products. For example, since\n\nSSL certificates require validation from a 3rd party, the approval process may take days or even weeks, \nand this would not be acceptable when you need your hourly virtual server right now. To better accommodate \ncustomers, we restrict several products to be ordered individually. \n\n\n### Bare metal server + virtual server + VLAN\n\n\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n \n \n ... \n \n \n ... \n \n \n ... \n \n \n \n \n \n \n \n``` \n\n", + "doc": "\nUse this method to place bare metal server, virtual server and additional service orders with SoftLayer. \nUpon success, your credit card or PayPal account will incur charges for the monthly order total \n(or prorated value if ordered mid billing cycle). If all products on the order are only billed hourly, \nyou will be charged on your billing anniversary date, which occurs monthly on the day you ordered your first \nservice with SoftLayer. For new customers, you are required to provide billing information when you place an order. \nFor existing customers, the credit card on file will be charged. If you're a PayPal customer, a URL will be \nreturned from the call to [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder) which is to be used to finish the authorization \nprocess. This authorization tells PayPal that you indeed want to place an order with SoftLayer. \nFrom PayPal's web site, you will be redirected back to SoftLayer for your order receipt. \n\n\nWhen an order is placed, your order will be in a \"pending approval\" state. When all internal checks pass, \nyour order will be automatically approved. For orders that may need extra attention, a Sales representative \nwill review the order and contact you if necessary. Once the order is approved, your server or service will \nbe provisioned and available to you shortly thereafter. Depending on the type of server or service ordered, \nprovisioning times will vary. \n\n\n## Order Containers\n\n\n\nWhen placing API orders, it's important to order your server and services on the appropriate \n[SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order). Failing to provide the correct container may delay your server or service \nfrom being provisioned in a timely manner. Some common order containers are included below. \n\n\n**Note:** `SoftLayer_Container_Product_Order_` has been removed from the containers in the table below for readability.\n\n\n| Product | Order Container | Package Type |\n| ------- | --------------- | ------------ |\n| Bare metal server by CPU | [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) | BARE_METAL_CPU |\n| Bare metal server by core | [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) | BARE_METAL_CORE |\n| Virtual server | [SoftLayer_Container_Product_Order_Virtual_Guest](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest) | VIRTUAL_SERVER_INSTANCE |\n| Local & dedicated load balancers | [SoftLayer_Container_Product_Order_Network_LoadBalancer](/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer) | ADDITIONAL_SERVICES_LOAD_BALANCER |\n| Content delivery network | [SoftLayer_Container_Product_Order_Network_ContentDelivery_Account](/reference/datatypes/SoftLayer_Container_Product_Order_Network_ContentDelivery_Account) | ADDITIONAL_SERVICES_CDN |\n| Content delivery network Addon | [SoftLayer_Container_Product_Order_Network_ContentDelivery_Account_Addon](/reference/datatypes/SoftLayer_Container_Product_Order_Network_ContentDelivery_Account_Addon) | ADDITIONAL_SERVICES_CDN_ADDON |\n| Hardware & software firewalls | [SoftLayer_Container_Product_Order_Network_Protection_Firewall](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall) | ADDITIONAL_SERVICES_FIREWALL |\n| Dedicated firewall | [SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated) | ADDITIONAL_SERVICES_FIREWALL |\n| Object storage | [SoftLayer_Container_Product_Order_Network_Storage_Object](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Object) | ADDITIONAL_SERVICES_OBJECT_STORAGE |\n| Object storage (hub) | [SoftLayer_Container_Product_Order_Network_Storage_Hub](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub) | ADDITIONAL_SERVICES_OBJECT_STORAGE |\n| Network attached storage | [SoftLayer_Container_Product_Order_Network_Storage_Nas](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Nas) | ADDITIONAL_SERVICES_NETWORK_ATTACHED_STORAGE |\n| Iscsi storage | [SoftLayer_Container_Product_Order_Network_Storage_Iscsi](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi) | ADDITIONAL_SERVICES_ISCSI_STORAGE |\n| Evault | [SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault) | ADDITIONAL_SERVICES |\n| Evault Plugin | [SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin) | ADDITIONAL_SERVICES |\n| Application delivery appliance | [SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller) | ADDITIONAL_SERVICES_APPLICATION_DELIVERY_APPLIANCE |\n| Network subnet | [SoftLayer_Container_Product_Order_Network_Subnet](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet) | ADDITIONAL_SERVICES |\n| Global IPv4 | [SoftLayer_Container_Product_Order_Network_Subnet](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet) | ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES |\n| Global IPv6 | [SoftLayer_Container_Product_Order_Network_Subnet](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet) | ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES |\n| Network VLAN | [SoftLayer_Container_Product_Order_Network_Vlan](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlan) | ADDITIONAL_SERVICES_NETWORK_VLAN |\n| Portable storage | [SoftLayer_Container_Product_Order_Virtual_Disk_Image](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Disk_Image) | ADDITIONAL_SERVICES_PORTABLE_STORAGE |\n| SSL certificate | [SoftLayer_Container_Product_Order_Security_Certificate](/reference/datatypes/SoftLayer_Container_Product_Order_Security_Certificate) | ADDITIONAL_SERVICES_SSL_CERTIFICATE |\n| External authentication | [SoftLayer_Container_Product_Order_User_Customer_External_Binding](/reference/datatypes/SoftLayer_Container_Product_Order_User_Customer_External_Binding) | ADDITIONAL_SERVICES |\n| Dedicated Host | [SoftLayer_Container_Product_Order_Virtual_DedicatedHost](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_DedicatedHost) | DEDICATED_HOST |\n\n\n## Server example\n\n\n\nThis example includes a single bare metal server being ordered with monthly billing. \n\n\n**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the\n\navailable prices from the bare metal server [SoftLayer_Product_Package::getAllObjects](/reference/services/SoftLayer_Product_Package/getAllObjects), which have a \n[SoftLayer_Product_Package_Type](/reference/datatypes/SoftLayer_Product_Package_Type) of `BARE_METAL_CPU` or `BARE_METAL_CORE`. You can get a full list of \npackage types with [SoftLayer_Product_Package_Type::getAllObjects](/reference/services/SoftLayer_Product_Package_Type/getAllObjects). \n\n\n### Bare Metal Ordering\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n \n \n example.com \n server1 \n \n \n 138124 \n 142 \n \n \n 58 \n \n \n 22337 \n \n \n 21189 \n \n \n 876 \n \n \n 57 \n \n \n 55 \n \n \n 21190 \n \n \n 36381 \n \n \n 21 \n \n \n 22013 \n \n \n 906 \n \n \n 420 \n \n \n 418 \n \n \n 342 \n \n \n false \n \n \n \n \n \n``` \n\n\n## Virtual server example\n\n\n\nThis example includes 2 identical virtual servers (except for hostname) being ordered for hourly billing. \nIt includes an optional image template id and VLAN data specified on the virtualGuest objects - \n`primaryBackendNetworkComponent` and `primaryNetworkComponent`. \n\n\n**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the\n\navailable prices from the virtual server package with [SoftLayer_Product_Package::getAllObjects](/reference/services/SoftLayer_Product_Package/getAllObjects), \nwhich has a [SoftLayer_Product_Package_Type](/reference/datatypes/SoftLayer_Product_Package_Type) of `VIRTUAL_SERVER_INSTANCE`. \n\n\n#### Virtual Ordering\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n 13251 \n 37473 \n 46 \n \n \n 2159 \n \n \n 55 \n \n \n 13754 \n \n \n 1641 \n \n \n 905 \n \n \n 1800 \n \n \n 58 \n \n \n 21 \n \n \n 1645 \n \n \n 272 \n \n \n 57 \n \n \n 418 \n \n \n 420 \n \n \n 2 \n true \n \n \n example.com \n server1 \n \n \n 12345 \n \n \n \n \n 67890 \n \n \n \n \n example.com \n server2 \n \n \n 12345 \n \n \n \n \n 67890 \n \n \n \n \n \n \n \n \n \n``` \n\n\n## VLAN example\n\n\n**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the\n\navailable prices from the additional services pacakge with [SoftLayer_Product_Package::getAllObjects](/reference/services/SoftLayer_Product_Package/getAllObjects), \nwhich has a [SoftLayer_Product_Package_Type](/reference/datatypes/SoftLayer_Product_Package_Type) of `ADDITIONAL_SERVICES`. \nYou can get a full list of [SoftLayer_Product_Package_Type::getAllObjects](/reference/services/SoftLayer_Product_Package_Type/getAllObjects) to find other available additional \nservice packages.

\n\n\n### VLAN Ordering\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n 154820 \n 0 \n \n \n 2021 \n \n \n 2018 \n \n \n true \n \n \n \n \n \n``` \n\n\n## Multiple products example\n\n\n\nThis example includes a combination of the above examples in a single order. Note that all the configuration \noptions for each individual order container are the same as above, except now we encapsulate each one within \nthe `orderContainers` property on the base [SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order). \n\n\n**Warning:** not all products are available to be ordered with other products. For example, since\n\nSSL certificates require validation from a 3rd party, the approval process may take days or even weeks, \nand this would not be acceptable when you need your hourly virtual server right now. To better accommodate \ncustomers, we restrict several products to be ordered individually. \n\n\n### Bare metal server + virtual server + VLAN\n\n\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n \n \n ... \n \n \n ... \n \n \n ... \n \n \n \n \n \n \n \n``` \n\n", "docOverview": "Place an order using the [SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order) data type.", "docAssociatedMethods": [ { @@ -231097,437 +231530,6 @@ }, "methods": {} }, - "SoftLayer_Container_Dns_Domain_Registration_Contact": { - "name": "SoftLayer_Container_Dns_Domain_Registration_Contact", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "Contact information container for domain registration ", - "properties": { - "address1": { - "name": "address1", - "type": "string", - "form": "local", - "doc": "The street address of the contact." - }, - "address2": { - "name": "address2", - "type": "string", - "form": "local", - "doc": "The second line in the address of the contact." - }, - "address3": { - "name": "address3", - "type": "string", - "form": "local", - "doc": "The third line in the address of the contact." - }, - "city": { - "name": "city", - "type": "string", - "form": "local", - "doc": "The city of the contact." - }, - "country": { - "name": "country", - "type": "string", - "form": "local", - "doc": "The 2-character Country code. (i.e. US)" - }, - "email": { - "name": "email", - "type": "string", - "form": "local", - "doc": "The email address of the contact." - }, - "fax": { - "name": "fax", - "type": "string", - "form": "local", - "doc": "The fax number of the contact." - }, - "firstName": { - "name": "firstName", - "type": "string", - "form": "local", - "doc": "The first name of the contact." - }, - "lastName": { - "name": "lastName", - "type": "string", - "form": "local", - "doc": "The last name of the contact." - }, - "organizationName": { - "name": "organizationName", - "type": "string", - "form": "local", - "doc": "The organization name of the contact." - }, - "phone": { - "name": "phone", - "type": "string", - "form": "local", - "doc": "The phone number of the contact." - }, - "postalCode": { - "name": "postalCode", - "type": "string", - "form": "local", - "doc": "The postal code of the contact." - }, - "state": { - "name": "state", - "type": "string", - "form": "local", - "doc": "The state of the contact." - }, - "type": { - "name": "type", - "type": "string", - "form": "local", - "doc": "The type of contact. The following are the valid types of contacts: \n* admin\n* owner\n* billing\n* tech" - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute": { - "name": "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "This container data type contains extended attributes information for a domain of country code TLD. ", - "properties": { - "childFlag": { - "name": "childFlag", - "type": "boolean", - "form": "local", - "doc": "Indicates if this is a child of another extended attribute." - }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "The description of an extended attribute." - }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "The name of an extended attribute." - }, - "options": { - "name": "options", - "type": "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option", - "form": "local", - "typeArray": true, - "doc": "The collection of options for an extended attribute." - }, - "requiredFlag": { - "name": "requiredFlag", - "type": "int", - "form": "local", - "doc": "Indicates if extended attribute is required." - }, - "userDefinedFlag": { - "name": "userDefinedFlag", - "type": "boolean", - "form": "local", - "doc": "User defined indicates that the value is required from outside sources." - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration": { - "name": "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "This is the data type that may need to be populated to complete registraton for domains that are country code TLD's. ", - "properties": { - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "The extended attribute name." - }, - "value": { - "name": "value", - "type": "string", - "form": "local", - "doc": "The extended attribute option value." - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option": { - "name": "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "This container data type contains extended attribute options information for a domain of country code TLD. ", - "properties": { - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "The description of an option." - }, - "requireExtendedAttributes": { - "name": "requireExtendedAttributes", - "type": "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require", - "form": "local", - "typeArray": true, - "doc": "Extended Attribute that is required for an option." - }, - "title": { - "name": "title", - "type": "string", - "form": "local", - "doc": "The title of an option." - }, - "value": { - "name": "value", - "type": "string", - "form": "local", - "doc": "The value of an option." - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require": { - "name": "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "This container data type contains the extended attribute name that is required by an extended attribute option. ", - "properties": { - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "The name of an extended attribute that is required by an extended attribute option." - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_Information": { - "name": "SoftLayer_Container_Dns_Domain_Registration_Information", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "Information container for domain registration ", - "properties": { - "contacts": { - "name": "contacts", - "type": "SoftLayer_Container_Dns_Domain_Registration_Contact", - "form": "local", - "typeArray": true, - "doc": "The information of the registered domain." - }, - "expireDate": { - "name": "expireDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a domain is set to expire." - }, - "nameservers": { - "name": "nameservers", - "type": "SoftLayer_Container_Dns_Domain_Registration_Nameserver", - "form": "local", - "typeArray": true, - "doc": "The list of nameservers for the domain." - }, - "registryCreateDate": { - "name": "registryCreateDate", - "type": "dateTime", - "form": "local" - }, - "registryExpireDate": { - "name": "registryExpireDate", - "type": "dateTime", - "form": "local" - }, - "registryUpdateDate": { - "name": "registryUpdateDate", - "type": "dateTime", - "form": "local" - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_List": { - "name": "SoftLayer_Container_Dns_Domain_Registration_List", - "base": "SoftLayer_Entity", - "noservice": true, - "properties": { - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name." - }, - "encodingType": { - "name": "encodingType", - "type": "string", - "form": "local", - "doc": "Three-character language tag for the IDN domain that you're trying to register. This is only required for IDN domains. " - }, - "extendedAttributeConfiguration": { - "name": "extendedAttributeConfiguration", - "type": "SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration", - "form": "local", - "typeArray": true, - "doc": "Data required by the Registry for some country code top level domains (i.e. example.us). \n\nIn order to determine if a domain requires extended attributes, use [SoftLayer_Dns_Domain_Registration::getExtendedAttributes](/reference/datatypes/$1/#$2) service. " - }, - "registrationPeriod": { - "name": "registrationPeriod", - "type": "int", - "form": "local", - "doc": "The length of the registration period in years. Valid values are 1 \u2013 10. " - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_Lookup": { - "name": "SoftLayer_Container_Dns_Domain_Registration_Lookup", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "Lookup domain container for domain registration ", - "properties": { - "items": { - "name": "items", - "type": "SoftLayer_Container_Dns_Domain_Registration_Lookup_Items", - "form": "local", - "typeArray": true, - "doc": "The list of available and taken domain names." - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_Lookup_Items": { - "name": "SoftLayer_Container_Dns_Domain_Registration_Lookup_Items", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "Lookup items container for domain registration ", - "properties": { - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name." - }, - "status": { - "name": "status", - "type": "string", - "form": "local", - "doc": "The status of the domain name if available and can be registered." - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_Nameserver": { - "name": "SoftLayer_Container_Dns_Domain_Registration_Nameserver", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "Nameserver container for domain registration ", - "properties": { - "nameservers": { - "name": "nameservers", - "type": "SoftLayer_Container_Dns_Domain_Registration_Nameserver_List", - "form": "local", - "typeArray": true, - "doc": "The list of fully qualified names of the nameserver." - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_Nameserver_List": { - "name": "SoftLayer_Container_Dns_Domain_Registration_Nameserver_List", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "Nameservers list container for domain registration ", - "properties": { - "ipv4Address": { - "name": "ipv4Address", - "type": "string", - "form": "local", - "doc": "The IPv4 address of the nameserver." - }, - "ipv6Address": { - "name": "ipv6Address", - "type": "string", - "form": "local", - "doc": "The IPv6 address of the nameserver." - }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "The fully qualified name of the nameserver" - }, - "sortOrder": { - "name": "sortOrder", - "type": "int", - "form": "local", - "doc": "The sort order of the nameserver" - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail": { - "name": "SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail", - "base": "SoftLayer_Entity", - "noservice": true, - "properties": { - "status": { - "name": "status", - "type": "SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status", - "form": "local", - "doc": "The current status of the verification." - }, - "verificationDeadlineDate": { - "name": "verificationDeadlineDate", - "type": "dateTime", - "form": "local", - "doc": "The adate when the domain will be suspended." - } - }, - "methods": {} - }, - "SoftLayer_Container_Dns_Domain_Registration_Transfer_Information": { - "name": "SoftLayer_Container_Dns_Domain_Registration_Transfer_Information", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "Transfer Information container for domain registration ", - "properties": { - "reason": { - "name": "reason", - "type": "string", - "form": "local", - "doc": "The reason why a domain is not transferable." - }, - "registrantEmail": { - "name": "registrantEmail", - "type": "string", - "form": "local", - "doc": "The registrant email." - }, - "status": { - "name": "status", - "type": "string", - "form": "local", - "doc": "The status of the latest transfer on the domain." - }, - "timeStamp": { - "name": "timeStamp", - "type": "dateTime", - "form": "local", - "doc": "The date and time of the most recent update to the state of the transfer." - }, - "transferrable": { - "name": "transferrable", - "type": "int", - "form": "local", - "doc": "Indicates if the domain can be transferred." - } - }, - "methods": {} - }, "SoftLayer_Container_Exception": { "name": "SoftLayer_Container_Exception", "base": "SoftLayer_Entity", @@ -234622,1196 +234624,17 @@ }, "methods": {} }, - "SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request": { - "name": "SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request", - "base": "SoftLayer_Container_Product_Order", - "noservice": true, - "typeDoc": "This datatype is to be used for data transfer requests. ", - "properties": { - "request": { - "name": "request", - "type": "SoftLayer_Account_Media_Data_Transfer_Request", - "form": "local", - "doc": "An instance of [SoftLayer_Account_Media_Data_Transfer_Request](/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request)" - }, - "bigDataOrderFlag": { - "name": "bigDataOrderFlag", - "type": "boolean", - "form": "local", - "doc": "Flag for identifying an order for Big Data Deployment." - }, - "billingInformation": { - "name": "billingInformation", - "type": "SoftLayer_Container_Product_Order_Billing_Information", - "form": "local", - "doc": "Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. " - }, - "billingOrderItemId": { - "name": "billingOrderItemId", - "type": "int", - "form": "local", - "doc": "This is the ID of the [SoftLayer_Billing_Order_Item](/reference/datatypes/SoftLayer_Billing_Order_Item) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. " - }, - "cancelUrl": { - "name": "cancelUrl", - "type": "string", - "form": "local", - "doc": "The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment." - }, - "containerIdentifier": { - "name": "containerIdentifier", - "type": "string", - "form": "local", - "doc": "User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. " - }, - "containerSplHash": { - "name": "containerSplHash", - "type": "string", - "form": "local", - "doc": "This hash is internally-generated and is used to for tracking order containers." - }, - "currencyShortName": { - "name": "currencyShortName", - "type": "string", - "form": "local", - "doc": "The currency type chosen at checkout. " - }, - "deviceFingerprintId": { - "name": "deviceFingerprintId", - "type": "string", - "form": "local", - "doc": "Device Fingerprint Identifier - Optional." - }, - "displayLayerSessionId": { - "name": "displayLayerSessionId", - "type": "string", - "form": "local", - "doc": "This has been deprecated. It is the identifier used to track configurations in legacy order forms. ", - "deprecated": true - }, - "extendedHardwareTesting": { - "name": "extendedHardwareTesting", - "type": "boolean", - "form": "local" - }, - "flexibleCreditProgramPrice": { - "name": "flexibleCreditProgramPrice", - "type": "SoftLayer_Product_Item_Price", - "form": "local", - "doc": "The [SoftLayer_Product_Item_Price](/reference/datatypes/SoftLayer_Product_Item_Price) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. " - }, - "gdprConsentFlag": { - "name": "gdprConsentFlag", - "type": "boolean", - "form": "local", - "doc": "This flag indicates that the customer consented to the GDPR terms for the quote." - }, - "hardware": { - "name": "hardware", - "type": "SoftLayer_Hardware", - "form": "local", - "typeArray": true, - "doc": "For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest)) orders may populate this field instead of the virtualGuests property. " - }, - "imageTemplateGlobalIdentifier": { - "name": "imageTemplateGlobalIdentifier", - "type": "string", - "form": "local", - "doc": "An optional virtual disk image template identifier to be used as an installation base for a computing instance order" - }, - "imageTemplateId": { - "name": "imageTemplateId", - "type": "int", - "form": "local", - "doc": "An optional virtual disk image template identifier to be used as an installation base for a computing instance order" - }, - "isManagedOrder": { - "name": "isManagedOrder", - "type": "int", - "form": "local", - "doc": "Flag to identify a \"managed\" order. This value is set internally." - }, - "itemCategoryQuestionAnswers": { - "name": "itemCategoryQuestionAnswers", - "type": "SoftLayer_Container_Product_Item_Category_Question_Answer", - "form": "local", - "typeArray": true, - "doc": "The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer](/reference/datatypes/SoftLayer_Container_Product_Item_Category_Question_Answer) for any product category that has additional questions requiring user input. " - }, - "location": { - "name": "location", - "type": "string", - "form": "local", - "doc": "The [SoftLayer_Location_Region](/reference/datatypes/SoftLayer_Location_Region) keyname or specific [SoftLayer_Location_Datacenter](/reference/datatypes/SoftLayer_Location_Datacenter) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. " - }, - "locationObject": { - "name": "locationObject", - "type": "SoftLayer_Location", - "form": "local", - "doc": "This [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. " - }, - "message": { - "name": "message", - "type": "string", - "form": "local", - "doc": "A generic message about the order. Does not need to be sent in with any orders. " - }, - "orderContainers": { - "name": "orderContainers", - "type": "SoftLayer_Container_Product_Order", - "form": "local", - "typeArray": true, - "doc": "Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. \n\nIf orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. " - }, - "orderHostnames": { - "name": "orderHostnames", - "type": "string", - "form": "local", - "typeArray": true, - "doc": "This is deprecated and does not do anything. " - }, - "orderVerificationExceptions": { - "name": "orderVerificationExceptions", - "type": "SoftLayer_Container_Exception", - "form": "local", - "typeArray": true, - "doc": "Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. " - }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "The [SoftLayer_Product_Package](/reference/datatypes/SoftLayer_Product_Package) id for an order container. This is required to place an order." - }, - "paymentType": { - "name": "paymentType", - "type": "string", - "form": "local", - "doc": "The Payment Type is Optional. If nothing is sent in, then the normal method of payment will be used. For paypal customers, this means a paypalToken will be returned in the receipt. This token is to be used on the paypal website to complete the order. For Credit Card customers, the card on file in our system will be used to make an initial authorization. To force the order to use a payment type, use one of the following: CARD_ON_FILE or PAYPAL " - }, - "postTaxRecurring": { - "name": "postTaxRecurring", - "type": "decimal", - "form": "local", - "doc": "The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax." - }, - "postTaxRecurringHourly": { - "name": "postTaxRecurringHourly", - "type": "decimal", - "form": "local", - "doc": "The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. " - }, - "postTaxRecurringMonthly": { - "name": "postTaxRecurringMonthly", - "type": "decimal", - "form": "local", - "doc": "The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. " - }, - "postTaxSetup": { - "name": "postTaxSetup", - "type": "decimal", - "form": "local", - "doc": "The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax;" - }, - "preTaxRecurring": { - "name": "preTaxRecurring", - "type": "decimal", - "form": "local", - "doc": "The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. " - }, - "preTaxRecurringHourly": { - "name": "preTaxRecurringHourly", - "type": "decimal", - "form": "local", - "doc": "The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. " - }, - "preTaxRecurringMonthly": { - "name": "preTaxRecurringMonthly", - "type": "decimal", - "form": "local", - "doc": "The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. " - }, - "preTaxSetup": { - "name": "preTaxSetup", - "type": "decimal", - "form": "local", - "doc": "The pre-tax setup fee total of the order." - }, - "presaleEvent": { - "name": "presaleEvent", - "type": "SoftLayer_Sales_Presale_Event", - "form": "local", - "doc": "If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event](/reference/datatypes/SoftLayer_Sales_Presale_Event) for more info. " - }, - "presetId": { - "name": "presetId", - "type": "int", - "form": "local", - "doc": "A preset configuration id for the package. Is required if not submitting any prices." - }, - "prices": { - "name": "prices", - "type": "SoftLayer_Product_Item_Price", - "form": "local", - "typeArray": true, - "doc": "This is a collection of [SoftLayer_Product_Item_Price](/reference/datatypes/SoftLayer_Product_Item_Price) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package](/reference/datatypes/SoftLayer_Product_Package) associated with the order allows for preset prices, this property is required to place an order. " - }, - "primaryDiskPartitionId": { - "name": "primaryDiskPartitionId", - "type": "int", - "form": "local", - "doc": "The id of a [SoftLayer_Hardware_Component_Partition_Template](/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem](/reference/datatypes/SoftLayer_Hardware_Component_Partition_OperatingSystem) service, getPartitionTemplates will return those available for the particular operating system. " - }, - "priorities": { - "name": "priorities", - "type": "string", - "form": "local", - "typeArray": true, - "doc": "Priorities to set on replication set servers." - }, - "privateCloudOrderFlag": { - "name": "privateCloudOrderFlag", - "type": "boolean", - "form": "local", - "doc": "Flag for identifying a container as Virtual Server (Private Node)." - }, - "privateCloudOrderType": { - "name": "privateCloudOrderType", - "type": "string", - "form": "local", - "doc": "Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE " - }, - "promotionCode": { - "name": "promotionCode", - "type": "string", - "form": "local", - "doc": "Optional promotion code for an order." - }, - "properties": { - "name": "properties", - "type": "SoftLayer_Container_Product_Order_Property", - "form": "local", - "typeArray": true, - "doc": "Generic properties." - }, - "proratedInitialCharge": { - "name": "proratedInitialCharge", - "type": "decimal", - "form": "local", - "doc": "The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. " - }, - "proratedOrderTotal": { - "name": "proratedOrderTotal", - "type": "decimal", - "form": "local", - "doc": "This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. " - }, - "provisionScripts": { - "name": "provisionScripts", - "type": "string", - "form": "local", - "typeArray": true, - "doc": "The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers." - }, - "quantity": { - "name": "quantity", - "type": "int", - "form": "local", - "doc": "The quantity of the item being ordered" - }, - "quoteName": { - "name": "quoteName", - "type": "string", - "form": "local", - "doc": "A custom name to be assigned to the quote. " - }, - "regionalGroup": { - "name": "regionalGroup", - "type": "string", - "form": "local", - "doc": "Specifying a regional group name allows you to not worry about placing your server or service at a specific datacenter, but to any datacenter within that regional group. See [SoftLayer_Location_Group_Regional](/reference/datatypes/SoftLayer_Location_Group_Regional) to get a list of available regional group names. \n\nlocation and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. \n\nIf a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. " - }, - "resourceGroupId": { - "name": "resourceGroupId", - "type": "int", - "form": "local", - "doc": "An optional resource group identifier specifying the resource group to attach the order to" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "type": "string", - "form": "local", - "doc": "This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name." - }, - "resourceGroupTemplateId": { - "name": "resourceGroupTemplateId", - "type": "int", - "form": "local", - "doc": "An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. " - }, - "returnUrl": { - "name": "returnUrl", - "type": "string", - "form": "local", - "doc": "The URL to which PayPal redirects browser after a payment is completed." - }, - "sendQuoteEmailFlag": { - "name": "sendQuoteEmailFlag", - "type": "boolean", - "form": "local", - "doc": "This flag indicates that the quote should be sent to the email address associated with the account or order." - }, - "serverCoreCount": { - "name": "serverCoreCount", - "type": "int", - "form": "local", - "doc": "The number of cores for the server being ordered. This value is set internally. " - }, - "serviceToken": { - "name": "serviceToken", - "type": "string", - "form": "local", - "doc": "The token of a requesting service. Do not set." - }, - "sourceVirtualGuestId": { - "name": "sourceVirtualGuestId", - "type": "int", - "form": "local", - "doc": "An optional computing instance identifier to be used as an installation base for a computing instance order" - }, - "sshKeys": { - "name": "sshKeys", - "type": "SoftLayer_Container_Product_Order_SshKeys", - "form": "local", - "typeArray": true, - "doc": "The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. " - }, - "stepId": { - "name": "stepId", - "type": "int", - "form": "local", - "doc": "An optional parameter for step-based order processing." - }, - "storageGroups": { - "name": "storageGroups", - "type": "SoftLayer_Container_Product_Order_Storage_Group", - "form": "local", - "typeArray": true, - "doc": "\n\nFor orders that want to add storage groups such as RAID across multiple disks, simply add [SoftLayer_Container_Product_Order_Storage_Group](/reference/datatypes/SoftLayer_Container_Product_Order_Storage_Group) objects to this array. Storage groups will only be used if the 'RAID' disk controller price is selected. Any other disk controller types will ignore the storage groups set here. \n\nThe first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. \n\n" - }, - "taxCacheHash": { - "name": "taxCacheHash", - "type": "string", - "form": "local", - "doc": "The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. " - }, - "taxCompletedFlag": { - "name": "taxCompletedFlag", - "type": "boolean", - "form": "local", - "doc": "Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder). " - }, - "techIncubatorItemPrice": { - "name": "techIncubatorItemPrice", - "type": "SoftLayer_Product_Item_Price", - "form": "local", - "doc": "The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. " - }, - "totalRecurringTax": { - "name": "totalRecurringTax", - "type": "decimal", - "form": "local", - "doc": "The total tax portion of the recurring fees." - }, - "totalSetupTax": { - "name": "totalSetupTax", - "type": "decimal", - "form": "local", - "doc": "The tax amount of the setup fees." - }, - "usagePrices": { - "name": "usagePrices", - "type": "SoftLayer_Product_Item_Price", - "form": "local", - "typeArray": true, - "doc": "This is a collection of [SoftLayer_Product_Item_Price](/reference/datatypes/SoftLayer_Product_Item_Price) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. " - }, - "useHourlyPricing": { - "name": "useHourlyPricing", - "type": "boolean", - "form": "local", - "doc": "An optional flag to use hourly pricing instead of standard monthly pricing." - }, - "virtualGuests": { - "name": "virtualGuests", - "type": "SoftLayer_Virtual_Guest", - "form": "local", - "typeArray": true, - "doc": "For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. " - } - }, - "methods": {} - }, - "SoftLayer_Container_Product_Order_Attribute_Address": { - "name": "SoftLayer_Container_Product_Order_Attribute_Address", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Attribute_Address datatype contains the address information. ", - "properties": { - "addressLine1": { - "name": "addressLine1", - "type": "string", - "form": "local", - "doc": "The physical street address." - }, - "addressLine2": { - "name": "addressLine2", - "type": "string", - "form": "local", - "doc": "The second line in the address. Information such as suite number goes here." - }, - "city": { - "name": "city", - "type": "string", - "form": "local", - "doc": "The city name" - }, - "countryCode": { - "name": "countryCode", - "type": "string", - "form": "local", - "doc": "The 2-character Country code. (i.e. US)" - }, - "nonUsState": { - "name": "nonUsState", - "type": "string", - "form": "local", - "doc": "State, Region or Province not part of the U.S. or Canada." - }, - "postalCode": { - "name": "postalCode", - "type": "string", - "form": "local", - "doc": "The Zip or Postal Code." - }, - "state": { - "name": "state", - "type": "string", - "form": "local", - "doc": "U.S. State, Region or Canadian Province." - } - }, - "methods": {} - }, - "SoftLayer_Container_Product_Order_Attribute_Contact": { - "name": "SoftLayer_Container_Product_Order_Attribute_Contact", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Attribute_Contact datatype contains the contact information. ", - "properties": { - "address": { - "name": "address", - "type": "SoftLayer_Container_Product_Order_Attribute_Address", - "form": "local", - "doc": "The address information of the contact." - }, - "emailAddress": { - "name": "emailAddress", - "type": "string", - "form": "local", - "doc": "The email address of the contact." - }, - "faxNumber": { - "name": "faxNumber", - "type": "string", - "form": "local", - "doc": "The fax number associated with a contact. This is an optional value." - }, - "firstName": { - "name": "firstName", - "type": "string", - "form": "local", - "doc": "The first name of the contact." - }, - "lastName": { - "name": "lastName", - "type": "string", - "form": "local", - "doc": "The last name of the contact." - }, - "organizationName": { - "name": "organizationName", - "type": "string", - "form": "local", - "doc": "The organization name of the contact." - }, - "phoneNumber": { - "name": "phoneNumber", - "type": "string", - "form": "local", - "doc": "The phone number associated with a contact." - }, - "title": { - "name": "title", - "type": "string", - "form": "local", - "doc": "The title of the contact." - } - }, - "methods": {} - }, - "SoftLayer_Container_Product_Order_Attribute_Organization": { - "name": "SoftLayer_Container_Product_Order_Attribute_Organization", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Attribute_Organization datatype contains the organization information. ", - "properties": { - "address": { - "name": "address", - "type": "SoftLayer_Container_Product_Order_Attribute_Address", - "form": "local", - "doc": "The address information of the contact." - }, - "faxNumber": { - "name": "faxNumber", - "type": "string", - "form": "local", - "doc": "The fax number associated with an organization. This is an optional value." - }, - "organizationName": { - "name": "organizationName", - "type": "string", - "form": "local", - "doc": "The name of an organization." - }, - "phoneNumber": { - "name": "phoneNumber", - "type": "string", - "form": "local", - "doc": "The phone number associated with an organization." - } - }, - "methods": {} - }, - "SoftLayer_Container_Product_Order_Billing_Information": { - "name": "SoftLayer_Container_Product_Order_Billing_Information", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer. ", - "properties": { - "billingAddressLine1": { - "name": "billingAddressLine1", - "type": "string", - "form": "local", - "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." - }, - "billingAddressLine2": { - "name": "billingAddressLine2", - "type": "string", - "form": "local", - "doc": "The second line in the address. Information such as suite number goes here." - }, - "billingCity": { - "name": "billingCity", - "type": "string", - "form": "local", - "doc": "The city in which a customer's account resides." - }, - "billingCountryCode": { - "name": "billingCountryCode", - "type": "string", - "form": "local", - "doc": "The 2-character Country code for an account's address. (i.e. US)" - }, - "billingEmail": { - "name": "billingEmail", - "type": "string", - "form": "local", - "doc": "The email address associated with a customer account." - }, - "billingNameCompany": { - "name": "billingNameCompany", - "type": "string", - "form": "local", - "doc": "the company name for an account." - }, - "billingNameFirst": { - "name": "billingNameFirst", - "type": "string", - "form": "local", - "doc": "The first name of the customer account owner." - }, - "billingNameLast": { - "name": "billingNameLast", - "type": "string", - "form": "local", - "doc": "The last name of the customer account owner" - }, - "billingPhoneFax": { - "name": "billingPhoneFax", - "type": "string", - "form": "local", - "doc": "The fax number associated with a customer account." - }, - "billingPhoneVoice": { - "name": "billingPhoneVoice", - "type": "string", - "form": "local", - "doc": "The phone number associated with a customer account." - }, - "billingPostalCode": { - "name": "billingPostalCode", - "type": "string", - "form": "local", - "doc": "The Zip or Postal Code for the billing address on an account." - }, - "billingState": { - "name": "billingState", - "type": "string", - "form": "local", - "doc": "The State for the account." - }, - "cardAccountNumber": { - "name": "cardAccountNumber", - "type": "string", - "form": "local", - "doc": "The credit card number to use." - }, - "cardExpirationMonth": { - "name": "cardExpirationMonth", - "type": "int", - "form": "local", - "doc": "The payment card expiration month" - }, - "cardExpirationYear": { - "name": "cardExpirationYear", - "type": "int", - "form": "local", - "doc": "The payment card expiration year" - }, - "creditCardVerificationNumber": { - "name": "creditCardVerificationNumber", - "type": "string", - "form": "local", - "doc": "The Card Verification Value Code (CVV) number" - }, - "euSupported": { - "name": "euSupported", - "type": "boolean", - "form": "local", - "doc": "1 = opted in, 0 = not opted in. Select the EU Supported option if you use IBM Bluemix Infrastructure services to process EU citizens' personal data. This option limits Level 1 and Level 2 support to the EU. However, IBM Bluemix and SoftLayer teams outside the EU perform processing activities when they are not resolved at Level 1 or 2. These activities are always at your instruction and do not impact the security or privacy of your data. As with our standard services, you must review the impact these cross-border processing activities have on your services and take any necessary measures, including review of IBM's US-EU Privacy Shield registration and Data Processing Addendum. If you select products, services, or locations outside the EU, all processing activities will be performed outside of the EU. If you select other IBM services in addition to Bluemix IaaS (IBM or a third party), determine the service location in order to meet any additional data protection or processing requirements that permit cross-border transfers. " - }, - "isBusinessFlag": { - "name": "isBusinessFlag", - "type": "boolean", - "form": "local", - "doc": "If true, order is being placed by a business. " - }, - "payerAuthenticationEnrollmentReferenceId": { - "name": "payerAuthenticationEnrollmentReferenceId", - "type": "string", - "form": "local", - "doc": "The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"DFReferenceId / ReferenceId\" to populate this property accordingly. " - }, - "payerAuthenticationEnrollmentReturnUrl": { - "name": "payerAuthenticationEnrollmentReturnUrl", - "type": "string", - "form": "local", - "doc": "The URL where the issuing bank will redirect. " - }, - "payerAuthenticationWebToken": { - "name": "payerAuthenticationWebToken", - "type": "string", - "form": "local", - "doc": "\"Continue with Consumer Authentication\" decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"Continue with Consumer Authentication\" to populate this property accordingly based on the CCA response. " - }, - "taxExempt": { - "name": "taxExempt", - "type": "int", - "form": "local", - "doc": "Tax exempt status. 1 = exempt (not taxable), 0 = not exempt (taxable)" - }, - "vatId": { - "name": "vatId", - "type": "string", - "form": "local", - "doc": "The VAT ID entered at checkout" - } - }, - "methods": {} - }, - "SoftLayer_Container_Product_Order_Dns_Domain_Registration": { - "name": "SoftLayer_Container_Product_Order_Dns_Domain_Registration", - "base": "SoftLayer_Container_Product_Order", - "noservice": true, - "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Dns_Domain_Registration datatype contains everything required to place a domain registration order with SoftLayer. ", - "properties": { - "administrativeContact": { - "name": "administrativeContact", - "type": "SoftLayer_Container_Dns_Domain_Registration_Contact", - "form": "local", - "doc": "Administrative contact information associated with an registraton or transfer. This is required if registration type is 'new' or 'transfer'. " - }, - "billingContact": { - "name": "billingContact", - "type": "SoftLayer_Container_Dns_Domain_Registration_Contact", - "form": "local", - "doc": "Billing contact information associated with an registraton or transfer. This is required if registration type is 'new' or 'transfer'. " - }, - "domainRegistrationList": { - "name": "domainRegistrationList", - "type": "SoftLayer_Container_Dns_Domain_Registration_List", - "form": "local", - "typeArray": true, - "doc": "The list of domains to be registered. This is required if registration type is 'new', 'renew', or 'transfer'. " - }, - "ownerContact": { - "name": "ownerContact", - "type": "SoftLayer_Container_Dns_Domain_Registration_Contact", - "form": "local", - "doc": "Owner contact information associated with an registraton or transfer. This is required if registration type is 'new' or 'transfer'. " - }, - "registrationType": { - "name": "registrationType", - "type": "string", - "form": "local", - "doc": "The type of a domain registration order. The registration type is Required. Allowed values are new, transfer, and renew " - }, - "technicalContact": { - "name": "technicalContact", - "type": "SoftLayer_Container_Dns_Domain_Registration_Contact", - "form": "local", - "doc": "Technical contact information associated with an registraton or transfer. This is required if registration type is 'new' or 'transfer'. " - }, - "bigDataOrderFlag": { - "name": "bigDataOrderFlag", - "type": "boolean", - "form": "local", - "doc": "Flag for identifying an order for Big Data Deployment." - }, - "billingInformation": { - "name": "billingInformation", - "type": "SoftLayer_Container_Product_Order_Billing_Information", - "form": "local", - "doc": "Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. " - }, - "billingOrderItemId": { - "name": "billingOrderItemId", - "type": "int", - "form": "local", - "doc": "This is the ID of the [SoftLayer_Billing_Order_Item](/reference/datatypes/SoftLayer_Billing_Order_Item) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. " - }, - "cancelUrl": { - "name": "cancelUrl", - "type": "string", - "form": "local", - "doc": "The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment." - }, - "containerIdentifier": { - "name": "containerIdentifier", - "type": "string", - "form": "local", - "doc": "User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. " - }, - "containerSplHash": { - "name": "containerSplHash", - "type": "string", - "form": "local", - "doc": "This hash is internally-generated and is used to for tracking order containers." - }, - "currencyShortName": { - "name": "currencyShortName", - "type": "string", - "form": "local", - "doc": "The currency type chosen at checkout. " - }, - "deviceFingerprintId": { - "name": "deviceFingerprintId", - "type": "string", - "form": "local", - "doc": "Device Fingerprint Identifier - Optional." - }, - "displayLayerSessionId": { - "name": "displayLayerSessionId", - "type": "string", - "form": "local", - "doc": "This has been deprecated. It is the identifier used to track configurations in legacy order forms. ", - "deprecated": true - }, - "extendedHardwareTesting": { - "name": "extendedHardwareTesting", - "type": "boolean", - "form": "local" - }, - "flexibleCreditProgramPrice": { - "name": "flexibleCreditProgramPrice", - "type": "SoftLayer_Product_Item_Price", - "form": "local", - "doc": "The [SoftLayer_Product_Item_Price](/reference/datatypes/SoftLayer_Product_Item_Price) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. " - }, - "gdprConsentFlag": { - "name": "gdprConsentFlag", - "type": "boolean", - "form": "local", - "doc": "This flag indicates that the customer consented to the GDPR terms for the quote." - }, - "hardware": { - "name": "hardware", - "type": "SoftLayer_Hardware", - "form": "local", - "typeArray": true, - "doc": "For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest)) orders may populate this field instead of the virtualGuests property. " - }, - "imageTemplateGlobalIdentifier": { - "name": "imageTemplateGlobalIdentifier", - "type": "string", - "form": "local", - "doc": "An optional virtual disk image template identifier to be used as an installation base for a computing instance order" - }, - "imageTemplateId": { - "name": "imageTemplateId", - "type": "int", - "form": "local", - "doc": "An optional virtual disk image template identifier to be used as an installation base for a computing instance order" - }, - "isManagedOrder": { - "name": "isManagedOrder", - "type": "int", - "form": "local", - "doc": "Flag to identify a \"managed\" order. This value is set internally." - }, - "itemCategoryQuestionAnswers": { - "name": "itemCategoryQuestionAnswers", - "type": "SoftLayer_Container_Product_Item_Category_Question_Answer", - "form": "local", - "typeArray": true, - "doc": "The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer](/reference/datatypes/SoftLayer_Container_Product_Item_Category_Question_Answer) for any product category that has additional questions requiring user input. " - }, - "location": { - "name": "location", - "type": "string", - "form": "local", - "doc": "The [SoftLayer_Location_Region](/reference/datatypes/SoftLayer_Location_Region) keyname or specific [SoftLayer_Location_Datacenter](/reference/datatypes/SoftLayer_Location_Datacenter) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. " - }, - "locationObject": { - "name": "locationObject", - "type": "SoftLayer_Location", - "form": "local", - "doc": "This [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. " - }, - "message": { - "name": "message", - "type": "string", - "form": "local", - "doc": "A generic message about the order. Does not need to be sent in with any orders. " - }, - "orderContainers": { - "name": "orderContainers", - "type": "SoftLayer_Container_Product_Order", - "form": "local", - "typeArray": true, - "doc": "Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. \n\nIf orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. " - }, - "orderHostnames": { - "name": "orderHostnames", - "type": "string", - "form": "local", - "typeArray": true, - "doc": "This is deprecated and does not do anything. " - }, - "orderVerificationExceptions": { - "name": "orderVerificationExceptions", - "type": "SoftLayer_Container_Exception", - "form": "local", - "typeArray": true, - "doc": "Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. " - }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "The [SoftLayer_Product_Package](/reference/datatypes/SoftLayer_Product_Package) id for an order container. This is required to place an order." - }, - "paymentType": { - "name": "paymentType", - "type": "string", - "form": "local", - "doc": "The Payment Type is Optional. If nothing is sent in, then the normal method of payment will be used. For paypal customers, this means a paypalToken will be returned in the receipt. This token is to be used on the paypal website to complete the order. For Credit Card customers, the card on file in our system will be used to make an initial authorization. To force the order to use a payment type, use one of the following: CARD_ON_FILE or PAYPAL " - }, - "postTaxRecurring": { - "name": "postTaxRecurring", - "type": "decimal", - "form": "local", - "doc": "The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax." - }, - "postTaxRecurringHourly": { - "name": "postTaxRecurringHourly", - "type": "decimal", - "form": "local", - "doc": "The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. " - }, - "postTaxRecurringMonthly": { - "name": "postTaxRecurringMonthly", - "type": "decimal", - "form": "local", - "doc": "The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. " - }, - "postTaxSetup": { - "name": "postTaxSetup", - "type": "decimal", - "form": "local", - "doc": "The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax;" - }, - "preTaxRecurring": { - "name": "preTaxRecurring", - "type": "decimal", - "form": "local", - "doc": "The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. " - }, - "preTaxRecurringHourly": { - "name": "preTaxRecurringHourly", - "type": "decimal", - "form": "local", - "doc": "The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. " - }, - "preTaxRecurringMonthly": { - "name": "preTaxRecurringMonthly", - "type": "decimal", - "form": "local", - "doc": "The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. " - }, - "preTaxSetup": { - "name": "preTaxSetup", - "type": "decimal", - "form": "local", - "doc": "The pre-tax setup fee total of the order." - }, - "presaleEvent": { - "name": "presaleEvent", - "type": "SoftLayer_Sales_Presale_Event", - "form": "local", - "doc": "If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event](/reference/datatypes/SoftLayer_Sales_Presale_Event) for more info. " - }, - "presetId": { - "name": "presetId", - "type": "int", - "form": "local", - "doc": "A preset configuration id for the package. Is required if not submitting any prices." - }, - "prices": { - "name": "prices", - "type": "SoftLayer_Product_Item_Price", - "form": "local", - "typeArray": true, - "doc": "This is a collection of [SoftLayer_Product_Item_Price](/reference/datatypes/SoftLayer_Product_Item_Price) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package](/reference/datatypes/SoftLayer_Product_Package) associated with the order allows for preset prices, this property is required to place an order. " - }, - "primaryDiskPartitionId": { - "name": "primaryDiskPartitionId", - "type": "int", - "form": "local", - "doc": "The id of a [SoftLayer_Hardware_Component_Partition_Template](/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem](/reference/datatypes/SoftLayer_Hardware_Component_Partition_OperatingSystem) service, getPartitionTemplates will return those available for the particular operating system. " - }, - "priorities": { - "name": "priorities", - "type": "string", - "form": "local", - "typeArray": true, - "doc": "Priorities to set on replication set servers." - }, - "privateCloudOrderFlag": { - "name": "privateCloudOrderFlag", - "type": "boolean", - "form": "local", - "doc": "Flag for identifying a container as Virtual Server (Private Node)." - }, - "privateCloudOrderType": { - "name": "privateCloudOrderType", - "type": "string", - "form": "local", - "doc": "Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE " - }, - "promotionCode": { - "name": "promotionCode", - "type": "string", - "form": "local", - "doc": "Optional promotion code for an order." - }, - "properties": { - "name": "properties", - "type": "SoftLayer_Container_Product_Order_Property", - "form": "local", - "typeArray": true, - "doc": "Generic properties." - }, - "proratedInitialCharge": { - "name": "proratedInitialCharge", - "type": "decimal", - "form": "local", - "doc": "The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. " - }, - "proratedOrderTotal": { - "name": "proratedOrderTotal", - "type": "decimal", - "form": "local", - "doc": "This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. " - }, - "provisionScripts": { - "name": "provisionScripts", - "type": "string", - "form": "local", - "typeArray": true, - "doc": "The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers." - }, - "quantity": { - "name": "quantity", - "type": "int", - "form": "local", - "doc": "The quantity of the item being ordered" - }, - "quoteName": { - "name": "quoteName", - "type": "string", - "form": "local", - "doc": "A custom name to be assigned to the quote. " - }, - "regionalGroup": { - "name": "regionalGroup", - "type": "string", - "form": "local", - "doc": "Specifying a regional group name allows you to not worry about placing your server or service at a specific datacenter, but to any datacenter within that regional group. See [SoftLayer_Location_Group_Regional](/reference/datatypes/SoftLayer_Location_Group_Regional) to get a list of available regional group names. \n\nlocation and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. \n\nIf a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. " - }, - "resourceGroupId": { - "name": "resourceGroupId", - "type": "int", - "form": "local", - "doc": "An optional resource group identifier specifying the resource group to attach the order to" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "type": "string", - "form": "local", - "doc": "This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name." - }, - "resourceGroupTemplateId": { - "name": "resourceGroupTemplateId", - "type": "int", - "form": "local", - "doc": "An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. " - }, - "returnUrl": { - "name": "returnUrl", - "type": "string", - "form": "local", - "doc": "The URL to which PayPal redirects browser after a payment is completed." - }, - "sendQuoteEmailFlag": { - "name": "sendQuoteEmailFlag", - "type": "boolean", - "form": "local", - "doc": "This flag indicates that the quote should be sent to the email address associated with the account or order." - }, - "serverCoreCount": { - "name": "serverCoreCount", - "type": "int", - "form": "local", - "doc": "The number of cores for the server being ordered. This value is set internally. " - }, - "serviceToken": { - "name": "serviceToken", - "type": "string", - "form": "local", - "doc": "The token of a requesting service. Do not set." - }, - "sourceVirtualGuestId": { - "name": "sourceVirtualGuestId", - "type": "int", - "form": "local", - "doc": "An optional computing instance identifier to be used as an installation base for a computing instance order" - }, - "sshKeys": { - "name": "sshKeys", - "type": "SoftLayer_Container_Product_Order_SshKeys", - "form": "local", - "typeArray": true, - "doc": "The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. " - }, - "stepId": { - "name": "stepId", - "type": "int", - "form": "local", - "doc": "An optional parameter for step-based order processing." - }, - "storageGroups": { - "name": "storageGroups", - "type": "SoftLayer_Container_Product_Order_Storage_Group", - "form": "local", - "typeArray": true, - "doc": "\n\nFor orders that want to add storage groups such as RAID across multiple disks, simply add [SoftLayer_Container_Product_Order_Storage_Group](/reference/datatypes/SoftLayer_Container_Product_Order_Storage_Group) objects to this array. Storage groups will only be used if the 'RAID' disk controller price is selected. Any other disk controller types will ignore the storage groups set here. \n\nThe first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. \n\n" - }, - "taxCacheHash": { - "name": "taxCacheHash", - "type": "string", - "form": "local", - "doc": "The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. " - }, - "taxCompletedFlag": { - "name": "taxCompletedFlag", - "type": "boolean", - "form": "local", - "doc": "Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder). " - }, - "techIncubatorItemPrice": { - "name": "techIncubatorItemPrice", - "type": "SoftLayer_Product_Item_Price", - "form": "local", - "doc": "The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. " - }, - "totalRecurringTax": { - "name": "totalRecurringTax", - "type": "decimal", - "form": "local", - "doc": "The total tax portion of the recurring fees." - }, - "totalSetupTax": { - "name": "totalSetupTax", - "type": "decimal", - "form": "local", - "doc": "The tax amount of the setup fees." - }, - "usagePrices": { - "name": "usagePrices", - "type": "SoftLayer_Product_Item_Price", - "form": "local", - "typeArray": true, - "doc": "This is a collection of [SoftLayer_Product_Item_Price](/reference/datatypes/SoftLayer_Product_Item_Price) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. " - }, - "useHourlyPricing": { - "name": "useHourlyPricing", - "type": "boolean", - "form": "local", - "doc": "An optional flag to use hourly pricing instead of standard monthly pricing." - }, - "virtualGuests": { - "name": "virtualGuests", - "type": "SoftLayer_Virtual_Guest", - "form": "local", - "typeArray": true, - "doc": "For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. " - } - }, - "methods": {} - }, - "SoftLayer_Container_Product_Order_Dns_Domain_Reseller": { - "name": "SoftLayer_Container_Product_Order_Dns_Domain_Reseller", + "SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request": { + "name": "SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request", "base": "SoftLayer_Container_Product_Order", "noservice": true, - "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Dns_Domain_Reseller datatype contains everything required to place a domain reseller credit order with SoftLayer. ", + "typeDoc": "This datatype is to be used for data transfer requests. ", "properties": { - "creditAmount": { - "name": "creditAmount", - "type": "decimal", + "request": { + "name": "request", + "type": "SoftLayer_Account_Media_Data_Transfer_Request", "form": "local", - "doc": "Amount to be credited to the domain reseller account. " + "doc": "An instance of [SoftLayer_Account_Media_Data_Transfer_Request](/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request)" }, "bigDataOrderFlag": { "name": "bigDataOrderFlag", @@ -236231,6 +235054,294 @@ }, "methods": {} }, + "SoftLayer_Container_Product_Order_Attribute_Address": { + "name": "SoftLayer_Container_Product_Order_Attribute_Address", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Attribute_Address datatype contains the address information. ", + "properties": { + "addressLine1": { + "name": "addressLine1", + "type": "string", + "form": "local", + "doc": "The physical street address." + }, + "addressLine2": { + "name": "addressLine2", + "type": "string", + "form": "local", + "doc": "The second line in the address. Information such as suite number goes here." + }, + "city": { + "name": "city", + "type": "string", + "form": "local", + "doc": "The city name" + }, + "countryCode": { + "name": "countryCode", + "type": "string", + "form": "local", + "doc": "The 2-character Country code. (i.e. US)" + }, + "nonUsState": { + "name": "nonUsState", + "type": "string", + "form": "local", + "doc": "State, Region or Province not part of the U.S. or Canada." + }, + "postalCode": { + "name": "postalCode", + "type": "string", + "form": "local", + "doc": "The Zip or Postal Code." + }, + "state": { + "name": "state", + "type": "string", + "form": "local", + "doc": "U.S. State, Region or Canadian Province." + } + }, + "methods": {} + }, + "SoftLayer_Container_Product_Order_Attribute_Contact": { + "name": "SoftLayer_Container_Product_Order_Attribute_Contact", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Attribute_Contact datatype contains the contact information. ", + "properties": { + "address": { + "name": "address", + "type": "SoftLayer_Container_Product_Order_Attribute_Address", + "form": "local", + "doc": "The address information of the contact." + }, + "emailAddress": { + "name": "emailAddress", + "type": "string", + "form": "local", + "doc": "The email address of the contact." + }, + "faxNumber": { + "name": "faxNumber", + "type": "string", + "form": "local", + "doc": "The fax number associated with a contact. This is an optional value." + }, + "firstName": { + "name": "firstName", + "type": "string", + "form": "local", + "doc": "The first name of the contact." + }, + "lastName": { + "name": "lastName", + "type": "string", + "form": "local", + "doc": "The last name of the contact." + }, + "organizationName": { + "name": "organizationName", + "type": "string", + "form": "local", + "doc": "The organization name of the contact." + }, + "phoneNumber": { + "name": "phoneNumber", + "type": "string", + "form": "local", + "doc": "The phone number associated with a contact." + }, + "title": { + "name": "title", + "type": "string", + "form": "local", + "doc": "The title of the contact." + } + }, + "methods": {} + }, + "SoftLayer_Container_Product_Order_Attribute_Organization": { + "name": "SoftLayer_Container_Product_Order_Attribute_Organization", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Attribute_Organization datatype contains the organization information. ", + "properties": { + "address": { + "name": "address", + "type": "SoftLayer_Container_Product_Order_Attribute_Address", + "form": "local", + "doc": "The address information of the contact." + }, + "faxNumber": { + "name": "faxNumber", + "type": "string", + "form": "local", + "doc": "The fax number associated with an organization. This is an optional value." + }, + "organizationName": { + "name": "organizationName", + "type": "string", + "form": "local", + "doc": "The name of an organization." + }, + "phoneNumber": { + "name": "phoneNumber", + "type": "string", + "form": "local", + "doc": "The phone number associated with an organization." + } + }, + "methods": {} + }, + "SoftLayer_Container_Product_Order_Billing_Information": { + "name": "SoftLayer_Container_Product_Order_Billing_Information", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer. ", + "properties": { + "billingAddressLine1": { + "name": "billingAddressLine1", + "type": "string", + "form": "local", + "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." + }, + "billingAddressLine2": { + "name": "billingAddressLine2", + "type": "string", + "form": "local", + "doc": "The second line in the address. Information such as suite number goes here." + }, + "billingCity": { + "name": "billingCity", + "type": "string", + "form": "local", + "doc": "The city in which a customer's account resides." + }, + "billingCountryCode": { + "name": "billingCountryCode", + "type": "string", + "form": "local", + "doc": "The 2-character Country code for an account's address. (i.e. US)" + }, + "billingEmail": { + "name": "billingEmail", + "type": "string", + "form": "local", + "doc": "The email address associated with a customer account." + }, + "billingNameCompany": { + "name": "billingNameCompany", + "type": "string", + "form": "local", + "doc": "the company name for an account." + }, + "billingNameFirst": { + "name": "billingNameFirst", + "type": "string", + "form": "local", + "doc": "The first name of the customer account owner." + }, + "billingNameLast": { + "name": "billingNameLast", + "type": "string", + "form": "local", + "doc": "The last name of the customer account owner" + }, + "billingPhoneFax": { + "name": "billingPhoneFax", + "type": "string", + "form": "local", + "doc": "The fax number associated with a customer account." + }, + "billingPhoneVoice": { + "name": "billingPhoneVoice", + "type": "string", + "form": "local", + "doc": "The phone number associated with a customer account." + }, + "billingPostalCode": { + "name": "billingPostalCode", + "type": "string", + "form": "local", + "doc": "The Zip or Postal Code for the billing address on an account." + }, + "billingState": { + "name": "billingState", + "type": "string", + "form": "local", + "doc": "The State for the account." + }, + "cardAccountNumber": { + "name": "cardAccountNumber", + "type": "string", + "form": "local", + "doc": "The credit card number to use." + }, + "cardExpirationMonth": { + "name": "cardExpirationMonth", + "type": "int", + "form": "local", + "doc": "The payment card expiration month" + }, + "cardExpirationYear": { + "name": "cardExpirationYear", + "type": "int", + "form": "local", + "doc": "The payment card expiration year" + }, + "creditCardVerificationNumber": { + "name": "creditCardVerificationNumber", + "type": "string", + "form": "local", + "doc": "The Card Verification Value Code (CVV) number" + }, + "euSupported": { + "name": "euSupported", + "type": "boolean", + "form": "local", + "doc": "1 = opted in, 0 = not opted in. Select the EU Supported option if you use IBM Bluemix Infrastructure services to process EU citizens' personal data. This option limits Level 1 and Level 2 support to the EU. However, IBM Bluemix and SoftLayer teams outside the EU perform processing activities when they are not resolved at Level 1 or 2. These activities are always at your instruction and do not impact the security or privacy of your data. As with our standard services, you must review the impact these cross-border processing activities have on your services and take any necessary measures, including review of IBM's US-EU Privacy Shield registration and Data Processing Addendum. If you select products, services, or locations outside the EU, all processing activities will be performed outside of the EU. If you select other IBM services in addition to Bluemix IaaS (IBM or a third party), determine the service location in order to meet any additional data protection or processing requirements that permit cross-border transfers. " + }, + "isBusinessFlag": { + "name": "isBusinessFlag", + "type": "boolean", + "form": "local", + "doc": "If true, order is being placed by a business. " + }, + "payerAuthenticationEnrollmentReferenceId": { + "name": "payerAuthenticationEnrollmentReferenceId", + "type": "string", + "form": "local", + "doc": "The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"DFReferenceId / ReferenceId\" to populate this property accordingly. " + }, + "payerAuthenticationEnrollmentReturnUrl": { + "name": "payerAuthenticationEnrollmentReturnUrl", + "type": "string", + "form": "local", + "doc": "The URL where the issuing bank will redirect. " + }, + "payerAuthenticationWebToken": { + "name": "payerAuthenticationWebToken", + "type": "string", + "form": "local", + "doc": "\"Continue with Consumer Authentication\" decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"Continue with Consumer Authentication\" to populate this property accordingly based on the CCA response. " + }, + "taxExempt": { + "name": "taxExempt", + "type": "int", + "form": "local", + "doc": "Tax exempt status. 1 = exempt (not taxable), 0 = not exempt (taxable)" + }, + "vatId": { + "name": "vatId", + "type": "string", + "form": "local", + "doc": "The VAT ID entered at checkout" + } + }, + "methods": {} + }, "SoftLayer_Container_Product_Order_Gateway_Appliance_Cluster": { "name": "SoftLayer_Container_Product_Order_Gateway_Appliance_Cluster", "base": "SoftLayer_Container_Product_Order",