All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Brand

@ApiService("SoftLayer_Brand")
public static interface Brand.Service
extends Service

Every IBM Cloud Infrastructure customer account is associated to a brand.

IBM Cloud Infrastructure customers are unable to change their brand information in the portal or the API.

See Also:: SoftLayer_Brand

Method Summary

Modifier and Type	Method	Description
`Brand.ServiceAsync`	`asAsync()`	Get an async version of this service
`Account`	`createCustomerAccount(Account account, Boolean bypassDuplicateAccountCheck)`	Create a new customer account record.
`Brand`	`createObject(Brand templateObject)`	createObject() allows the creation of a new brand.
`Void`	`disableAccount(Long accountId)`	Disable an account associated with this Brand.
`Account`	`getAccount()`
`Boolean`	`getAllowAccountCreationFlag()`	This flag indicates if creation of accounts is allowed.
`List<Account>`	`getAllOwnedAccounts()`	All accounts owned by the brand.
`List<Subject>`	`getAllTicketSubjects(Account account)`	(DEPRECATED) Use [[SoftLayer_Ticket_Subject::getAllObjects]] method.
`Partner`	`getBusinessPartner()`	Business Partner details for the brand.
`Boolean`	`getBusinessPartnerFlag()`	Flag indicating if the brand is a business partner.
`Catalog`	`getCatalog()`	The Product Catalog for the Brand
`List<Contact>`	`getContactInformation()`	Retrieve the contact information for the brand such as the corporate or support contact.
`List<Contact>`	`getContacts()`	The contacts for the brand.
`List<CustomerCountry>`	`getCustomerCountryLocationRestrictions()`	This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products.
`Brand`	`getDistributor()`
`Boolean`	`getDistributorChildFlag()`
`String`	`getDistributorFlag()`
`List<Hardware>`	`getHardware()`	An account's associated hardware objects.
`Boolean`	`getHasAgentAdvancedSupportFlag()`
`Boolean`	`getHasAgentSupportFlag()`
`String`	`getMerchantName()`	Get the payment processor merchant name.
`Brand`	`getObject()`
`List<Ticket>`	`getOpenTickets()`
`List<Account>`	`getOwnedAccounts()`	Active accounts owned by the brand.
`Level`	`getSecurityLevel()`
`List<Group>`	`getTicketGroups()`
`List<Ticket>`	`getTickets()`
`String`	`getToken(Long userId)`	(DEPRECATED) Use [[SoftLayer_User_Customer::getImpersonationToken]] method.
`List<Customer>`	`getUsers()`
`List<Guest>`	`getVirtualGuests()`	An account's associated virtual guest objects.
`Boolean`	`isIbmSlicBrand()`	Check if the brand is IBM SLIC top level brand or sub brand.
`Boolean`	`isPlatformServicesBrand()`	Check if the alternate billing system of brand is Bluemix.
`Void`	`reactivateAccount(Long accountId)`	Reactivate an account associated with this Brand.
`void`	`setMask(Brand.Mask mask)`
`Void`	`verifyCanDisableAccount(Long accountId)`	Verify that an account may be disabled by a Brand Agent.
`Void`	`verifyCanReactivateAccount(Long accountId)`	Verify that an account may be reactivated by a Brand Agent.
`Brand.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Brand.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Brand.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Brand.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Brand.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Brand.Mask mask)
- createCustomerAccount
  
  @ApiMethod Account createCustomerAccount(Account account, Boolean bypassDuplicateAccountCheck)
  
  Create a new customer account record. By default, the newly created account will be associated to a platform (PaaS) account. To skip the automatic creation and linking to a new platform account, set the bluemixLinkedFlag to false on the account template.
  
  See Also:
  
  SoftLayer_Brand::createCustomerAccount
- createObject
  
  @ApiMethod Brand createObject(Brand templateObject)
  
  createObject() allows the creation of a new brand. This will also create an `account`
  to serve as the owner of the brand.
  
  In order to create a brand, a template object must be sent in with several required values.
  
  ### Input [[SoftLayer_Brand]]
  
  - `name`
  + Name of brand
  + Required
  + Type: string
  - `keyName`
  + Reference key name
  + Required
  + Type: string
  - `longName`
  + More descriptive name of brand
  + Required
  + Type: string
  - `account.firstName`
  + First Name of account contact
  + Required
  + Type: string
  - `account.lastName`
  + Last Name of account contact
  + Required
  + Type: string
  - `account.address1`
  + Street Address of company
  + Required
  + Type: string
  - `account.address2`
  + Street Address of company
  + Optional
  + Type: string
  - `account.city`
  + City of company
  + Required
  + Type: string
  - `account.state`
  + State of company (if applicable)
  + Conditionally Required
  + Type: string
  - `account.postalCode`
  + Postal Code of company
  + Required
  + Type: string
  - `account.country`
  + Country of company
  + Required
  + Type: string
  - `account.officePhone`
  + Office Phone number of Company
  + Required
  + Type: string
  - `account.alternatePhone`
  + Alternate Phone number of Company
  + Optional
  + Type: string
  - `account.companyName`
  + Name of company
  + Required
  + Type: string
  - `account.email`
  + Email address of account contact
  + Required
  + Type: string
  
  REST Example:
```
curl -X POST -d '{
"parameters":[{
"name": "Brand Corp",
"keyName": "BRAND_CORP",
"longName": "Brand Corporation",
"account": {
"firstName": "Gloria",
"lastName": "Brand",
"address1": "123 Drive",
"city": "Boston",
"state": "MA",
"postalCode": "02107",
"country": "US",
"companyName": "Brand Corp",
"officePhone": "857-111-1111",
"email": "[email protected]"
}
}]
}' https://api.softlayer.com/rest/v3.1/SoftLayer_Brand/createObject.json
```
  
  See Also:
  
  SoftLayer_Brand::createObject
- disableAccount
  
  @ApiMethod(instanceRequired=true) Void disableAccount(Long accountId)
  
  Disable an account associated with this Brand. Anything that would disqualify the account from being disabled will cause an exception to be raised.
  
  See Also:
  
  SoftLayer_Brand::disableAccount
- getAllTicketSubjects
  
  @ApiMethod(instanceRequired=true) List<Subject> getAllTicketSubjects(Account account)
  
  (DEPRECATED) Use [[SoftLayer_Ticket_Subject::getAllObjects]] method.
  
  See Also:
  
  SoftLayer_Brand::getAllTicketSubjects
- getContactInformation
  
  @ApiMethod(instanceRequired=true) List<Contact> getContactInformation()
  
  Retrieve the contact information for the brand such as the corporate or support contact. This will include the contact name, telephone number, fax number, email address, and mailing address of the contact.
  
  See Also:
  
  SoftLayer_Brand::getContactInformation
- getMerchantName
  
  @ApiMethod(instanceRequired=true) String getMerchantName()
  
  Get the payment processor merchant name.
  
  See Also:
  
  SoftLayer_Brand::getMerchantName
- getObject
  
  @ApiMethod(instanceRequired=true) Brand getObject()
  
  See Also:
  
  SoftLayer_Brand::getObject
- getToken
  
  @ApiMethod(instanceRequired=true) String getToken(Long userId)
  
  (DEPRECATED) Use [[SoftLayer_User_Customer::getImpersonationToken]] method.
  
  See Also:
  
  SoftLayer_Brand::getToken
- isIbmSlicBrand
  
  @ApiMethod(instanceRequired=true) Boolean isIbmSlicBrand()
  
  Check if the brand is IBM SLIC top level brand or sub brand.
  
  See Also:
  
  SoftLayer_Brand::isIbmSlicBrand
- isPlatformServicesBrand
  
  @ApiMethod(instanceRequired=true) Boolean isPlatformServicesBrand()
  
  Check if the alternate billing system of brand is Bluemix.
  
  See Also:
  
  SoftLayer_Brand::isPlatformServicesBrand
- reactivateAccount
  
  @ApiMethod(instanceRequired=true) Void reactivateAccount(Long accountId)
  
  Reactivate an account associated with this Brand. Anything that would disqualify the account from being reactivated will cause an exception to be raised.
  
  See Also:
  
  SoftLayer_Brand::reactivateAccount
- verifyCanDisableAccount
  
  @ApiMethod(instanceRequired=true) Void verifyCanDisableAccount(Long accountId)
  
  Verify that an account may be disabled by a Brand Agent. Anything that would disqualify the account from being disabled will cause an exception to be raised.
  
  See Also:
  
  SoftLayer_Brand::verifyCanDisableAccount
- verifyCanReactivateAccount
  
  @ApiMethod(instanceRequired=true) Void verifyCanReactivateAccount(Long accountId)
  
  Verify that an account may be reactivated by a Brand Agent. Anything that would disqualify the account from being reactivated will cause an exception to be raised.
  
  See Also:
  
  SoftLayer_Brand::verifyCanReactivateAccount
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  See Also:
  
  SoftLayer_Brand::getAccount
- getAllOwnedAccounts
  
  @ApiMethod(instanceRequired=true) List<Account> getAllOwnedAccounts()
  
  All accounts owned by the brand.
  
  See Also:
  
  SoftLayer_Brand::getAllOwnedAccounts
- getAllowAccountCreationFlag
  
  @ApiMethod(instanceRequired=true) Boolean getAllowAccountCreationFlag()
  
  This flag indicates if creation of accounts is allowed.
  
  See Also:
  
  SoftLayer_Brand::getAllowAccountCreationFlag
- getBusinessPartner
  
  @ApiMethod(instanceRequired=true) Partner getBusinessPartner()
  
  Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level.
  
  See Also:
  
  SoftLayer_Brand::getBusinessPartner
- getBusinessPartnerFlag
  
  @ApiMethod(instanceRequired=true) Boolean getBusinessPartnerFlag()
  
  Flag indicating if the brand is a business partner.
  
  See Also:
  
  SoftLayer_Brand::getBusinessPartnerFlag
- getCatalog
  
  @ApiMethod(instanceRequired=true) Catalog getCatalog()
  
  The Product Catalog for the Brand
  
  See Also:
  
  SoftLayer_Brand::getCatalog
- getContacts
  
  @ApiMethod(instanceRequired=true) List<Contact> getContacts()
  
  The contacts for the brand.
  
  See Also:
  
  SoftLayer_Brand::getContacts
- getCustomerCountryLocationRestrictions
  
  @ApiMethod(instanceRequired=true) List<CustomerCountry> getCustomerCountryLocationRestrictions()
  
  This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.
  
  See Also:
  
  SoftLayer_Brand::getCustomerCountryLocationRestrictions
- getDistributor
  
  @ApiMethod(instanceRequired=true) Brand getDistributor()
  
  See Also:
  
  SoftLayer_Brand::getDistributor
- getDistributorChildFlag
  
  @ApiMethod(instanceRequired=true) Boolean getDistributorChildFlag()
  
  See Also:
  
  SoftLayer_Brand::getDistributorChildFlag
- getDistributorFlag
  
  @ApiMethod(instanceRequired=true) String getDistributorFlag()
  
  See Also:
  
  SoftLayer_Brand::getDistributorFlag
- getHardware
  
  @ApiMethod(instanceRequired=true) List<Hardware> getHardware()
  
  An account's associated hardware objects.
  
  See Also:
  
  SoftLayer_Brand::getHardware
- getHasAgentAdvancedSupportFlag
  
  @ApiMethod(instanceRequired=true) Boolean getHasAgentAdvancedSupportFlag()
  
  See Also:
  
  SoftLayer_Brand::getHasAgentAdvancedSupportFlag
- getHasAgentSupportFlag
  
  @ApiMethod(instanceRequired=true) Boolean getHasAgentSupportFlag()
  
  See Also:
  
  SoftLayer_Brand::getHasAgentSupportFlag
- getOpenTickets
  
  @ApiMethod(instanceRequired=true) List<Ticket> getOpenTickets()
  
  See Also:
  
  SoftLayer_Brand::getOpenTickets
- getOwnedAccounts
  
  @ApiMethod(instanceRequired=true) List<Account> getOwnedAccounts()
  
  Active accounts owned by the brand.
  
  See Also:
  
  SoftLayer_Brand::getOwnedAccounts
- getSecurityLevel
  
  @ApiMethod(instanceRequired=true) Level getSecurityLevel()
  
  See Also:
  
  SoftLayer_Brand::getSecurityLevel
- getTicketGroups
  
  @ApiMethod(instanceRequired=true) List<Group> getTicketGroups()
  
  See Also:
  
  SoftLayer_Brand::getTicketGroups
- getTickets
  
  @ApiMethod(instanceRequired=true) List<Ticket> getTickets()
  
  See Also:
  
  SoftLayer_Brand::getTickets
- getUsers
  
  @ApiMethod(instanceRequired=true) List<Customer> getUsers()
  
  See Also:
  
  SoftLayer_Brand::getUsers
- getVirtualGuests
  
  @ApiMethod(instanceRequired=true) List<Guest> getVirtualGuests()
  
  An account's associated virtual guest objects.
  
  See Also:
  
  SoftLayer_Brand::getVirtualGuests

Interface Brand.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details