Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"ignoretz",
"PYPI",
"pytest",
"serie_number"
"serie_number",
"Tago"
]
}
4 changes: 2 additions & 2 deletions docs/source/Device/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Instance
| **token**: str
| Device Token

| *Optional* **region**: Regions: "usa-1" or "env"
| *Optional* **region**: Regions: "us-e1" or "ue-w1" or "env"
| Region is a optional parameter

.. code-block::
:caption: **Example:**

from tagoio_sdk import Device

myDevice = Device({"token": "my_device_token", "region": "usa-1"})
myDevice = Device({"token": "my_device_token", "region": "us-e1"})



Expand Down
202 changes: 173 additions & 29 deletions docs/source/Resources/Account/Account_type.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,49 +6,193 @@

AccountOptions
--------------

**Attributes:**

| **user_view_welcome**: bool
| **decimal_separator**: str
| **thousand_separator**: str
| **last_whats_new**: Optional[datetime]
| user_view_welcome: bool

| decimal_separator: str

| thousand_separator: str

| last_whats_new: Optional[datetime]


.. _AccountOpt:

AccountOpt
-----------
----------

**Attributes:**

| **authenticator**: bool
| **sms**: bool
| **email**: bool
| authenticator: bool

| sms: bool

| email: bool


.. _AccountInfo:

AccountInfo
-----------

**Attributes:**

| active: bool

| name: str

| email: str

| country: Optional[str]

| timezone: str

| company: Optional[str]

| newsletter: Optional[bool]

| developer: Optional[bool]

| blocked: bool

| id: :ref:`GenericID`

| language: str

| last_login: Optional[datetime]

| options: :ref:`AccountOptions`

| phone: Optional[str]

| send_invoice: bool

| stripe_id: Optional[str]

| type: str

| plan: str

| created_at: datetime

| updated_at: datetime

| otp: Optional[:ref:`AccountOpt`]


.. _AccountCreateInfo:

AccountCreateInfo
-----------------

Information required to create a new TagoIO account.

**Attributes:**

| name: str

| email: str

| password: str

| cpassword: str

| country: Optional[str]

| timezone: str

| company: Optional[str]

| newsletter: Optional[bool]

| developer: Optional[bool]


.. _OTPType:

OTPType
-------

Type of One-Time Password authentication method.

**Values:**

| "sms" or "email" or "authenticator"


.. _TokenCreateInfo:

TokenCreateInfo
---------------

Information required to create a new account token.

**Attributes:**

| profile_id: :ref:`GenericID`

| email: str

| password: str

| pin_code: str

| otp_type: :ref:`OTPType`

| name: str


.. _LoginCredentials:

LoginCredentials
----------------

Credentials required for account login.

**Attributes:**

| **active**: bool
| **name**: str
| **email**: str
| **country**: Optional[str]
| **timezone**: str
| **company**: Optional[str]
| **newsletter**: Optional[bool]
| **developer**: Optional[bool]
| **blocked**: bool
| **id**: GenericID
| **language**: str
| **last_login**: Optional[datetime]
| **options**: :ref:`AccountOptions`
| **phone**: Optional[str]
| **send_invoice**: bool
| **stripe_id**: Optional[str]
| **type**: str
| **plan**: str
| **created_at**: datetime
| **updated_at**: datetime
| **otp**: Optional[:ref:`AccountOpt`]
| email: str

| password: str

| otp_type: :ref:`OTPType`

| pin_code: str


.. _ProfileListInfoForLogin:

ProfileListInfoForLogin
-----------------------

Profile information returned in login response.

**Attributes:**

| id: :ref:`GenericID`

| name: str


.. _LoginResponse:

LoginResponse
-------------

Response data from account login endpoint.

**Attributes:**

| type: str

| id: :ref:`GenericID`

| email: str

| company: str

| name: str

| profiles: List[:ref:`ProfileListInfoForLogin`]
Loading
Loading