From b867b18a7f3ed914ef18d25df1688c5eac17288b Mon Sep 17 00:00:00 2001 From: Christopher Gallo Date: Fri, 22 Mar 2024 16:35:35 -0500 Subject: [PATCH] 20240322 release notes and updates --- .../SoftLayer_Account_Status_Change_Reason.md | 14 + ...illing_Item_Network_LoadBalancer_Global.md | 16 - ...oduct_Order_Network_LoadBalancer_Global.md | 16 - ...yer_Network_LoadBalancer_Global_Account.md | 14 - ...tLayer_Network_LoadBalancer_Global_Host.md | 14 - ...tLayer_Network_LoadBalancer_Global_Type.md | 16 - .../getBlockSelfServiceBrandMigration.md | 20 + .../getGlobalLoadBalancerAccounts.md | 20 - .../disableLockedAccount.md | 2 +- .../_index.md | 14 + .../getAllObjects.md | 20 + .../getObject.md | 20 + .../refreshGatewayLicense.md | 2 +- .../_index.md | 16 - .../addNsRecord.md | 22 - .../editObject.md | 22 - .../getAccount.md | 20 - .../getBillingItem.md | 20 - .../getHosts.md | 20 - .../getLoadBalanceType.md | 20 - .../getManagedResourceFlag.md | 20 - .../getObject.md | 20 - .../removeNsRecord.md | 22 - .../_index.md | 16 - .../deleteObject.md | 22 - .../getLoadBalancerAccount.md | 20 - .../getObject.md | 20 - .../reconfigureConsole.md | 20 + content/release_notes/2024/20240322.md | 30 + data/sldn_metadata.json | 4041 +++++------------ 30 files changed, 1391 insertions(+), 3168 deletions(-) create mode 100644 content/reference/datatypes/SoftLayer_Account_Status_Change_Reason.md delete mode 100644 content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global.md delete mode 100644 content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global.md delete mode 100644 content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account.md delete mode 100644 content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host.md delete mode 100644 content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type.md create mode 100644 content/reference/services/SoftLayer_Account/getBlockSelfServiceBrandMigration.md delete mode 100644 content/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts.md create mode 100644 content/reference/services/SoftLayer_Account_Status_Change_Reason/_index.md create mode 100644 content/reference/services/SoftLayer_Account_Status_Change_Reason/getAllObjects.md create mode 100644 content/reference/services/SoftLayer_Account_Status_Change_Reason/getObject.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/_index.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/_index.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount.md delete mode 100644 content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject.md create mode 100644 content/reference/services/SoftLayer_Virtual_Guest/reconfigureConsole.md create mode 100644 content/release_notes/2024/20240322.md diff --git a/content/reference/datatypes/SoftLayer_Account_Status_Change_Reason.md b/content/reference/datatypes/SoftLayer_Account_Status_Change_Reason.md new file mode 100644 index 0000000000..bd50e3cfc6 --- /dev/null +++ b/content/reference/datatypes/SoftLayer_Account_Status_Change_Reason.md @@ -0,0 +1,14 @@ +--- +title: "SoftLayer_Account_Status_Change_Reason" +description: "Represents a reason for changing the account status. " +date: "2018-02-12" +tags: + - "datatype" + - "sldn" + - "Account" +classes: + - "SoftLayer_Account_Status_Change_Reason" +type: "reference" +layout: "datatype" +mainService : "SoftLayer_Account_Status_Change_Reason" +--- diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global.md deleted file mode 100644 index c7bf23319f..0000000000 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "SoftLayer_Billing_Item_Network_LoadBalancer_Global" -description: "The global load balancer service has been deprecated and is no longer available. - -The 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' " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Billing" -classes: - - "SoftLayer_Billing_Item_Network_LoadBalancer_Global" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Billing_Item_Network_LoadBalancer_Global" ---- diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global.md deleted file mode 100644 index b0ea84f094..0000000000 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "SoftLayer_Container_Product_Order_Network_LoadBalancer_Global" -description: "The global load balancer service has been deprecated and is no longer available. - -This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a global load balancer order with SoftLayer. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Container" -classes: - - "SoftLayer_Container_Product_Order_Network_LoadBalancer_Global" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Container_Product_Order_Network_LoadBalancer_Global" ---- diff --git a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account.md b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account.md deleted file mode 100644 index 6ede0d74bd..0000000000 --- a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Network_LoadBalancer_Global_Account" -description: "The global load balancer service has been deprecated and is no longer available. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- diff --git a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host.md b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host.md deleted file mode 100644 index baa23afbc8..0000000000 --- a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Network_LoadBalancer_Global_Host" -description: "The global load balancer service has been deprecated and is no longer available. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Host" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Network_LoadBalancer_Global_Host" ---- diff --git a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type.md b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type.md deleted file mode 100644 index 64f798db75..0000000000 --- a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "SoftLayer_Network_LoadBalancer_Global_Type" -description: "The global load balancer service has been deprecated and is no longer available. - -The SoftLayer_Network_LoadBalancer_Global_Type data type represents a single load balance method that can be assigned to a global load balancer account. The load balance method determines how hosts in a load balancing pool are chosen by the global load balancers. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Type" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Network_LoadBalancer_Global_Type" ---- diff --git a/content/reference/services/SoftLayer_Account/getBlockSelfServiceBrandMigration.md b/content/reference/services/SoftLayer_Account/getBlockSelfServiceBrandMigration.md new file mode 100644 index 0000000000..2edfd3a947 --- /dev/null +++ b/content/reference/services/SoftLayer_Account/getBlockSelfServiceBrandMigration.md @@ -0,0 +1,20 @@ +--- +title: "getBlockSelfServiceBrandMigration" +description: "Flag indicating whether this account is restricted from performing a self-service brand migration by updating their credit card details." +date: "2018-02-12" +tags: + - "method" + - "sldn" + - "Account" +classes: + - "SoftLayer_Account" +type: "reference" +layout: "method" +mainService : "SoftLayer_Account" +--- + +### [REST Example](#getBlockSelfServiceBrandMigration-example) {#getBlockSelfServiceBrandMigration-example .anchor-link} +```bash +curl -g -u $SL_USER:$SL_APIKEY -X GET \ +'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getBlockSelfServiceBrandMigration' +``` diff --git a/content/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts.md b/content/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts.md deleted file mode 100644 index 0b1f5cce2d..0000000000 --- a/content/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getGlobalLoadBalancerAccounts" -description: "[Deprecated] The global load balancer accounts for a softlayer customer account." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Account" -classes: - - "SoftLayer_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Account" ---- - -### [REST Example](#getGlobalLoadBalancerAccounts-example) {#getGlobalLoadBalancerAccounts-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getGlobalLoadBalancerAccounts' -``` diff --git a/content/reference/services/SoftLayer_Account_Lockdown_Request/disableLockedAccount.md b/content/reference/services/SoftLayer_Account_Lockdown_Request/disableLockedAccount.md index 93476297fe..a067dbb78e 100644 --- a/content/reference/services/SoftLayer_Account_Lockdown_Request/disableLockedAccount.md +++ b/content/reference/services/SoftLayer_Account_Lockdown_Request/disableLockedAccount.md @@ -15,6 +15,6 @@ mainService : "SoftLayer_Account_Lockdown_Request" ### [REST Example](#disableLockedAccount-example) {#disableLockedAccount-example .anchor-link} ```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \ +curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \ 'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Lockdown_Request/{SoftLayer_Account_Lockdown_RequestID}/disableLockedAccount' ``` diff --git a/content/reference/services/SoftLayer_Account_Status_Change_Reason/_index.md b/content/reference/services/SoftLayer_Account_Status_Change_Reason/_index.md new file mode 100644 index 0000000000..9757c5ffcd --- /dev/null +++ b/content/reference/services/SoftLayer_Account_Status_Change_Reason/_index.md @@ -0,0 +1,14 @@ +--- +title: "SoftLayer_Account_Status_Change_Reason" +description: "Represents a reason for changing the account status. " +date: "2018-02-12" +tags: + - "service" + - "sldn" + - "Account" +classes: + - "SoftLayer_Account_Status_Change_Reason" +type: "reference" +layout: "service" +mainService : "SoftLayer_Account_Status_Change_Reason" +--- diff --git a/content/reference/services/SoftLayer_Account_Status_Change_Reason/getAllObjects.md b/content/reference/services/SoftLayer_Account_Status_Change_Reason/getAllObjects.md new file mode 100644 index 0000000000..b532fa4848 --- /dev/null +++ b/content/reference/services/SoftLayer_Account_Status_Change_Reason/getAllObjects.md @@ -0,0 +1,20 @@ +--- +title: "getAllObjects" +description: "" +date: "2018-02-12" +tags: + - "method" + - "sldn" + - "Account" +classes: + - "SoftLayer_Account_Status_Change_Reason" +type: "reference" +layout: "method" +mainService : "SoftLayer_Account_Status_Change_Reason" +--- + +### [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_Account_Status_Change_Reason/getAllObjects' +``` diff --git a/content/reference/services/SoftLayer_Account_Status_Change_Reason/getObject.md b/content/reference/services/SoftLayer_Account_Status_Change_Reason/getObject.md new file mode 100644 index 0000000000..5a52d2e0c7 --- /dev/null +++ b/content/reference/services/SoftLayer_Account_Status_Change_Reason/getObject.md @@ -0,0 +1,20 @@ +--- +title: "getObject" +description: "Retrieve a SoftLayer_Account_Status_Change_Reason record." +date: "2018-02-12" +tags: + - "method" + - "sldn" + - "Account" +classes: + - "SoftLayer_Account_Status_Change_Reason" +type: "reference" +layout: "method" +mainService : "SoftLayer_Account_Status_Change_Reason" +--- + +### [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_Account_Status_Change_Reason/{SoftLayer_Account_Status_Change_ReasonID}/getObject' +``` diff --git a/content/reference/services/SoftLayer_Network_Gateway/refreshGatewayLicense.md b/content/reference/services/SoftLayer_Network_Gateway/refreshGatewayLicense.md index 2fb16fd9bf..daad3cadda 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/refreshGatewayLicense.md +++ b/content/reference/services/SoftLayer_Network_Gateway/refreshGatewayLicense.md @@ -1,6 +1,6 @@ --- title: "refreshGatewayLicense" -description: "Used to refresh the license for the Juniper Gateway, requires License readiness check has passed. +description: "Used to refresh the all licenses (Required and add ons) for Virtual gateways. License precheck must be ready. " date: "2018-02-12" diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/_index.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/_index.md deleted file mode 100644 index 875a460782..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/_index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "SoftLayer_Network_LoadBalancer_Global_Account" -description: "The global load balancer service has been deprecated and is no longer available. - -A global load balancer account enables you to load balance traffic between servers that are in geographically diverse locations. SoftLayer's global load balancers act as a highly modified DNS server. SoftLayer's global load balancers work by accepting DNS requests for a specific hostname, choosing a host from a load balancing pool using the load balance method specified, and returning a destination IP address through a DNS response. " -date: "2018-02-12" -tags: - - "service" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "service" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord.md deleted file mode 100644 index a00ab5d495..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "addNsRecord" -description: "The global load balancer service has been deprecated and is no longer available. - -If your globally load balanced domain is hosted on the SoftLayer nameservers this method will add the required NS resource record to your DNS zone file and remove any A records that match the host portion of a global load balancer account hostname. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- - -### [REST Example](#addNsRecord-example) {#addNsRecord-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/addNsRecord' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject.md deleted file mode 100644 index 15891e4587..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "editObject" -description: "The global load balancer service has been deprecated and is no longer available. - -Edit the properties of a global load balancer account by passing in a modified instance of the object. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- - -### [REST Example](#editObject-example) {#editObject-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_LoadBalancer_Global_Account]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/editObject' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount.md deleted file mode 100644 index 4d9cf32cd5..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getAccount" -description: "Your SoftLayer customer account." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- - -### [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_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getAccount' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem.md deleted file mode 100644 index 115809af24..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getBillingItem" -description: "The current billing item for a Global Load Balancer account." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- - -### [REST Example](#getBillingItem-example) {#getBillingItem-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getBillingItem' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts.md deleted file mode 100644 index 4f5999f22a..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getHosts" -description: "The hosts in the load balancing pool for a global load balancer account." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- - -### [REST Example](#getHosts-example) {#getHosts-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getHosts' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType.md deleted file mode 100644 index 3d8d2b2f0e..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getLoadBalanceType" -description: "The load balance method of a global load balancer account" -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- - -### [REST Example](#getLoadBalanceType-example) {#getLoadBalanceType-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getLoadBalanceType' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag.md deleted file mode 100644 index 57b9b79d3b..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getManagedResourceFlag" -description: "A flag indicating that the global load balancer is a managed resource." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- - -### [REST Example](#getManagedResourceFlag-example) {#getManagedResourceFlag-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getManagedResourceFlag' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject.md deleted file mode 100644 index e6f7569063..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getObject" -description: "The global load balancer service has been deprecated and is no longer available. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- - -### [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_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getObject' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord.md deleted file mode 100644 index 6c8e799dd2..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "removeNsRecord" -description: "The global load balancer service has been deprecated and is no longer available. - -If your globally load balanced domain is hosted on the SoftLayer nameservers this method will remove the NS resource record from your DNS zone file. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Account" ---- - -### [REST Example](#removeNsRecord-example) {#removeNsRecord-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/removeNsRecord' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/_index.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/_index.md deleted file mode 100644 index d037aafeef..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/_index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "SoftLayer_Network_LoadBalancer_Global_Host" -description: "The global load balancer service has been deprecated and is no longer available. - -Every global load balancer account contains hosts that make up the load balancing pool. The global load balancers select hosts from this pool and return the destination IP in the DNS response. The SoftLayer_Network_LoadBalancer_Global_Host service represent these hosts. " -date: "2018-02-12" -tags: - - "service" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Host" -type: "reference" -layout: "service" -mainService : "SoftLayer_Network_LoadBalancer_Global_Host" ---- diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject.md deleted file mode 100644 index 904e2a67cb..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "deleteObject" -description: "The global load balancer service has been deprecated and is no longer available. - -Remove a host from the load balancing pool of a global load balancer account. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Host" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Host" ---- - -### [REST Example](#deleteObject-example) {#deleteObject-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Host/{SoftLayer_Network_LoadBalancer_Global_HostID}/deleteObject' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount.md deleted file mode 100644 index 8ff2e94dbd..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getLoadBalancerAccount" -description: "The global load balancer account a host belongs to." -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Host" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Host" ---- - -### [REST Example](#getLoadBalancerAccount-example) {#getLoadBalancerAccount-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X GET \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Host/{SoftLayer_Network_LoadBalancer_Global_HostID}/getLoadBalancerAccount' -``` diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject.md deleted file mode 100644 index 14bc672d2e..0000000000 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getObject" -description: "The global load balancer service has been deprecated and is no longer available. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Network" -classes: - - "SoftLayer_Network_LoadBalancer_Global_Host" -type: "reference" -layout: "method" -mainService : "SoftLayer_Network_LoadBalancer_Global_Host" ---- - -### [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_Network_LoadBalancer_Global_Host/{SoftLayer_Network_LoadBalancer_Global_HostID}/getObject' -``` diff --git a/content/reference/services/SoftLayer_Virtual_Guest/reconfigureConsole.md b/content/reference/services/SoftLayer_Virtual_Guest/reconfigureConsole.md new file mode 100644 index 0000000000..a0af02efc9 --- /dev/null +++ b/content/reference/services/SoftLayer_Virtual_Guest/reconfigureConsole.md @@ -0,0 +1,20 @@ +--- +title: "reconfigureConsole" +description: "" +date: "2018-02-12" +tags: + - "method" + - "sldn" + - "Virtual" +classes: + - "SoftLayer_Virtual_Guest" +type: "reference" +layout: "method" +mainService : "SoftLayer_Virtual_Guest" +--- + +### [REST Example](#reconfigureConsole-example) {#reconfigureConsole-example .anchor-link} +```bash +curl -g -u $SL_USER:$SL_APIKEY -X GET \ +'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/reconfigureConsole' +``` diff --git a/content/release_notes/2024/20240322.md b/content/release_notes/2024/20240322.md new file mode 100644 index 0000000000..714e058b08 --- /dev/null +++ b/content/release_notes/2024/20240322.md @@ -0,0 +1,30 @@ +--- +title: "Release notes: March 22, 2024" +date: "2024-03-22" +tags: + - "release notes" +--- + +#### API + +- Added new vendor codes for vmware add ons. Create new vendor code for VMWare VCF Addons SOFTWARE-1890 +- Fix regenerating quotes with default partition template ids > 1 and custom partitions disabled. Failures ordering from quotes with a default partition template and a package that disables custom partitions +SALES-14340 +- Fix for a problem on VSI orders with Windows on other environments outside of commercial.. Account for different default template IDs across environments SALES-14284 +- Disallow migrating dedicated hosts to non-dedicated hosts. Instead create a separate page for dedicated guests.. Disallow migrating dedicated hosts to non-dedicated hosts VIRT-12349 +- Removal of API endpoints associated with subnet registrations: + - SoftLayer_Account_Regional_Registry_Detail_Property.createObject/createObjects + - SoftLayer_Account_Regional_Registry_Detail_Property.editObject/editObjects + - SoftLayer_Account_Regional_Registry_Detail_Property.deleteObject + - SoftLayer_Account_Regional_Registry_Detail.createObject + - SoftLayer_Account_Regional_Registry_Detail.editObject + - SoftLayer_Account_Regional_Registry_Detail.deleteObject + - SoftLayer_Account_Regional_Registry_Detail.validatePersonForAllRegistrars + - SoftLayer_Network_Subnet_Registration_Details.createObject + - SoftLayer_Network_Subnet_Registration_Details.deleteObject + - SoftLayer_Network_Subnet_Registration.createObject/createObjects + - SoftLayer_Network_Subnet_Registration.editObject + - SoftLayer_Network_Subnet_Registration.clearRegistration + - SoftLayer_Network_Subnet_Registration.editRegistrationAttachedDetails. + - Cut off SLDN access to RIR functionality other than read NETWORK-14347 +- Expose reconfigureConsole method on SLDN but only function on Federal. Allow FED customers to reconfigure their KVM console VIRT-12914 diff --git a/data/sldn_metadata.json b/data/sldn_metadata.json index 0b513f47b2..b031b927f6 100644 --- a/data/sldn_metadata.json +++ b/data/sldn_metadata.json @@ -2545,6 +2545,17 @@ "deprecated": false, "limitable": true }, + "getBlockSelfServiceBrandMigration": { + "doc": "Flag indicating whether this account is restricted from performing a self-service brand migration by updating their credit card details.", + "docOverview": "", + "name": "getBlockSelfServiceBrandMigration", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, "getBluemixAccountId": { "doc": "", "docOverview": "", @@ -2880,18 +2891,6 @@ "deprecated": false, "limitable": true }, - "getGlobalLoadBalancerAccounts": { - "doc": "[Deprecated] The global load balancer accounts for a softlayer customer account.", - "docOverview": "", - "name": "getGlobalLoadBalancerAccounts", - "type": "SoftLayer_Network_LoadBalancer_Global_Account", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": true, - "limitable": true - }, "getHardware": { "doc": "An account's associated hardware objects.", "docOverview": "", @@ -5366,6 +5365,12 @@ "typeArray": true, "doc": "Private template group objects (parent and children) and the shared template group objects (parent only) for an account." }, + "blockSelfServiceBrandMigration": { + "name": "blockSelfServiceBrandMigration", + "type": "boolean", + "form": "relational", + "doc": "Flag indicating whether this account is restricted from performing a self-service brand migration by updating their credit card details." + }, "bluemixAccountId": { "name": "bluemixAccountId", "type": "string", @@ -5549,14 +5554,6 @@ "form": "relational", "typeArray": true }, - "globalLoadBalancerAccounts": { - "name": "globalLoadBalancerAccounts", - "type": "SoftLayer_Network_LoadBalancer_Global_Account", - "form": "relational", - "typeArray": true, - "doc": "[Deprecated] The global load balancer accounts for a softlayer customer account.", - "deprecated": true - }, "hardware": { "name": "hardware", "type": "SoftLayer_Hardware", @@ -7238,12 +7235,6 @@ "form": "count", "doc": "A count of " }, - "globalLoadBalancerAccountCount": { - "name": "globalLoadBalancerAccountCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of [Deprecated] The global load balancer accounts for a softlayer customer account." - }, "hardwareCount": { "name": "hardwareCount", "type": "unsignedLong", @@ -10565,11 +10556,18 @@ "name": "disableLockedAccount", "type": "int", "doc": "Takes the original lockdown request ID, and an optional disable date. If no date is passed with the API call, the account will be disabled immediately. Otherwise, the account will be disabled on the date given. All hardware will be reclaimed and all accounts permanently disabled. ", - "docOverview": "Disabling an account is a PERMANENT action. All billable items associated", + "docOverview": "Disabling an account is a PERMANENT action. All billable items associated with the account must be settled prior to being disabled. Access to the control portal, all resources, network access and hardware will be permanently disabled and reclaimed. ", "parameters": [ { "name": "disableDate", "type": "string", + "doc": "Optional time at which to disable the account. Must be in the future.", + "defaultValue": null + }, + { + "name": "statusChangeReasonKeyName", + "type": "string", + "doc": "Optional key name of the [SoftLayer_Account_Status_Change_Reason](/reference/datatypes/SoftLayer_Account_Status_Change_Reason)", "defaultValue": null } ] @@ -14233,6 +14231,46 @@ }, "methods": {} }, + "SoftLayer_Account_Status_Change_Reason": { + "name": "SoftLayer_Account_Status_Change_Reason", + "base": "SoftLayer_Entity", + "serviceDoc": "Represents a reason for changing the account status. ", + "methods": { + "getAllObjects": { + "name": "getAllObjects", + "type": "SoftLayer_Account_Status_Change_Reason", + "typeArray": true, + "static": true, + "limitable": true, + "filterable": true, + "maskable": true + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account_Status_Change_Reason", + "docOverview": "Retrieve a SoftLayer_Account_Status_Change_Reason record.", + "filterable": true, + "maskable": true + } + }, + "properties": { + "id": { + "name": "id", + "type": "int", + "form": "local" + }, + "keyName": { + "name": "keyName", + "type": "string", + "form": "local" + }, + "name": { + "name": "name", + "type": "string", + "form": "local" + } + } + }, "SoftLayer_Auxiliary_Network_Status": { "name": "SoftLayer_Auxiliary_Network_Status", "base": "SoftLayer_Entity", @@ -33455,17 +33493,17 @@ } } }, - "SoftLayer_Billing_Item_Network_LoadBalancer_Global": { - "name": "SoftLayer_Billing_Item_Network_LoadBalancer_Global", + "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress": { + "name": "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress", "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' ", + "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_LoadBalancer_Global_Account", + "type": "SoftLayer_Network_LoadBalancer_VirtualIpAddress", "form": "relational", - "doc": "The resource for a global load balancer billing item." + "doc": "The load balancer's virtual IP address that the billing item is associated with." }, "account": { "name": "account", @@ -34091,7 +34129,6 @@ "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", @@ -34262,17 +34299,17 @@ } } }, - "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress": { - "name": "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress", + "SoftLayer_Billing_Item_Network_Message_Delivery": { + "name": "SoftLayer_Billing_Item_Network_Message_Delivery", "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 SoftLayer_Billing_Item_Network_Message_Delivery data describes the related billing item. ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_LoadBalancer_VirtualIpAddress", + "type": "SoftLayer_Network_Message_Delivery", "form": "relational", - "doc": "The load balancer's virtual IP address that the billing item is associated with." + "doc": "The object this billing item is associated with." }, "account": { "name": "account", @@ -35068,17 +35105,186 @@ } } }, - "SoftLayer_Billing_Item_Network_Message_Delivery": { - "name": "SoftLayer_Billing_Item_Network_Message_Delivery", - "base": "SoftLayer_Billing_Item", + "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_Message_Delivery data describes the related billing item. ", + "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" + } + ] + } + }, "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_Message_Delivery", + "type": "SoftLayer_Network_Storage", "form": "relational", - "doc": "The object this billing item is associated with." + "doc": "The StorageLayer account that a network storage billing item is associated with." }, "account": { "name": "account", @@ -35703,182 +35909,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_PerformanceStorage_Iscsi": { - "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi", + "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_PerformanceStorage_Iscsi data type contains general information relating to a single SoftLayer billing item whose item category code is 'performance_storage_iscsi' ", + "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", @@ -36680,180 +36717,11 @@ } } }, - "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs": { - "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs", - "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_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" - } - ] - } - }, + "typeDoc": "The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts. ", "properties": { "resource": { "name": "resource", @@ -37484,13 +37352,351 @@ "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": { - "name": "SoftLayer_Billing_Item_Network_Storage", - "base": "SoftLayer_Billing_Item", + "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 data type describes the billing items related to StorageLayer accounts. ", + "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" + } + ] + } + }, "properties": { "resource": { "name": "resource", @@ -38121,182 +38327,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", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Storage_Hub models all billing items related to hub-based StorageLayer offerings, such as CloudLayer storage. ", + } + }, + "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", @@ -39098,835 +39135,29 @@ } } }, - "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth": { - "name": "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth", - "base": "SoftLayer_Billing_Item_Network_Storage", + "SoftLayer_Billing_Item_Network_Subnet": { + "name": "SoftLayer_Billing_Item_Network_Subnet", + "base": "SoftLayer_Billing_Item", "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" - } - ] - } - }, + "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_Storage", + "type": "SoftLayer_Network_Subnet", "form": "relational", - "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." + "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", @@ -130489,7 +129720,7 @@ "refreshGatewayLicense": { "name": "refreshGatewayLicense", "type": "boolean", - "doc": "Used to refresh the license for the Juniper Gateway, requires License readiness check has passed. \n\n" + "doc": "Used to refresh the all licenses (Required and add ons) for Virtual gateways. License precheck must be ready. \n\n" }, "rename": { "name": "rename", @@ -134058,343 +133289,6 @@ }, "methods": {} }, - "SoftLayer_Network_LoadBalancer_Global_Account": { - "name": "SoftLayer_Network_LoadBalancer_Global_Account", - "base": "SoftLayer_Entity", - "serviceDoc": "The global load balancer service has been deprecated and is no longer available. \n\nA global load balancer account enables you to load balance traffic between servers that are in geographically diverse locations. SoftLayer's global load balancers act as a highly modified DNS server. SoftLayer's global load balancers work by accepting DNS requests for a specific hostname, choosing a host from a load balancing pool using the load balance method specified, and returning a destination IP address through a DNS response. ", - "methods": { - "addNsRecord": { - "name": "addNsRecord", - "type": "boolean", - "doc": "The global load balancer service has been deprecated and is no longer available. \n\nIf your globally load balanced domain is hosted on the SoftLayer nameservers this method will add the required NS resource record to your DNS zone file and remove any A records that match the host portion of a global load balancer account hostname. ", - "docOverview": "[Deprecated] Add the required nameserver resource record for a global load balancer account.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Deprecated", - "description": "Throw the exception \"Operation addNsRecord has been deprecated and will be removed in API version 3.2.\" when attempting to invoke this function." - } - ], - "deprecated": true - }, - "editObject": { - "name": "editObject", - "type": "boolean", - "doc": "The global load balancer service has been deprecated and is no longer available. \n\nEdit the properties of a global load balancer account by passing in a modified instance of the object. ", - "docOverview": "[Deprecated] Edit a global load balancer account and the hosts that make up the load balancing pool.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Deprecated", - "description": "Throw the exception \"Operation editObject has been deprecated and will be removed in API version 3.2.\" when attempting to invoke this function." - } - ], - "deprecated": true, - "parameters": [ - { - "name": "templateObject", - "type": "SoftLayer_Network_LoadBalancer_Global_Account", - "doc": "A skeleton SoftLayer_Network_LoadBalancer_Global_Account object with only the properties defined that you wish to change. Unchanged properties are left alone." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Network_LoadBalancer_Global_Account", - "doc": "The global load balancer service has been deprecated and is no longer available. ", - "docOverview": "Retrieve a SoftLayer_Network_LoadBalancer_Global_Account record.", - "filterable": true, - "maskable": true - }, - "removeNsRecord": { - "name": "removeNsRecord", - "type": "boolean", - "doc": "The global load balancer service has been deprecated and is no longer available. \n\nIf your globally load balanced domain is hosted on the SoftLayer nameservers this method will remove the NS resource record from your DNS zone file. ", - "docOverview": "[Deprecated] Remove the required nameserver resource record for a global load balancer account.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Deprecated", - "description": "Throw the exception \"Operation removeNsRecord has been deprecated and will be removed in API version 3.2.\" when attempting to invoke this function." - } - ], - "deprecated": true - }, - "getAccount": { - "doc": "Your SoftLayer customer account.", - "docOverview": "", - "name": "getAccount", - "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - }, - "getBillingItem": { - "doc": "The current billing item for a Global Load Balancer account.", - "docOverview": "", - "name": "getBillingItem", - "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - }, - "getHosts": { - "doc": "The hosts in the load balancing pool for a global load balancer account.", - "docOverview": "", - "name": "getHosts", - "type": "SoftLayer_Network_LoadBalancer_Global_Host", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true - }, - "getLoadBalanceType": { - "doc": "The load balance method of a global load balancer account", - "docOverview": "", - "name": "getLoadBalanceType", - "type": "SoftLayer_Network_LoadBalancer_Global_Type", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - }, - "getManagedResourceFlag": { - "doc": "A flag indicating that the global load balancer is a managed resource.", - "docOverview": "", - "name": "getManagedResourceFlag", - "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - } - }, - "typeDoc": "The global load balancer service has been deprecated and is no longer available. ", - "properties": { - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational", - "doc": "Your SoftLayer customer account." - }, - "billingItem": { - "name": "billingItem", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "The current billing item for a Global Load Balancer account." - }, - "hosts": { - "name": "hosts", - "type": "SoftLayer_Network_LoadBalancer_Global_Host", - "form": "relational", - "typeArray": true, - "doc": "The hosts in the load balancing pool for a global load balancer account." - }, - "loadBalanceType": { - "name": "loadBalanceType", - "type": "SoftLayer_Network_LoadBalancer_Global_Type", - "form": "relational", - "doc": "The load balance method of a global load balancer account" - }, - "managedResourceFlag": { - "name": "managedResourceFlag", - "type": "boolean", - "form": "relational", - "doc": "A flag indicating that the global load balancer is a managed resource." - }, - "allowedNumberOfHosts": { - "name": "allowedNumberOfHosts", - "type": "int", - "form": "local", - "doc": "The maximum number of hosts that a global load balancer account is allowed to have." - }, - "averageConnectionsPerSecond": { - "name": "averageConnectionsPerSecond", - "type": "float", - "form": "local", - "doc": "The average amount of connections per second used within the current billing cycle. This number is updated daily." - }, - "connectionsPerSecond": { - "name": "connectionsPerSecond", - "type": "int", - "form": "local", - "doc": "The amount of connections per second a global load balancer account may use within a billing cycle without being billed for an overage." - }, - "fallbackIp": { - "name": "fallbackIp", - "type": "string", - "form": "local", - "doc": "The IP address that will be return to a DNS request when none of the hosts for a global load balancer account could be returned." - }, - "hostname": { - "name": "hostname", - "type": "string", - "form": "local", - "doc": "The hostname of a global load balancer account that is being load balanced." - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier of a global load balancer account." - }, - "loadBalanceTypeId": { - "name": "loadBalanceTypeId", - "type": "int", - "form": "local", - "doc": "The identifier of the load balance method for a global load balancer account." - }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "Additional customer defined information for a global load balancer account." - }, - "hostCount": { - "name": "hostCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the hosts in the load balancing pool for a global load balancer account." - } - }, - "deprecated": true - }, - "SoftLayer_Network_LoadBalancer_Global_Host": { - "name": "SoftLayer_Network_LoadBalancer_Global_Host", - "base": "SoftLayer_Entity", - "serviceDoc": "The global load balancer service has been deprecated and is no longer available. \n\nEvery global load balancer account contains hosts that make up the load balancing pool. The global load balancers select hosts from this pool and return the destination IP in the DNS response. The SoftLayer_Network_LoadBalancer_Global_Host service represent these hosts. ", - "methods": { - "deleteObject": { - "name": "deleteObject", - "type": "boolean", - "doc": "The global load balancer service has been deprecated and is no longer available. \n\nRemove a host from the load balancing pool of a global load balancer account. ", - "docOverview": "[Deprecated] Remove a host from the load balancing pool of a global load balancer account.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Deprecated", - "description": "Throw the exception \"Operation removeNsRecord has been deprecated and will be removed in API version 3.2.\" when attempting to invoke this function." - } - ], - "deprecated": true - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Network_LoadBalancer_Global_Host", - "doc": "The global load balancer service has been deprecated and is no longer available. ", - "docOverview": "Retrieve a SoftLayer_Network_LoadBalancer_Global_Host record.", - "filterable": true, - "maskable": true - }, - "getLoadBalancerAccount": { - "doc": "The global load balancer account a host belongs to.", - "docOverview": "", - "name": "getLoadBalancerAccount", - "type": "SoftLayer_Network_LoadBalancer_Global_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - } - }, - "typeDoc": "The global load balancer service has been deprecated and is no longer available. ", - "properties": { - "loadBalancerAccount": { - "name": "loadBalancerAccount", - "type": "SoftLayer_Network_LoadBalancer_Global_Account", - "form": "relational", - "doc": "The global load balancer account a host belongs to." - }, - "destinationIp": { - "name": "destinationIp", - "type": "string", - "form": "local", - "doc": "The IP address of the host that will be returned by the global load balancers in response to a dns request." - }, - "destinationPort": { - "name": "destinationPort", - "type": "int", - "form": "local", - "doc": "The port of the host that will be used for health checks." - }, - "enabled": { - "name": "enabled", - "type": "int", - "form": "local", - "doc": "Whether the host is enabled or not. The value can be '0' for disabled, or '1' for enabled." - }, - "healthCheck": { - "name": "healthCheck", - "type": "string", - "form": "local", - "doc": "The health check type of a host. Valid values include 'none', 'http', and 'tcp'." - }, - "hits": { - "name": "hits", - "type": "float", - "form": "local", - "doc": "The number of times the host was selected by the load balance method." - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier of a global load balancer host." - }, - "loadBalanceOrder": { - "name": "loadBalanceOrder", - "type": "int", - "form": "local", - "doc": "The order of this host within the load balance pool. This is only significant if the load balance method is set to failover." - }, - "location": { - "name": "location", - "type": "string", - "form": "local", - "doc": "The location of a host in a datacenter.serverRoom format." - }, - "status": { - "name": "status", - "type": "string", - "form": "local", - "doc": "The health status of a host. The status can be either 'UP', 'DOWN', or null which could mean that the health check type is set to 'none' or an update to the ip, port, or health check type was recently done and the host is waiting for the new status. " - }, - "weight": { - "name": "weight", - "type": "int", - "form": "local", - "doc": "The load balance weight of a host. The total weight of all hosts in the load balancing pool must not exceed 100." - } - }, - "deprecated": true - }, - "SoftLayer_Network_LoadBalancer_Global_Type": { - "name": "SoftLayer_Network_LoadBalancer_Global_Type", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "The global load balancer service has been deprecated and is no longer available. \n\nThe SoftLayer_Network_LoadBalancer_Global_Type data type represents a single load balance method that can be assigned to a global load balancer account. The load balance method determines how hosts in a load balancing pool are chosen by the global load balancers. ", - "properties": { - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier of a load balance method." - }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "The name of a load balance method." - } - }, - "deprecated": true, - "methods": {} - }, "SoftLayer_Network_LoadBalancer_Service": { "name": "SoftLayer_Network_LoadBalancer_Service", "base": "SoftLayer_Entity", @@ -223231,6 +222125,10 @@ "doc": "Attempt to complete a soft reboot of a guest by shutting down the operating system. ", "docOverview": "Attempt to complete a soft reboot of a guest by shutting down the operating system." }, + "reconfigureConsole": { + "name": "reconfigureConsole", + "type": "void" + }, "reloadCurrentOperatingSystemConfiguration": { "name": "reloadCurrentOperatingSystemConfiguration", "type": "SoftLayer_Provisioning_Version1_Transaction", @@ -235054,741 +233952,311 @@ }, "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", - "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 a Gateway Appliance Cluster order with SoftLayer. ", - "properties": { - "clusterIdentifier": { - "name": "clusterIdentifier", - "type": "string", - "form": "local", - "doc": "Used to identify which items on an order belong in the same cluster." - }, - "clusterOrderType": { - "name": "clusterOrderType", - "type": "string", - "form": "local", - "doc": "Indicates what type of cluster order is being placed (HA, Provision)." - }, - "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_Gateway_Appliance_Upgrade": { - "name": "SoftLayer_Container_Product_Order_Gateway_Appliance_Upgrade", - "base": "SoftLayer_Container_Product_Order", + "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. This datatype has everything required to upgrade a [SoftLayer_Network_Gateway](/reference/datatypes/SoftLayer_Network_Gateway). ", + "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": { - "gatewayId": { - "name": "gatewayId", + "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": "Identifier for the [SoftLayer_Network_Gateway](/reference/datatypes/SoftLayer_Network_Gateway) being upgraded." + "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", + "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 a Gateway Appliance Cluster order with SoftLayer. ", + "properties": { + "clusterIdentifier": { + "name": "clusterIdentifier", + "type": "string", + "form": "local", + "doc": "Used to identify which items on an order belong in the same cluster." + }, + "clusterOrderType": { + "name": "clusterOrderType", + "type": "string", + "form": "local", + "doc": "Indicates what type of cluster order is being placed (HA, Provision)." }, "bigDataOrderFlag": { "name": "bigDataOrderFlag", @@ -236208,69 +234676,17 @@ }, "methods": {} }, - "SoftLayer_Container_Product_Order_Hardware_Security_Module": { - "name": "SoftLayer_Container_Product_Order_Hardware_Security_Module", - "base": "SoftLayer_Container_Product_Order_Hardware_Server", + "SoftLayer_Container_Product_Order_Gateway_Appliance_Upgrade": { + "name": "SoftLayer_Container_Product_Order_Gateway_Appliance_Upgrade", + "base": "SoftLayer_Container_Product_Order", "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 a hardware security module order with SoftLayer. ", - "methods": {}, + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to upgrade a [SoftLayer_Network_Gateway](/reference/datatypes/SoftLayer_Network_Gateway). ", "properties": { - "bootCategoryCode": { - "name": "bootCategoryCode", - "type": "string", - "form": "local", - "doc": "Used to identify which category should be used for the boot disk." - }, - "clusterIdentifier": { - "name": "clusterIdentifier", - "type": "string", - "form": "local", - "doc": "Used to identify which items on an order belong in the same cluster." - }, - "clusterOrderType": { - "name": "clusterOrderType", - "type": "string", - "form": "local", - "doc": "Indicates what type of cluster order is being placed (HA, Provision)." - }, - "clusterResourceId": { - "name": "clusterResourceId", - "type": "int", - "form": "local", - "doc": "Used to identify which gateway is being upgraded to HA." - }, - "driveDestructionDisks": { - "name": "driveDestructionDisks", - "type": "string", - "form": "local", - "typeArray": true, - "doc": "Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. " - }, - "monitoringAgentConfigurationTemplateGroupId": { - "name": "monitoringAgentConfigurationTemplateGroupId", - "type": "int", - "form": "local", - "doc": "Id used with the monitoring package. (Deprecated)", - "deprecated": true - }, - "privateCloudServerRole": { - "name": "privateCloudServerRole", - "type": "string", - "form": "local", - "doc": "When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated)" - }, - "requiredUpstreamDeviceId": { - "name": "requiredUpstreamDeviceId", + "gatewayId": { + "name": "gatewayId", "type": "int", "form": "local", - "doc": "Used to identify which device the new server should be attached to." - }, - "tags": { - "name": "tags", - "type": "SoftLayer_Container_Product_Order_Property", - "form": "local", - "typeArray": true, - "doc": "tags (used in MongoDB deployments). (Deprecated)" + "doc": "Identifier for the [SoftLayer_Network_Gateway](/reference/datatypes/SoftLayer_Network_Gateway) being upgraded." }, "bigDataOrderFlag": { "name": "bigDataOrderFlag", @@ -236687,13 +235103,15 @@ "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_Hardware_Server": { - "name": "SoftLayer_Container_Product_Order_Hardware_Server", - "base": "SoftLayer_Container_Product_Order", + "SoftLayer_Container_Product_Order_Hardware_Security_Module": { + "name": "SoftLayer_Container_Product_Order_Hardware_Security_Module", + "base": "SoftLayer_Container_Product_Order_Hardware_Server", "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. ", + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware security module order with SoftLayer. ", + "methods": {}, "properties": { "bootCategoryCode": { "name": "bootCategoryCode", @@ -237167,15 +235585,13 @@ "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_Hardware_Server_Colocation": { - "name": "SoftLayer_Container_Product_Order_Hardware_Server_Colocation", - "base": "SoftLayer_Container_Product_Order_Hardware_Server", + "SoftLayer_Container_Product_Order_Hardware_Server": { + "name": "SoftLayer_Container_Product_Order_Hardware_Server", + "base": "SoftLayer_Container_Product_Order", "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. ", - "methods": {}, "properties": { "bootCategoryCode": { "name": "bootCategoryCode", @@ -237649,13 +236065,14 @@ "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_Hardware_Server_Gateway_Appliance": { - "name": "SoftLayer_Container_Product_Order_Hardware_Server_Gateway_Appliance", + "SoftLayer_Container_Product_Order_Hardware_Server_Colocation": { + "name": "SoftLayer_Container_Product_Order_Hardware_Server_Colocation", "base": "SoftLayer_Container_Product_Order_Hardware_Server", "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 a Gateway Appliance order. ", + "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. ", "methods": {}, "properties": { "bootCategoryCode": { @@ -238132,11 +236549,11 @@ } } }, - "SoftLayer_Container_Product_Order_Hardware_Server_Upgrade": { - "name": "SoftLayer_Container_Product_Order_Hardware_Server_Upgrade", + "SoftLayer_Container_Product_Order_Hardware_Server_Gateway_Appliance": { + "name": "SoftLayer_Container_Product_Order_Hardware_Server_Gateway_Appliance", "base": "SoftLayer_Container_Product_Order_Hardware_Server", "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 a hardware upgrade. ", + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a Gateway Appliance order. ", "methods": {}, "properties": { "bootCategoryCode": { @@ -238613,22 +237030,13 @@ } } }, - "SoftLayer_Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved": { - "name": "SoftLayer_Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved", - "base": "SoftLayer_Container_Product_Order_Hardware_Server_Upgrade", + "SoftLayer_Container_Product_Order_Hardware_Server_Upgrade": { + "name": "SoftLayer_Container_Product_Order_Hardware_Server_Upgrade", + "base": "SoftLayer_Container_Product_Order_Hardware_Server", "noservice": true, - "typeDoc": "Use this datatype to upgrade your existing monthly-billed server to term based pricing. Only monthly to 1 year, and 1 year to 3 year migrations are available. A new billing agreement contract will be created upon order approval, starting at the next billing cycle. A price is required for each existing billing item and all term-based prices must match in length. Hourly billed servers are not eligible for this upgrade. Downgrading to a shorter term is not available. Multiple term upgrades per billing cycle are not allowed. ", + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware upgrade. ", + "methods": {}, "properties": { - "termLength": { - "name": "termLength", - "type": "int", - "form": "local" - }, - "termStartDate": { - "name": "termStartDate", - "type": "dateTime", - "form": "local" - }, "bootCategoryCode": { "name": "bootCategoryCode", "type": "string", @@ -239101,64 +237509,22 @@ "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_Hardware_Server_Vpc": { - "name": "SoftLayer_Container_Product_Order_Hardware_Server_Vpc", - "base": "SoftLayer_Container_Product_Order_Hardware_Server", + "SoftLayer_Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved": { + "name": "SoftLayer_Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved", + "base": "SoftLayer_Container_Product_Order_Hardware_Server_Upgrade", "noservice": true, + "typeDoc": "Use this datatype to upgrade your existing monthly-billed server to term based pricing. Only monthly to 1 year, and 1 year to 3 year migrations are available. A new billing agreement contract will be created upon order approval, starting at the next billing cycle. A price is required for each existing billing item and all term-based prices must match in length. Hourly billed servers are not eligible for this upgrade. Downgrading to a shorter term is not available. Multiple term upgrades per billing cycle are not allowed. ", "properties": { - "crn": { - "name": "crn", - "type": "string", - "form": "local" - }, - "instanceProfile": { - "name": "instanceProfile", - "type": "string", - "form": "local" - }, - "ipAllocations": { - "name": "ipAllocations", - "type": "SoftLayer_Container_Product_Order_Vpc_IpAllocation", - "form": "local", - "typeArray": true - }, - "resourceGroup": { - "name": "resourceGroup", - "type": "string", - "form": "local" - }, - "serverId": { - "name": "serverId", - "type": "string", - "form": "local" - }, - "servicePortInterfaceId": { - "name": "servicePortInterfaceId", - "type": "string", - "form": "local" - }, - "servicePortIpAllocationId": { - "name": "servicePortIpAllocationId", - "type": "string", - "form": "local" - }, - "servicePortVpcId": { - "name": "servicePortVpcId", - "type": "string", + "termLength": { + "name": "termLength", + "type": "int", "form": "local" }, - "subnets": { - "name": "subnets", - "type": "SoftLayer_Container_Product_Order_Vpc_Subnet", - "form": "local", - "typeArray": true - }, - "zone": { - "name": "zone", - "type": "string", + "termStartDate": { + "name": "termStartDate", + "type": "dateTime", "form": "local" }, "bootCategoryCode": { @@ -239636,18 +238002,120 @@ }, "methods": {} }, - "SoftLayer_Container_Product_Order_Monitoring_Package": { - "name": "SoftLayer_Container_Product_Order_Monitoring_Package", - "base": "SoftLayer_Container_Product_Order", + "SoftLayer_Container_Product_Order_Hardware_Server_Vpc": { + "name": "SoftLayer_Container_Product_Order_Hardware_Server_Vpc", + "base": "SoftLayer_Container_Product_Order_Hardware_Server", "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 a Monitoring Package order with SoftLayer. This class is no longer available. ", "properties": { - "serverType": { - "name": "serverType", + "crn": { + "name": "crn", + "type": "string", + "form": "local" + }, + "instanceProfile": { + "name": "instanceProfile", "type": "string", + "form": "local" + }, + "ipAllocations": { + "name": "ipAllocations", + "type": "SoftLayer_Container_Product_Order_Vpc_IpAllocation", "form": "local", + "typeArray": true + }, + "resourceGroup": { + "name": "resourceGroup", + "type": "string", + "form": "local" + }, + "serverId": { + "name": "serverId", + "type": "string", + "form": "local" + }, + "servicePortInterfaceId": { + "name": "servicePortInterfaceId", + "type": "string", + "form": "local" + }, + "servicePortIpAllocationId": { + "name": "servicePortIpAllocationId", + "type": "string", + "form": "local" + }, + "servicePortVpcId": { + "name": "servicePortVpcId", + "type": "string", + "form": "local" + }, + "subnets": { + "name": "subnets", + "type": "SoftLayer_Container_Product_Order_Vpc_Subnet", + "form": "local", + "typeArray": true + }, + "zone": { + "name": "zone", + "type": "string", + "form": "local" + }, + "bootCategoryCode": { + "name": "bootCategoryCode", + "type": "string", + "form": "local", + "doc": "Used to identify which category should be used for the boot disk." + }, + "clusterIdentifier": { + "name": "clusterIdentifier", + "type": "string", + "form": "local", + "doc": "Used to identify which items on an order belong in the same cluster." + }, + "clusterOrderType": { + "name": "clusterOrderType", + "type": "string", + "form": "local", + "doc": "Indicates what type of cluster order is being placed (HA, Provision)." + }, + "clusterResourceId": { + "name": "clusterResourceId", + "type": "int", + "form": "local", + "doc": "Used to identify which gateway is being upgraded to HA." + }, + "driveDestructionDisks": { + "name": "driveDestructionDisks", + "type": "string", + "form": "local", + "typeArray": true, + "doc": "Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. " + }, + "monitoringAgentConfigurationTemplateGroupId": { + "name": "monitoringAgentConfigurationTemplateGroupId", + "type": "int", + "form": "local", + "doc": "Id used with the monitoring package. (Deprecated)", "deprecated": true }, + "privateCloudServerRole": { + "name": "privateCloudServerRole", + "type": "string", + "form": "local", + "doc": "When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated)" + }, + "requiredUpstreamDeviceId": { + "name": "requiredUpstreamDeviceId", + "type": "int", + "form": "local", + "doc": "Used to identify which device the new server should be attached to." + }, + "tags": { + "name": "tags", + "type": "SoftLayer_Container_Product_Order_Property", + "form": "local", + "typeArray": true, + "doc": "tags (used in MongoDB deployments). (Deprecated)" + }, "bigDataOrderFlag": { "name": "bigDataOrderFlag", "type": "boolean", @@ -240066,13 +238534,18 @@ }, "methods": {} }, - "SoftLayer_Container_Product_Order_MultiConfiguration": { - "name": "SoftLayer_Container_Product_Order_MultiConfiguration", + "SoftLayer_Container_Product_Order_Monitoring_Package": { + "name": "SoftLayer_Container_Product_Order_Monitoring_Package", "base": "SoftLayer_Container_Product_Order", "noservice": true, - "typeDoc": "This is a datatype used with multi-configuration deployments. Multi-configuration deployments also have a deployment specific datatype that should be used in lieu of this one. ", - "methods": {}, + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a Monitoring Package order with SoftLayer. This class is no longer available. ", "properties": { + "serverType": { + "name": "serverType", + "type": "string", + "form": "local", + "deprecated": true + }, "bigDataOrderFlag": { "name": "bigDataOrderFlag", "type": "boolean", @@ -240488,12 +238961,14 @@ "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_MultiConfiguration_Tornado": { - "name": "SoftLayer_Container_Product_Order_MultiConfiguration_Tornado", - "base": "SoftLayer_Container_Product_Order_MultiConfiguration", + "SoftLayer_Container_Product_Order_MultiConfiguration": { + "name": "SoftLayer_Container_Product_Order_MultiConfiguration", + "base": "SoftLayer_Container_Product_Order", "noservice": true, + "typeDoc": "This is a datatype used with multi-configuration deployments. Multi-configuration deployments also have a deployment specific datatype that should be used in lieu of this one. ", "methods": {}, "properties": { "bigDataOrderFlag": { @@ -240913,47 +239388,12 @@ } } }, - "SoftLayer_Container_Product_Order_Network": { - "name": "SoftLayer_Container_Product_Order_Network", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "(DEPRECATED) This type contains the structure of network-related objects that may be specified when ordering services. ", - "properties": { - "network": { - "name": "network", - "type": "SoftLayer_Network", - "form": "local", - "doc": "The [SoftLayer_Network](/reference/datatypes/SoftLayer_Network) object." - }, - "publicVlans": { - "name": "publicVlans", - "type": "SoftLayer_Container_Product_Order", - "form": "local", - "typeArray": true, - "doc": "The list of public [SoftLayer_Container_Product_Order_Network_Vlan](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlan) available for ordering. Each VLAN will have list of public subnets that are accessible to the VLAN. " - }, - "subnets": { - "name": "subnets", - "type": "SoftLayer_Container_Product_Order", - "form": "local", - "typeArray": true, - "doc": "The list of private [SoftLayer_Container_Product_Order_Network_Subnet](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet) available for ordering with a description of their available IP space. " - } - }, - "methods": {} - }, - "SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller": { - "name": "SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller", - "base": "SoftLayer_Container_Product_Order", + "SoftLayer_Container_Product_Order_MultiConfiguration_Tornado": { + "name": "SoftLayer_Container_Product_Order_MultiConfiguration_Tornado", + "base": "SoftLayer_Container_Product_Order_MultiConfiguration", "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 application delivery controller order with SoftLayer. ", + "methods": {}, "properties": { - "applicationDeliveryControllerId": { - "name": "applicationDeliveryControllerId", - "type": "int", - "form": "local", - "doc": "An optional [SoftLayer_Network_Application_Delivery_Controller](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller) identifier that is used for upgrading an existing application delivery controller. " - }, "bigDataOrderFlag": { "name": "bigDataOrderFlag", "type": "boolean", @@ -241369,56 +239809,48 @@ "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_Network_Interconnect": { - "name": "SoftLayer_Container_Product_Order_Network_Interconnect", - "base": "SoftLayer_Container_Product_Order", + "SoftLayer_Container_Product_Order_Network": { + "name": "SoftLayer_Container_Product_Order_Network", + "base": "SoftLayer_Entity", "noservice": true, - "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder when purchasing a Network Interconnect. ", + "typeDoc": "(DEPRECATED) This type contains the structure of network-related objects that may be specified when ordering services. ", "properties": { - "bgpAsn": { - "name": "bgpAsn", - "type": "string", - "form": "local", - "doc": "The BGP ASN." - }, - "interconnectId": { - "name": "interconnectId", - "type": "int", - "form": "local", - "doc": "The [SoftLayer_Network_Interconnect](/reference/datatypes/SoftLayer_Network_Interconnect) for this order, ID must be provided." - }, - "interconnectLocation": { - "name": "interconnectLocation", - "type": "SoftLayer_Network_DirectLink_Location", - "form": "local", - "doc": "The [SoftLayer_Network_DirectLink_Location](/reference/datatypes/SoftLayer_Network_DirectLink_Location) for this order, ID must be provided." - }, - "interconnectTenant": { - "name": "interconnectTenant", - "type": "SoftLayer_Network_Interconnect_Tenant", + "network": { + "name": "network", + "type": "SoftLayer_Network", "form": "local", - "doc": "The [SoftLayer_Network_Interconnect_Tenant](/reference/datatypes/SoftLayer_Network_Interconnect_Tenant) being ordered. Only the ID is required. If this ID is specified, then properties such as networkIdentifier, ipAddressRange, and interconnectId do not need to be specified. " + "doc": "The [SoftLayer_Network](/reference/datatypes/SoftLayer_Network) object." }, - "ipAddressRange": { - "name": "ipAddressRange", - "type": "string", + "publicVlans": { + "name": "publicVlans", + "type": "SoftLayer_Container_Product_Order", "form": "local", - "doc": "Optional IP address for this link." + "typeArray": true, + "doc": "The list of public [SoftLayer_Container_Product_Order_Network_Vlan](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlan) available for ordering. Each VLAN will have list of public subnets that are accessible to the VLAN. " }, - "name": { - "name": "name", - "type": "string", + "subnets": { + "name": "subnets", + "type": "SoftLayer_Container_Product_Order", "form": "local", - "doc": "A name to identify this Direct Link resource." - }, - "networkIdentifier": { - "name": "networkIdentifier", - "type": "string", + "typeArray": true, + "doc": "The list of private [SoftLayer_Container_Product_Order_Network_Subnet](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet) available for ordering with a description of their available IP space. " + } + }, + "methods": {} + }, + "SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller": { + "name": "SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller", + "base": "SoftLayer_Container_Product_Order", + "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 application delivery controller order with SoftLayer. ", + "properties": { + "applicationDeliveryControllerId": { + "name": "applicationDeliveryControllerId", + "type": "int", "form": "local", - "doc": "Optional network identifier for this link." + "doc": "An optional [SoftLayer_Network_Application_Delivery_Controller](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller) identifier that is used for upgrading an existing application delivery controller. " }, "bigDataOrderFlag": { "name": "bigDataOrderFlag", @@ -241838,12 +240270,11 @@ }, "methods": {} }, - "SoftLayer_Container_Product_Order_Network_Interconnect_Upgrade": { - "name": "SoftLayer_Container_Product_Order_Network_Interconnect_Upgrade", - "base": "SoftLayer_Container_Product_Order_Network_Interconnect", + "SoftLayer_Container_Product_Order_Network_Interconnect": { + "name": "SoftLayer_Container_Product_Order_Network_Interconnect", + "base": "SoftLayer_Container_Product_Order", "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 upgrade order for Direct Link. ", - "methods": {}, + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder when purchasing a Network Interconnect. ", "properties": { "bgpAsn": { "name": "bgpAsn", @@ -242302,15 +240733,58 @@ "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_Network_LoadBalancer": { - "name": "SoftLayer_Container_Product_Order_Network_LoadBalancer", - "base": "SoftLayer_Container_Product_Order", + "SoftLayer_Container_Product_Order_Network_Interconnect_Upgrade": { + "name": "SoftLayer_Container_Product_Order_Network_Interconnect_Upgrade", + "base": "SoftLayer_Container_Product_Order_Network_Interconnect", "noservice": true, - "typeDoc": "This is the default container type for network load balancer orders. ", + "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 upgrade order for Direct Link. ", "methods": {}, "properties": { + "bgpAsn": { + "name": "bgpAsn", + "type": "string", + "form": "local", + "doc": "The BGP ASN." + }, + "interconnectId": { + "name": "interconnectId", + "type": "int", + "form": "local", + "doc": "The [SoftLayer_Network_Interconnect](/reference/datatypes/SoftLayer_Network_Interconnect) for this order, ID must be provided." + }, + "interconnectLocation": { + "name": "interconnectLocation", + "type": "SoftLayer_Network_DirectLink_Location", + "form": "local", + "doc": "The [SoftLayer_Network_DirectLink_Location](/reference/datatypes/SoftLayer_Network_DirectLink_Location) for this order, ID must be provided." + }, + "interconnectTenant": { + "name": "interconnectTenant", + "type": "SoftLayer_Network_Interconnect_Tenant", + "form": "local", + "doc": "The [SoftLayer_Network_Interconnect_Tenant](/reference/datatypes/SoftLayer_Network_Interconnect_Tenant) being ordered. Only the ID is required. If this ID is specified, then properties such as networkIdentifier, ipAddressRange, and interconnectId do not need to be specified. " + }, + "ipAddressRange": { + "name": "ipAddressRange", + "type": "string", + "form": "local", + "doc": "Optional IP address for this link." + }, + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "A name to identify this Direct Link resource." + }, + "networkIdentifier": { + "name": "networkIdentifier", + "type": "string", + "form": "local", + "doc": "Optional network identifier for this link." + }, "bigDataOrderFlag": { "name": "bigDataOrderFlag", "type": "boolean", @@ -242728,77 +241202,13 @@ } } }, - "SoftLayer_Container_Product_Order_Network_LoadBalancer_AsAService": { - "name": "SoftLayer_Container_Product_Order_Network_LoadBalancer_AsAService", + "SoftLayer_Container_Product_Order_Network_LoadBalancer": { + "name": "SoftLayer_Container_Product_Order_Network_LoadBalancer", "base": "SoftLayer_Container_Product_Order", "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 for a Load Balancer as a Service. ", + "typeDoc": "This is the default container type for network load balancer orders. ", + "methods": {}, "properties": { - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A description of this Load Balancer." - }, - "healthMonitorConfigurations": { - "name": "healthMonitorConfigurations", - "type": "SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration", - "form": "local", - "typeArray": true, - "doc": "The [SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration](/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration)s for this Load Balancer." - }, - "isPublic": { - "name": "isPublic", - "type": "boolean", - "form": "local", - "doc": "Specify whether this load balancer is a public or internal facing load balancer. If this value is omitted, the value will default to true. " - }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "A name to identify this Load Balancer." - }, - "protocolConfigurations": { - "name": "protocolConfigurations", - "type": "SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration", - "form": "local", - "typeArray": true, - "doc": "The [SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration](/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration)s for this Load Balancer." - }, - "publicSubnets": { - "name": "publicSubnets", - "type": "SoftLayer_Network_Subnet", - "form": "local", - "typeArray": true, - "doc": "Specify the public subnet where this load balancer will be provisioned when useSystemPublicIpPool is false. This is valid only for public(1) load balancer. The public subnet should match the private subnet. " - }, - "serverInstancesInformation": { - "name": "serverInstancesInformation", - "type": "SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo", - "form": "local", - "typeArray": true, - "doc": "The [SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo](/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo)s for this Load Balancer." - }, - "subnets": { - "name": "subnets", - "type": "SoftLayer_Network_Subnet", - "form": "local", - "typeArray": true, - "doc": "The [SoftLayer_Network_Subnet](/reference/datatypes/SoftLayer_Network_Subnet)s where this Load Balancer will be provisioned." - }, - "type": { - "name": "type", - "type": "int", - "form": "local", - "doc": "Specify the type of this load balancer. If isPublic is omitted, it specifies the load balacner as private(0), public(1) or public to public(2). If isPublic is set as True, only public(1) or public to public(2) is valid. If isPublic is set as False, this value is ignored. If this value is omitted, the value will be set according to isPublic value. " - }, - "useSystemPublicIpPool": { - "name": "useSystemPublicIpPool", - "type": "boolean", - "form": "local", - "doc": "Specify if this load balancer uses system IP pool (true, default) or customer's (null|false) public subnet to allocate IP addresses." - }, "bigDataOrderFlag": { "name": "bigDataOrderFlag", "type": "boolean", @@ -243214,26 +241624,78 @@ "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_Network_LoadBalancer_Global": { - "name": "SoftLayer_Container_Product_Order_Network_LoadBalancer_Global", + "SoftLayer_Container_Product_Order_Network_LoadBalancer_AsAService": { + "name": "SoftLayer_Container_Product_Order_Network_LoadBalancer_AsAService", "base": "SoftLayer_Container_Product_Order", "noservice": true, - "typeDoc": "The global load balancer service has been deprecated and is no longer available. \n\nThis is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a global load balancer order with SoftLayer. ", + "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 for a Load Balancer as a Service. ", "properties": { - "domain": { - "name": "domain", + "description": { + "name": "description", "type": "string", "form": "local", - "doc": "The domain name that will be load balanced." + "doc": "A description of this Load Balancer." }, - "hostname": { - "name": "hostname", + "healthMonitorConfigurations": { + "name": "healthMonitorConfigurations", + "type": "SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration", + "form": "local", + "typeArray": true, + "doc": "The [SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration](/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration)s for this Load Balancer." + }, + "isPublic": { + "name": "isPublic", + "type": "boolean", + "form": "local", + "doc": "Specify whether this load balancer is a public or internal facing load balancer. If this value is omitted, the value will default to true. " + }, + "name": { + "name": "name", "type": "string", "form": "local", - "doc": "The hostname that will be load balanced." + "doc": "A name to identify this Load Balancer." + }, + "protocolConfigurations": { + "name": "protocolConfigurations", + "type": "SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration", + "form": "local", + "typeArray": true, + "doc": "The [SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration](/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration)s for this Load Balancer." + }, + "publicSubnets": { + "name": "publicSubnets", + "type": "SoftLayer_Network_Subnet", + "form": "local", + "typeArray": true, + "doc": "Specify the public subnet where this load balancer will be provisioned when useSystemPublicIpPool is false. This is valid only for public(1) load balancer. The public subnet should match the private subnet. " + }, + "serverInstancesInformation": { + "name": "serverInstancesInformation", + "type": "SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo", + "form": "local", + "typeArray": true, + "doc": "The [SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo](/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo)s for this Load Balancer." + }, + "subnets": { + "name": "subnets", + "type": "SoftLayer_Network_Subnet", + "form": "local", + "typeArray": true, + "doc": "The [SoftLayer_Network_Subnet](/reference/datatypes/SoftLayer_Network_Subnet)s where this Load Balancer will be provisioned." + }, + "type": { + "name": "type", + "type": "int", + "form": "local", + "doc": "Specify the type of this load balancer. If isPublic is omitted, it specifies the load balacner as private(0), public(1) or public to public(2). If isPublic is set as True, only public(1) or public to public(2) is valid. If isPublic is set as False, this value is ignored. If this value is omitted, the value will be set according to isPublic value. " + }, + "useSystemPublicIpPool": { + "name": "useSystemPublicIpPool", + "type": "boolean", + "form": "local", + "doc": "Specify if this load balancer uses system IP pool (true, default) or customer's (null|false) public subnet to allocate IP addresses." }, "bigDataOrderFlag": { "name": "bigDataOrderFlag", @@ -243651,7 +242113,6 @@ "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. " } }, - "deprecated": true, "methods": {} }, "SoftLayer_Container_Product_Order_Network_Message_Delivery": {