gws.plugin.qfieldcloud.api

API definition from swagger.yaml

Source code: gws.plugin.qfieldcloud.api

Module Contents

class gws.plugin.qfieldcloud.api.AuthProvider(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

id: str

name: str

type: str

class gws.plugin.qfieldcloud.api.AuthToken(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

avatar_url: str

email: str | None

expires_at: datetime.datetime

first_name: str | None

full_name: str

last_name: str | None

token: str

type: UserType

username: str

class gws.plugin.qfieldcloud.api.CompleteUser(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

avatar_url: str

email: str | None

first_name: str | None

full_name: str

last_name: str | None

type: int

username: str

class gws.plugin.qfieldcloud.api.Delta(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

content: Any

created_at: datetime.datetime

created_by: str

deltafile_id: str

id: str

last_feedback: Any | None

last_status: LastStatusEnum | None

output: str

status: str

updated_at: datetime.datetime

class gws.plugin.qfieldcloud.api.DeltasPayload(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

deltas: list[dict]

files: list[dict]

id: str

project: str

version: str

class gws.plugin.qfieldcloud.api.Job(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

created_at: datetime.datetime

created_by: int

finished_at: datetime.datetime | None

id: str

project_id: str

started_at: datetime.datetime | None

status: JobStatusEnum

type: TypeEnum

updated_at: datetime.datetime

class gws.plugin.qfieldcloud.api.JobStatusEnum(*args, **kwds)

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

failed = 'failed'

finished = 'finished'

pending = 'pending'

queued = 'queued'

started = 'started'

stopped = 'stopped'

class gws.plugin.qfieldcloud.api.LastStatusEnum(*args, **kwds)

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

applied = 'applied'

conflict = 'conflict'

error = 'error'

ignored = 'ignored'

not_applied = 'not_applied'

pending = 'pending'

started = 'started'

unpermitted = 'unpermitted'

class gws.plugin.qfieldcloud.api.Login(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

email: str | None

password: str

username: str | None

class gws.plugin.qfieldcloud.api.Organization(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

avatar_url: str

email: str | None

members: str

membership_is_public: bool

membership_role: str

membership_role_origin: str

organization_owner: str

teams: List[str]

type: int

username: str

class gws.plugin.qfieldcloud.api.OrganizationMember(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

is_public: bool | None

member: str

organization: str

role: OrganizationMemberRoleEnum

class gws.plugin.qfieldcloud.api.OrganizationMemberRoleEnum(*args, **kwds)

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

admin = 'admin'

member = 'member'

class gws.plugin.qfieldcloud.api.Package(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

data_last_updated_at: datetime.datetime

files: List[dict]

layers: List[dict]

package_id: str

packaged_at: datetime.datetime

status: JobStatusEnum

class gws.plugin.qfieldcloud.api.PackageFile(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

is_attachment: bool

last_modified: str

md5sum: str

name: str

sha256: str

size: int

uploaded_at: str

class gws.plugin.qfieldcloud.api.PostJobPayload(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

project_id: str

type: TypeEnum

class gws.plugin.qfieldcloud.api.Project(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

can_repackage: bool

created_at: datetime.datetime

data_last_packaged_at: datetime.datetime | None

data_last_updated_at: datetime.datetime | None

description: str | None

id: str

is_attachment_download_on_demand: bool

is_featured: bool | None

is_public: bool | None

is_shared_datasets_project: bool

name: str

needs_repackaging: bool

owner: str

private: bool | None

shared_datasets_project_id: str | None

status: ProjectStatusEnum

updated_at: datetime.datetime

user_role: str

user_role_origin: str

class gws.plugin.qfieldcloud.api.ProjectCollaborator(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

collaborator: str

created_at: datetime.datetime

created_by: str

project_id: str

role: ProjectCollaboratorRoleEnum | None

updated_at: datetime.datetime

updated_by: str

class gws.plugin.qfieldcloud.api.ProjectCollaboratorRoleEnum(*args, **kwds)

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

admin = 'admin'

editor = 'editor'

manager = 'manager'

reader = 'reader'

reporter = 'reporter'

class gws.plugin.qfieldcloud.api.ProjectStatusEnum(*args, **kwds)

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

busy = 'busy'

failed = 'failed'

ok = 'ok'

class gws.plugin.qfieldcloud.api.PublicInfoUser(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

avatar_url: str

full_name: str

type: int

username: str

username_display: str

class gws.plugin.qfieldcloud.api.StoredDelta(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

client_id: str

content: dict

created_at: str

created_by: str

deltafile_id: str

id: str

last_feedback: dict | None

last_status: str

output: dict | None

status: str

updated_at: str

class gws.plugin.qfieldcloud.api.Team(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

members: List[str]

organization: str

team: str

class gws.plugin.qfieldcloud.api.TeamMember(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

member: str

class gws.plugin.qfieldcloud.api.TypeEnum(*args, **kwds)

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

delta_apply = 'delta_apply'

package = 'package'

process_projectfile = 'process_projectfile'

class gws.plugin.qfieldcloud.api.UserType(*args, **kwds)

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

organization = 2

person = 1

team = 3