QuotaService¶
Initialize the Elevate service.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
server
|
Optional[str]
|
The server name for the Elevate service API. If not provided, defaults to the |
None
|
client_id
|
Optional[str]
|
The client ID for authentication. If not provided, defaults to the |
None
|
secret_key
|
Optional[str]
|
The secret key for authentication. If not provided, defaults to the |
None
|
Raises:
| Type | Description |
|---|---|
ElevateConfigurationException
|
If any required parameter is missing or invalid |
create_quota
¶
Create new quota contract
Create new quota contract (insert-only, immutable)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
create_quota_request
|
CreateQuotaRequest
|
Request to create a new quota contract (required) |
required |
Returns:
| Type | Description |
|---|---|
QuotaContractResponse
|
Returns the result object. |
get_quotas
¶
Get quota contracts
Retrieve current quota or quotas for a date range. if only one date is provided, we assume that the date that isn't provided is the current date.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
start_date
|
Optional[datetime]
|
Start of date range |
None
|
end_date
|
Optional[datetime]
|
End of date range |
None
|
Returns:
| Type | Description |
|---|---|
List[QuotaContractResponse]
|
Returns the result object. |
modify_overage_allowed
¶
Modify overage allowed
Modify overage allowed on the current quota contract
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
quota_overage_allowed_request
|
QuotaOverageAllowedRequest
|
Request to modify overage allowed on the current quota contract (required) |
required |
Returns:
| Type | Description |
|---|---|
QuotaContractResponse
|
Returns the result object. |