Skip to content

Latest commit

 

History

History
1941 lines (1187 loc) · 65.3 KB

TenancyApi.md

File metadata and controls

1941 lines (1187 loc) · 65.3 KB

\TenancyApi

All URIs are relative to http://localhost:8000/api

Method HTTP request Description
tenancy_contact_assignments_bulk_delete DELETE /tenancy/contact-assignments/
tenancy_contact_assignments_bulk_partial_update PATCH /tenancy/contact-assignments/
tenancy_contact_assignments_bulk_update PUT /tenancy/contact-assignments/
tenancy_contact_assignments_create POST /tenancy/contact-assignments/
tenancy_contact_assignments_delete DELETE /tenancy/contact-assignments/{id}/
tenancy_contact_assignments_list GET /tenancy/contact-assignments/
tenancy_contact_assignments_partial_update PATCH /tenancy/contact-assignments/{id}/
tenancy_contact_assignments_read GET /tenancy/contact-assignments/{id}/
tenancy_contact_assignments_update PUT /tenancy/contact-assignments/{id}/
tenancy_contact_groups_bulk_delete DELETE /tenancy/contact-groups/
tenancy_contact_groups_bulk_partial_update PATCH /tenancy/contact-groups/
tenancy_contact_groups_bulk_update PUT /tenancy/contact-groups/
tenancy_contact_groups_create POST /tenancy/contact-groups/
tenancy_contact_groups_delete DELETE /tenancy/contact-groups/{id}/
tenancy_contact_groups_list GET /tenancy/contact-groups/
tenancy_contact_groups_partial_update PATCH /tenancy/contact-groups/{id}/
tenancy_contact_groups_read GET /tenancy/contact-groups/{id}/
tenancy_contact_groups_update PUT /tenancy/contact-groups/{id}/
tenancy_contact_roles_bulk_delete DELETE /tenancy/contact-roles/
tenancy_contact_roles_bulk_partial_update PATCH /tenancy/contact-roles/
tenancy_contact_roles_bulk_update PUT /tenancy/contact-roles/
tenancy_contact_roles_create POST /tenancy/contact-roles/
tenancy_contact_roles_delete DELETE /tenancy/contact-roles/{id}/
tenancy_contact_roles_list GET /tenancy/contact-roles/
tenancy_contact_roles_partial_update PATCH /tenancy/contact-roles/{id}/
tenancy_contact_roles_read GET /tenancy/contact-roles/{id}/
tenancy_contact_roles_update PUT /tenancy/contact-roles/{id}/
tenancy_contacts_bulk_delete DELETE /tenancy/contacts/
tenancy_contacts_bulk_partial_update PATCH /tenancy/contacts/
tenancy_contacts_bulk_update PUT /tenancy/contacts/
tenancy_contacts_create POST /tenancy/contacts/
tenancy_contacts_delete DELETE /tenancy/contacts/{id}/
tenancy_contacts_list GET /tenancy/contacts/
tenancy_contacts_partial_update PATCH /tenancy/contacts/{id}/
tenancy_contacts_read GET /tenancy/contacts/{id}/
tenancy_contacts_update PUT /tenancy/contacts/{id}/
tenancy_tenant_groups_bulk_delete DELETE /tenancy/tenant-groups/
tenancy_tenant_groups_bulk_partial_update PATCH /tenancy/tenant-groups/
tenancy_tenant_groups_bulk_update PUT /tenancy/tenant-groups/
tenancy_tenant_groups_create POST /tenancy/tenant-groups/
tenancy_tenant_groups_delete DELETE /tenancy/tenant-groups/{id}/
tenancy_tenant_groups_list GET /tenancy/tenant-groups/
tenancy_tenant_groups_partial_update PATCH /tenancy/tenant-groups/{id}/
tenancy_tenant_groups_read GET /tenancy/tenant-groups/{id}/
tenancy_tenant_groups_update PUT /tenancy/tenant-groups/{id}/
tenancy_tenants_bulk_delete DELETE /tenancy/tenants/
tenancy_tenants_bulk_partial_update PATCH /tenancy/tenants/
tenancy_tenants_bulk_update PUT /tenancy/tenants/
tenancy_tenants_create POST /tenancy/tenants/
tenancy_tenants_delete DELETE /tenancy/tenants/{id}/
tenancy_tenants_list GET /tenancy/tenants/
tenancy_tenants_partial_update PATCH /tenancy/tenants/{id}/
tenancy_tenants_read GET /tenancy/tenants/{id}/
tenancy_tenants_update PUT /tenancy/tenants/{id}/

tenancy_contact_assignments_bulk_delete

tenancy_contact_assignments_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_assignments_bulk_partial_update

crate::models::ContactAssignment tenancy_contact_assignments_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableContactAssignment [required]

Return type

crate::models::ContactAssignment

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_assignments_bulk_update

crate::models::ContactAssignment tenancy_contact_assignments_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableContactAssignment [required]

Return type

crate::models::ContactAssignment

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_assignments_create

crate::models::ContactAssignment tenancy_contact_assignments_create(data)

Parameters

Name Type Description Required Notes
data WritableContactAssignment [required]

Return type

crate::models::ContactAssignment

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_assignments_delete

tenancy_contact_assignments_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact assignment. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_assignments_list

crate::models::TenancyContactAssignmentsList200Response tenancy_contact_assignments_list(id, content_type_id, object_id, priority, created, last_updated, content_type, contact_id, role_id, role, id__n, id__lte, id__lt, id__gte, id__gt, content_type_id__n, object_id__n, object_id__lte, object_id__lt, object_id__gte, object_id__gt, priority__n, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, content_type__n, contact_id__n, role_id__n, role__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
content_type_id Option<String>
object_id Option<String>
priority Option<String>
created Option<String>
last_updated Option<String>
content_type Option<String>
contact_id Option<String>
role_id Option<String>
role Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
content_type_id__n Option<String>
object_id__n Option<String>
object_id__lte Option<String>
object_id__lt Option<String>
object_id__gte Option<String>
object_id__gt Option<String>
priority__n Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
content_type__n Option<String>
contact_id__n Option<String>
role_id__n Option<String>
role__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::TenancyContactAssignmentsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_assignments_partial_update

crate::models::ContactAssignment tenancy_contact_assignments_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact assignment. [required]
data WritableContactAssignment [required]

Return type

crate::models::ContactAssignment

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_assignments_read

crate::models::ContactAssignment tenancy_contact_assignments_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact assignment. [required]

Return type

crate::models::ContactAssignment

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_assignments_update

crate::models::ContactAssignment tenancy_contact_assignments_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact assignment. [required]
data WritableContactAssignment [required]

Return type

crate::models::ContactAssignment

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_groups_bulk_delete

tenancy_contact_groups_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_groups_bulk_partial_update

crate::models::ContactGroup tenancy_contact_groups_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableContactGroup [required]

Return type

crate::models::ContactGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_groups_bulk_update

crate::models::ContactGroup tenancy_contact_groups_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableContactGroup [required]

Return type

crate::models::ContactGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_groups_create

crate::models::ContactGroup tenancy_contact_groups_create(data)

Parameters

Name Type Description Required Notes
data WritableContactGroup [required]

Return type

crate::models::ContactGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_groups_delete

tenancy_contact_groups_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact group. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_groups_list

crate::models::TenancyContactGroupsList200Response tenancy_contact_groups_list(id, name, slug, description, created, last_updated, q, tag, parent_id, parent, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, slug__n, slug__ic, slug__nic, slug__iew, slug__niew, slug__isw, slug__nisw, slug__ie, slug__nie, slug__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, parent_id__n, parent__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
slug Option<String>
description Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
parent_id Option<String>
parent Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
slug__n Option<String>
slug__ic Option<String>
slug__nic Option<String>
slug__iew Option<String>
slug__niew Option<String>
slug__isw Option<String>
slug__nisw Option<String>
slug__ie Option<String>
slug__nie Option<String>
slug__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
parent_id__n Option<String>
parent__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::TenancyContactGroupsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_groups_partial_update

crate::models::ContactGroup tenancy_contact_groups_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact group. [required]
data WritableContactGroup [required]

Return type

crate::models::ContactGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_groups_read

crate::models::ContactGroup tenancy_contact_groups_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact group. [required]

Return type

crate::models::ContactGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_groups_update

crate::models::ContactGroup tenancy_contact_groups_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact group. [required]
data WritableContactGroup [required]

Return type

crate::models::ContactGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_roles_bulk_delete

tenancy_contact_roles_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_roles_bulk_partial_update

crate::models::ContactRole tenancy_contact_roles_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data ContactRole [required]

Return type

crate::models::ContactRole

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_roles_bulk_update

crate::models::ContactRole tenancy_contact_roles_bulk_update(data)

Parameters

Name Type Description Required Notes
data ContactRole [required]

Return type

crate::models::ContactRole

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_roles_create

crate::models::ContactRole tenancy_contact_roles_create(data)

Parameters

Name Type Description Required Notes
data ContactRole [required]

Return type

crate::models::ContactRole

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_roles_delete

tenancy_contact_roles_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact role. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_roles_list

crate::models::TenancyContactRolesList200Response tenancy_contact_roles_list(id, name, slug, description, created, last_updated, q, tag, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, slug__n, slug__ic, slug__nic, slug__iew, slug__niew, slug__isw, slug__nisw, slug__ie, slug__nie, slug__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
slug Option<String>
description Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
slug__n Option<String>
slug__ic Option<String>
slug__nic Option<String>
slug__iew Option<String>
slug__niew Option<String>
slug__isw Option<String>
slug__nisw Option<String>
slug__ie Option<String>
slug__nie Option<String>
slug__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::TenancyContactRolesList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_roles_partial_update

crate::models::ContactRole tenancy_contact_roles_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact role. [required]
data ContactRole [required]

Return type

crate::models::ContactRole

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_roles_read

crate::models::ContactRole tenancy_contact_roles_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact role. [required]

Return type

crate::models::ContactRole

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contact_roles_update

crate::models::ContactRole tenancy_contact_roles_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact role. [required]
data ContactRole [required]

Return type

crate::models::ContactRole

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contacts_bulk_delete

tenancy_contacts_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contacts_bulk_partial_update

crate::models::Contact tenancy_contacts_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableContact [required]

Return type

crate::models::Contact

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contacts_bulk_update

crate::models::Contact tenancy_contacts_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableContact [required]

Return type

crate::models::Contact

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contacts_create

crate::models::Contact tenancy_contacts_create(data)

Parameters

Name Type Description Required Notes
data WritableContact [required]

Return type

crate::models::Contact

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contacts_delete

tenancy_contacts_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contacts_list

crate::models::TenancyContactsList200Response tenancy_contacts_list(id, name, title, phone, email, address, link, created, last_updated, q, tag, group_id, group, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, title__n, title__ic, title__nic, title__iew, title__niew, title__isw, title__nisw, title__ie, title__nie, title__empty, phone__n, phone__ic, phone__nic, phone__iew, phone__niew, phone__isw, phone__nisw, phone__ie, phone__nie, phone__empty, email__n, email__ic, email__nic, email__iew, email__niew, email__isw, email__nisw, email__ie, email__nie, email__empty, address__n, address__ic, address__nic, address__iew, address__niew, address__isw, address__nisw, address__ie, address__nie, address__empty, link__n, link__ic, link__nic, link__iew, link__niew, link__isw, link__nisw, link__ie, link__nie, link__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, group_id__n, group__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
title Option<String>
phone Option<String>
email Option<String>
address Option<String>
link Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
group_id Option<String>
group Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
title__n Option<String>
title__ic Option<String>
title__nic Option<String>
title__iew Option<String>
title__niew Option<String>
title__isw Option<String>
title__nisw Option<String>
title__ie Option<String>
title__nie Option<String>
title__empty Option<String>
phone__n Option<String>
phone__ic Option<String>
phone__nic Option<String>
phone__iew Option<String>
phone__niew Option<String>
phone__isw Option<String>
phone__nisw Option<String>
phone__ie Option<String>
phone__nie Option<String>
phone__empty Option<String>
email__n Option<String>
email__ic Option<String>
email__nic Option<String>
email__iew Option<String>
email__niew Option<String>
email__isw Option<String>
email__nisw Option<String>
email__ie Option<String>
email__nie Option<String>
email__empty Option<String>
address__n Option<String>
address__ic Option<String>
address__nic Option<String>
address__iew Option<String>
address__niew Option<String>
address__isw Option<String>
address__nisw Option<String>
address__ie Option<String>
address__nie Option<String>
address__empty Option<String>
link__n Option<String>
link__ic Option<String>
link__nic Option<String>
link__iew Option<String>
link__niew Option<String>
link__isw Option<String>
link__nisw Option<String>
link__ie Option<String>
link__nie Option<String>
link__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
group_id__n Option<String>
group__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::TenancyContactsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contacts_partial_update

crate::models::Contact tenancy_contacts_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact. [required]
data WritableContact [required]

Return type

crate::models::Contact

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contacts_read

crate::models::Contact tenancy_contacts_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact. [required]

Return type

crate::models::Contact

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_contacts_update

crate::models::Contact tenancy_contacts_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this contact. [required]
data WritableContact [required]

Return type

crate::models::Contact

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenant_groups_bulk_delete

tenancy_tenant_groups_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenant_groups_bulk_partial_update

crate::models::TenantGroup tenancy_tenant_groups_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableTenantGroup [required]

Return type

crate::models::TenantGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenant_groups_bulk_update

crate::models::TenantGroup tenancy_tenant_groups_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableTenantGroup [required]

Return type

crate::models::TenantGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenant_groups_create

crate::models::TenantGroup tenancy_tenant_groups_create(data)

Parameters

Name Type Description Required Notes
data WritableTenantGroup [required]

Return type

crate::models::TenantGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenant_groups_delete

tenancy_tenant_groups_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tenant group. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenant_groups_list

crate::models::TenancyTenantGroupsList200Response tenancy_tenant_groups_list(id, name, slug, description, created, last_updated, q, tag, parent_id, parent, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, slug__n, slug__ic, slug__nic, slug__iew, slug__niew, slug__isw, slug__nisw, slug__ie, slug__nie, slug__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, parent_id__n, parent__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
slug Option<String>
description Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
parent_id Option<String>
parent Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
slug__n Option<String>
slug__ic Option<String>
slug__nic Option<String>
slug__iew Option<String>
slug__niew Option<String>
slug__isw Option<String>
slug__nisw Option<String>
slug__ie Option<String>
slug__nie Option<String>
slug__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
parent_id__n Option<String>
parent__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::TenancyTenantGroupsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenant_groups_partial_update

crate::models::TenantGroup tenancy_tenant_groups_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tenant group. [required]
data WritableTenantGroup [required]

Return type

crate::models::TenantGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenant_groups_read

crate::models::TenantGroup tenancy_tenant_groups_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tenant group. [required]

Return type

crate::models::TenantGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenant_groups_update

crate::models::TenantGroup tenancy_tenant_groups_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tenant group. [required]
data WritableTenantGroup [required]

Return type

crate::models::TenantGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenants_bulk_delete

tenancy_tenants_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenants_bulk_partial_update

crate::models::Tenant tenancy_tenants_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableTenant [required]

Return type

crate::models::Tenant

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenants_bulk_update

crate::models::Tenant tenancy_tenants_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableTenant [required]

Return type

crate::models::Tenant

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenants_create

crate::models::Tenant tenancy_tenants_create(data)

Parameters

Name Type Description Required Notes
data WritableTenant [required]

Return type

crate::models::Tenant

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenants_delete

tenancy_tenants_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tenant. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenants_list

crate::models::TenancyTenantsList200Response tenancy_tenants_list(id, name, slug, description, created, last_updated, q, tag, contact, contact_role, contact_group, group_id, group, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, slug__n, slug__ic, slug__nic, slug__iew, slug__niew, slug__isw, slug__nisw, slug__ie, slug__nie, slug__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, contact__n, contact_role__n, contact_group__n, group_id__n, group__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
slug Option<String>
description Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
contact Option<String>
contact_role Option<String>
contact_group Option<String>
group_id Option<String>
group Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
slug__n Option<String>
slug__ic Option<String>
slug__nic Option<String>
slug__iew Option<String>
slug__niew Option<String>
slug__isw Option<String>
slug__nisw Option<String>
slug__ie Option<String>
slug__nie Option<String>
slug__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
contact__n Option<String>
contact_role__n Option<String>
contact_group__n Option<String>
group_id__n Option<String>
group__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::TenancyTenantsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenants_partial_update

crate::models::Tenant tenancy_tenants_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tenant. [required]
data WritableTenant [required]

Return type

crate::models::Tenant

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenants_read

crate::models::Tenant tenancy_tenants_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tenant. [required]

Return type

crate::models::Tenant

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenancy_tenants_update

crate::models::Tenant tenancy_tenants_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tenant. [required]
data WritableTenant [required]

Return type

crate::models::Tenant

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]