OrganizationDomains
in package
Table of Contents
Properties
Methods
- __construct() : mixed
- createOrganizationDomain() : OrganizationDomain
- Create an Organization Domain
- deleteOrganizationDomain() : void
- Delete an Organization Domain
- getOrganizationDomain() : OrganizationDomainStandAlone
- Get an Organization Domain
- verifyOrganizationDomain() : OrganizationDomainStandAlone
- Verify an Organization Domain
Properties
$client read-only
private
HttpClient
$client
Methods
__construct()
public
__construct(HttpClient $client) : mixed
Parameters
- $client : HttpClient
createOrganizationDomain()
Create an Organization Domain
public
createOrganizationDomain(string $domain, string $organizationId[, RequestOptions|null $options = null ]) : OrganizationDomain
Creates a new Organization Domain.
Parameters
- $domain : string
-
The domain to add to the organization.
- $organizationId : string
-
The ID of the organization to add the domain to.
- $options : RequestOptions|null = null
Tags
Return values
OrganizationDomaindeleteOrganizationDomain()
Delete an Organization Domain
public
deleteOrganizationDomain(string $id[, RequestOptions|null $options = null ]) : void
Permanently deletes an organization domain. It cannot be undone.
Parameters
- $id : string
-
Unique identifier of the organization domain.
- $options : RequestOptions|null = null
Tags
getOrganizationDomain()
Get an Organization Domain
public
getOrganizationDomain(string $id[, RequestOptions|null $options = null ]) : OrganizationDomainStandAlone
Get the details of an existing organization domain.
Parameters
- $id : string
-
Unique identifier of the organization domain.
- $options : RequestOptions|null = null
Tags
Return values
OrganizationDomainStandAloneverifyOrganizationDomain()
Verify an Organization Domain
public
verifyOrganizationDomain(string $id[, RequestOptions|null $options = null ]) : OrganizationDomainStandAlone
Initiates verification process for an Organization Domain.
Parameters
- $id : string
-
Unique identifier of the organization domain.
- $options : RequestOptions|null = null