File: //lib/python3/dist-packages/uaclient/api/u/pro/status/is_attached/__pycache__/v1.cpython-38.pyc
U
��Jh< � @ s d dl Z d dlmZmZ d dlmZ d dlmZ d dlm Z d dl
m Z m Z m
Z
mZmZ d dlmZmZ d dlmZ G d d
� d
e e�Ze jG d d � d e j��Ze eee eeef d
�dd�Zed�dd�Z e ed�dd�Z edde dd�Z dddeg d d d d �Z dS ) � N)�Optional�Tuple)� APIEndpoint)�AdditionalInfo)�UAConfig)�
BoolDataValue�
DataObject�Field� IntDataValue�StringDataValue)�!CONTRACT_EXPIRY_GRACE_PERIOD_DAYS� CONTRACT_EXPIRY_PENDING_DAYS)�
machine_tokenc @ sZ e Zd Zededd�ededdd�ededd�ed ed
d�gZee e
e ed �d d
�Z dS )�IsAttachedResult� is_attachedz=True if the machine is attached to an Ubuntu Pro subscription)�doc�contract_statusFz%Status of the Ubuntu Pro subscription�contract_remaining_daysz2Number of days left in the Ubuntu Pro subscription� is_attached_and_contract_validzbTrue if the machine is attached to an Ubuntu Pro subscription and that subscription is not expired�r r r r c C s || _ || _|| _|| _d S �Nr )�selfr r r r � r �J/usr/lib/python3/dist-packages/uaclient/api/u/pro/status/is_attached/v1.py�__init__3 s zIsAttachedResult.__init__N)
�__name__�
__module__� __qualname__r r r r
Zfields�boolr �str�intr r r r r r s6 ����� �r c @ s e Zd ZdZdZdZdZdZdS )�ContractExpiryStatusNZactivezactive-soon-to-expirez grace-periodZexpired)r r r �NONE�ACTIVE�ACTIVE_EXPIRED_SOON�EXPIRED_GRACE_PERIOD�EXPIREDr r r r r! A s
r! )�cfg�is_machine_attached�remaining_days�returnc C s� |st jdfS t}t}|dkr*t j| fS d| kr>|krLn n
t j|fS | | krbdk rpn n
t j|fS || k r�t j|fS t j|fS )z/Return a tuple [ContractExpiryStatus, num_days]r N)r! r" r r
r& r$ r% r# )r' r( r) Z grace_periodZpending_expiryr r r �_get_contract_expiry_statusJ s
r+ )r* c C s
t t� �S r )� _is_attachedr r r r r r c s r )r' r* c C sN t �| �}t|j �}t| ||j�\}}d}|r8|tjkr<d}t||j||d�S )zO
This endpoint shows if the machine is attached to a Pro subscription.
TFr ) r Zget_machine_token_filer r+ r r! r& r �value)r' Zmachine_token_filer( r r) r r r r r, g s&
����r, Zv1Z
IsAttached)�version�name�fnZ options_clsZ28FzZ
from uaclient.api.u.pro.status.is_attached.v1 import is_attached
result = is_attached()
z#pro api u.pro.status.is_attached.v1z�
{
"contract_remaining_days": 360,
"contract_status": "active",
"is_attached": true,
"is_attached_and_contract_valid": true
}
a�
.. tab-item:: Explanation
:sync: explanation
The ``contract_status`` field can return 4 different states, they are:
* **active**: The contract is currently valid.
* **grace-period**: The contract is in the grace period. This means that
it is expired, but there are still some days where the contract will be
valid.
* **active-soon-to-expire**: The contract is almost expired, but still
valid.
* **expired**: The contract is expired and no longer valid.
)Z
introduced_inZrequires_networkZexample_pythonZ result_class�
exceptionsZ example_cliZ example_jsonZextra) �enum�typingr r Zuaclient.api.apir Zuaclient.api.data_typesr Zuaclient.configr Zuaclient.data_typesr r r r
r Zuaclient.defaultsr r
Zuaclient.filesr r �unique�Enumr! r r r+ r r, ZendpointZ_docr r r r �<module> s@ ,
� ��