🔍 Code Extractor

class SyntexBillingContext

Maturity: 31

SyntexBillingContext is a client value class representing billing context information for Microsoft SharePoint Syntex tenant administration.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/syntex/billing_context.py
Lines:
4 - 9
Complexity:
simple

Purpose

This class serves as a data transfer object (DTO) for SharePoint Syntex billing-related operations within the Microsoft Online SharePoint Tenant Administration API. It inherits from ClientValue, which is part of the Office365 REST API Python client library, and provides a typed representation of billing context data that can be serialized/deserialized when communicating with SharePoint Online services. The class is primarily used to encapsulate billing information for Syntex features in SharePoint tenant administration scenarios.

Source Code

class SyntexBillingContext(ClientValue):
    """"""

    @property
    def entity_type_name(self):
        return "Microsoft.Online.SharePoint.TenantAdministration.SyntexBillingContext"

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

__init__: The constructor parameters are inherited from ClientValue base class. Typically accepts keyword arguments that map to properties of the entity type. No explicit constructor is defined in this class, so it uses the parent ClientValue constructor which generally accepts property values as keyword arguments.

Return Value

Instantiating this class returns a SyntexBillingContext object that represents a billing context entity. The entity_type_name property returns a string value 'Microsoft.Online.SharePoint.TenantAdministration.SyntexBillingContext' which identifies the entity type in the SharePoint API schema.

Class Interface

Methods

@property entity_type_name(self) -> str property

Purpose: Returns the fully qualified entity type name used by the SharePoint API to identify this entity type in the metadata schema

Returns: A string containing 'Microsoft.Online.SharePoint.TenantAdministration.SyntexBillingContext' which is the entity type identifier

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the entity type name for SharePoint API schema identification. Value is always 'Microsoft.Online.SharePoint.TenantAdministration.SyntexBillingContext' instance

Dependencies

  • office365-rest-python-client

Required Imports

from office365.runtime.client_value import ClientValue
from office365.sharepoint.tenant.administration.syntex_billing_context import SyntexBillingContext

Usage Example

from office365.sharepoint.tenant.administration.syntex_billing_context import SyntexBillingContext
from office365.sharepoint.client_context import ClientContext
from office365.runtime.auth.user_credential import UserCredential

# Authenticate to SharePoint
tenant_url = 'https://contoso-admin.sharepoint.com'
credentials = UserCredential('admin@contoso.com', 'password')
ctx = ClientContext(tenant_url).with_credentials(credentials)

# Create a billing context instance
billing_context = SyntexBillingContext()

# The entity_type_name property identifies the type
print(billing_context.entity_type_name)
# Output: Microsoft.Online.SharePoint.TenantAdministration.SyntexBillingContext

# Typically used in API calls for Syntex billing operations
# The object would be populated with billing data and sent to/received from SharePoint APIs

Best Practices

  • This class is a data container (DTO) and should not contain business logic
  • Instances are typically created and populated by the Office365 REST client library when deserializing API responses
  • When creating instances manually, ensure property names match the expected SharePoint API schema
  • The entity_type_name property should not be modified as it identifies the entity type in the SharePoint API
  • This class is immutable in terms of its type identity - the entity_type_name always returns the same value
  • Use this class in conjunction with SharePoint tenant administration context for Syntex billing operations
  • Ensure proper authentication and permissions before attempting to use this in API calls

Tags

sharepoint syntex billing tenant-administration client-value dto office365 microsoft-online rest-api

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class ContextCondition 64.1% similar

    A data class representing context conditions for a tenant in Microsoft Office Server Search REST API, containing properties for context condition type and source identifier.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/context_condition.py

  • class SharePointHomePageContext 63.9% similar

    A client value class representing the context for a SharePoint home page, used for serialization and communication with SharePoint Portal Home services.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/portal/home/page_context.py

  • class OrgLabelsContext 63.8% similar

    OrgLabelsContext is a client value class representing organizational labels context in SharePoint Portal, inheriting from ClientValue base class.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/portal/orglabels/context.py

  • class ClientContext 62.8% similar

    SharePoint client context (SharePoint v1 API)

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/client_context.py

  • class GroupCreationContext 62.3% similar

    A client value class representing the context for creating a SharePoint group, inheriting from ClientValue base class.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/portal/groups/creation_context.py
← Back to Browse