Package com.okta.sdk.resource.api

Class BrandsApi

java.lang.Object

com.okta.sdk.resource.api.BrandsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class BrandsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
BrandsApi()
BrandsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Brand	createBrand(CreateBrandRequest createBrandRequest)	Create a Brand Creates a new brand in your org
Brand	createBrand(CreateBrandRequest createBrandRequest, Map<String,String> additionalHeaders)	Create a Brand Creates a new brand in your org
void	deleteBrand(String brandId)	Delete a brand Deletes a brand by `brandId`
void	deleteBrand(String brandId, Map<String,String> additionalHeaders)	Delete a brand Deletes a brand by `brandId`
ApiClient	getApiClient()
BrandWithEmbedded	getBrand(String brandId, List<String> expand)	Retrieve a Brand Retrieves a brand by `brandId`
BrandWithEmbedded	getBrand(String brandId, List<String> expand, Map<String,String> additionalHeaders)	Retrieve a Brand Retrieves a brand by `brandId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<DomainResponse>	listBrandDomains(String brandId)	List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`
List<DomainResponse>	listBrandDomains(String brandId, Map<String,String> additionalHeaders)	List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`
List<BrandWithEmbedded>	listBrands(List<String> expand, String after, Integer limit, String q)	List all Brands Lists all the brands in your org
List<BrandWithEmbedded>	listBrands(List<String> expand, String after, Integer limit, String q, Map<String,String> additionalHeaders)	List all Brands Lists all the brands in your org
Brand	replaceBrand(String brandId, BrandRequest brand)	Replace a Brand Replaces a brand by `brandId` Passing an invalid `brandId` returns a `404 Not Found` status code with the error code `E0000007`.
Brand	replaceBrand(String brandId, BrandRequest brand, Map<String,String> additionalHeaders)	Replace a Brand Replaces a brand by `brandId` Passing an invalid `brandId` returns a `404 Not Found` status code with the error code `E0000007`.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BrandsApi

public BrandsApi()

BrandsApi

public BrandsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createBrand

public Brand createBrand(CreateBrandRequest createBrandRequest)
                  throws ApiException

Create a Brand Creates a new brand in your org

Parameters:

createBrandRequest - (optional)

Returns:

Brand

Throws:

ApiException - if fails to make API call

createBrand

public Brand createBrand(CreateBrandRequest createBrandRequest,
 Map<String,String> additionalHeaders)
                  throws ApiException

Create a Brand Creates a new brand in your org

Parameters:

createBrandRequest - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

Brand

Throws:

ApiException - if fails to make API call

deleteBrand

public void deleteBrand(String brandId)
                 throws ApiException

Delete a brand Deletes a brand by `brandId`

Parameters:

brandId - The ID of the brand (required)

Throws:

ApiException - if fails to make API call

deleteBrand

public void deleteBrand(String brandId,
 Map<String,String> additionalHeaders)
                 throws ApiException

Delete a brand Deletes a brand by `brandId`

Parameters:

brandId - The ID of the brand (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getBrand

public BrandWithEmbedded getBrand(String brandId,
 List<String> expand)
                           throws ApiException

Retrieve a Brand Retrieves a brand by `brandId`

Parameters:

brandId - The ID of the brand (required)

expand - Specifies additional metadata to be included in the response (optional

Returns:

BrandWithEmbedded

Throws:

ApiException - if fails to make API call

getBrand

public BrandWithEmbedded getBrand(String brandId,
 List<String> expand,
 Map<String,String> additionalHeaders)
                           throws ApiException

Retrieve a Brand Retrieves a brand by `brandId`

Parameters:

brandId - The ID of the brand (required)

expand - Specifies additional metadata to be included in the response (optional

additionalHeaders - additionalHeaders for this call

Returns:

BrandWithEmbedded

Throws:

ApiException - if fails to make API call

listBrandDomains

public List<DomainResponse> listBrandDomains(String brandId)
                                      throws ApiException

List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`

Parameters:

brandId - The ID of the brand (required)

Returns:

List<DomainResponse>

Throws:

ApiException - if fails to make API call

listBrandDomains

public List<DomainResponse> listBrandDomains(String brandId,
 Map<String,String> additionalHeaders)
                                      throws ApiException

List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`

Parameters:

brandId - The ID of the brand (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<DomainResponse>

Throws:

ApiException - if fails to make API call

listBrands

public List<BrandWithEmbedded> listBrands(List<String> expand,
 String after,
 Integer limit,
 String q)
                                   throws ApiException

List all Brands Lists all the brands in your org

Parameters:

expand - Specifies additional metadata to be included in the response (optional

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)

limit - A limit on the number of objects to return (optional, default to 20)

q - Searches the records for matching value (optional)

Returns:

List<BrandWithEmbedded>

Throws:

ApiException - if fails to make API call

listBrands

public List<BrandWithEmbedded> listBrands(List<String> expand,
 String after,
 Integer limit,
 String q,
 Map<String,String> additionalHeaders)
                                   throws ApiException

List all Brands Lists all the brands in your org

Parameters:

expand - Specifies additional metadata to be included in the response (optional

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)

limit - A limit on the number of objects to return (optional, default to 20)

q - Searches the records for matching value (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<BrandWithEmbedded>

Throws:

ApiException - if fails to make API call

replaceBrand

public Brand replaceBrand(String brandId,
 BrandRequest brand)
                   throws ApiException

Replace a Brand Replaces a brand by `brandId` Passing an invalid `brandId` returns a `404 Not Found` status code with the error code `E0000007`. Not providing `agreeToCustomPrivacyPolicy` with `customPrivacyPolicyUrl` returns a `400 Bad Request` status code with the error code `E0000001`.

Parameters:

brandId - The ID of the brand (required)

brand - (required)

Returns:

Brand

Throws:

ApiException - if fails to make API call

replaceBrand

public Brand replaceBrand(String brandId,
 BrandRequest brand,
 Map<String,String> additionalHeaders)
                   throws ApiException

Replace a Brand Replaces a brand by `brandId` Passing an invalid `brandId` returns a `404 Not Found` status code with the error code `E0000007`. Not providing `agreeToCustomPrivacyPolicy` with `customPrivacyPolicyUrl` returns a `400 Bad Request` status code with the error code `E0000001`.

Parameters:

brandId - The ID of the brand (required)

brand - (required)

additionalHeaders - additionalHeaders for this call

Returns:

Brand

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()