***

# NumbersResource





* Full name: `\Seven\Api\Resource\Numbers\NumbersResource`
* Parent class: [`\Seven\Api\Resource\Resource`](../Resource.md)




## Methods


### delete



```php
public delete(string $number, bool $deleteImmediately = false): \Seven\Api\Resource\Numbers\NumberDeletion
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$number` | **string** |  |
| `$deleteImmediately` | **bool** |  |




**Throws:**

- [`ForbiddenIpException`](../../Exception/ForbiddenIpException.md)

- [`SigningHashVerificationException`](../../Exception/SigningHashVerificationException.md)

- [`UnexpectedApiResponseException`](../../Exception/UnexpectedApiResponseException.md)

- [`RandomException`](../../../../Random/RandomException.md)

- [`InvalidApiKeyException`](../../Exception/InvalidApiKeyException.md)

- [`MissingAccessRightsException`](../../Exception/MissingAccessRightsException.md)



***

### order



```php
public order(\Seven\Api\Resource\Numbers\OrderParams $params): \Seven\Api\Resource\Numbers\NumberOrder
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$params` | **\Seven\Api\Resource\Numbers\OrderParams** |  |




**Throws:**

- [`ForbiddenIpException`](../../Exception/ForbiddenIpException.md)

- [`SigningHashVerificationException`](../../Exception/SigningHashVerificationException.md)

- [`UnexpectedApiResponseException`](../../Exception/UnexpectedApiResponseException.md)

- [`RandomException`](../../../../Random/RandomException.md)

- [`InvalidApiKeyException`](../../Exception/InvalidApiKeyException.md)

- [`MissingAccessRightsException`](../../Exception/MissingAccessRightsException.md)



***

### update



```php
public update(\Seven\Api\Resource\Numbers\UpdateParams $params): \Seven\Api\Resource\Numbers\PhoneNumber
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$params` | **\Seven\Api\Resource\Numbers\UpdateParams** |  |




**Throws:**

- [`ForbiddenIpException`](../../Exception/ForbiddenIpException.md)

- [`SigningHashVerificationException`](../../Exception/SigningHashVerificationException.md)

- [`UnexpectedApiResponseException`](../../Exception/UnexpectedApiResponseException.md)

- [`RandomException`](../../../../Random/RandomException.md)

- [`MissingAccessRightsException`](../../Exception/MissingAccessRightsException.md)

- [`InvalidApiKeyException`](../../Exception/InvalidApiKeyException.md)



***

### listActive



```php
public listActive(): \Seven\Api\Resource\Numbers\ActiveNumbers
```











**Throws:**

- [`ForbiddenIpException`](../../Exception/ForbiddenIpException.md)

- [`SigningHashVerificationException`](../../Exception/SigningHashVerificationException.md)

- [`RandomException`](../../../../Random/RandomException.md)

- [`UnexpectedApiResponseException`](../../Exception/UnexpectedApiResponseException.md)

- [`MissingAccessRightsException`](../../Exception/MissingAccessRightsException.md)

- [`InvalidApiKeyException`](../../Exception/InvalidApiKeyException.md)



***

### get



```php
public get(string $number): \Seven\Api\Resource\Numbers\PhoneNumber
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$number` | **string** |  |




**Throws:**

- [`ForbiddenIpException`](../../Exception/ForbiddenIpException.md)

- [`SigningHashVerificationException`](../../Exception/SigningHashVerificationException.md)

- [`UnexpectedApiResponseException`](../../Exception/UnexpectedApiResponseException.md)

- [`RandomException`](../../../../Random/RandomException.md)

- [`InvalidApiKeyException`](../../Exception/InvalidApiKeyException.md)

- [`MissingAccessRightsException`](../../Exception/MissingAccessRightsException.md)



***

### listAvailable



```php
public listAvailable(\Seven\Api\Resource\Numbers\ListAvailableParams $params = new ListAvailableParams()): \Seven\Api\Resource\Numbers\AvailableNumbers
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$params` | **\Seven\Api\Resource\Numbers\ListAvailableParams** |  |




**Throws:**

- [`ForbiddenIpException`](../../Exception/ForbiddenIpException.md)

- [`SigningHashVerificationException`](../../Exception/SigningHashVerificationException.md)

- [`UnexpectedApiResponseException`](../../Exception/UnexpectedApiResponseException.md)

- [`RandomException`](../../../../Random/RandomException.md)

- [`MissingAccessRightsException`](../../Exception/MissingAccessRightsException.md)

- [`InvalidApiKeyException`](../../Exception/InvalidApiKeyException.md)



***


## Inherited methods


### __construct



```php
public __construct(\Seven\Api\Client $client): mixed
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$client` | **\Seven\Api\Client** |  |





***


***
> Automatically generated on 2025-02-06