solvimon-python-sdk 0.0.4b0__py3-none-any.whl

solvimon_python_sdk/models/pricing_plan_subscription.py

@@ -0,0 +1,396 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from solvimon_python_sdk.models.billing_entity import BillingEntity
+from solvimon_python_sdk.models.custom_field_value import CustomFieldValue
+from solvimon_python_sdk.models.customer import Customer
+from solvimon_python_sdk.models.due_date import DueDate
+from solvimon_python_sdk.models.inactive_period import InactivePeriod
+from solvimon_python_sdk.models.linked_integration import LinkedIntegration
+from solvimon_python_sdk.models.next_invoice import NextInvoice
+from solvimon_python_sdk.models.payment_acceptor import PaymentAcceptor
+from solvimon_python_sdk.models.period import Period
+from solvimon_python_sdk.models.pricing_plan_schedule_info import PricingPlanScheduleInfo
+from solvimon_python_sdk.models.pricing_plan_subscription_group import PricingPlanSubscriptionGroup
+from solvimon_python_sdk.models.seller_details import SellerDetails
+from solvimon_python_sdk.models.template_pricing_plan_subscription import TemplatePricingPlanSubscription
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class PricingPlanSubscription(BaseModel):
+    """
+    PricingPlanSubscription
+    """ # noqa: E501
+    object_type: Optional[StrictStr] = None
+    id: Optional[StrictStr] = None
+    created_at: Optional[StrictStr] = None
+    updated_at: Optional[StrictStr] = None
+    activated_at: Optional[StrictStr] = None
+    status: Optional[StrictStr] = Field(default=None, description="The status of the subscription.")
+    reference: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=256)]] = None
+    name: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=256)]] = None
+    purchase_order_number: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=256)]] = Field(default=None, description="The uniquely assigned purchase order number.")
+    customer_id: Optional[StrictStr] = Field(default=None, description="The ID of the customer.")
+    customer_reference: Optional[StrictStr] = Field(default=None, description="The reference of the customer.")
+    customer: Optional[Customer] = None
+    billing_entity_id: Optional[StrictStr] = Field(default=None, description="The resource ID of the billing entity that is assigned to the subscription. If not set, the default platform value will be taken.")
+    billing_entity_reference: Optional[StrictStr] = Field(default=None, description="The reference of the billing entity that is assigned to the subscription. If not set, the default platform value will be taken.")
+    billing_entity: Optional[BillingEntity] = None
+    billing_period: Optional[Period] = Field(default=None, description="The period of the invoice. If not set, the default (platform) value will be taken.")
+    billing_currency: Optional[StrictStr] = Field(default=None, description="The alphabetic currency code representing the type of currency used for billing. If not set, the default (platform) value will be taken.")
+    due_date_configuration: Optional[DueDate] = Field(default=None, description="The configuration of the due date of the invoices in the subscriptions. If not set, the default (platform) value will be taken.")
+    initial_term: Optional[Period] = Field(default=None, description="The initial term for the agreement.")
+    renewal_term: Optional[Period] = Field(default=None, description="The renewal term after the initial term.")
+    auto_renewal: Optional[StrictBool] = Field(default=None, description="Indicates if the subscription renews automatically.")
+    type: Optional[StrictStr] = None
+    variant: Optional[StrictStr] = None
+    billing_time: Optional[StrictStr] = Field(default=None, description="The moment the invoices for the subscription should be created. If not set, the default platform value will be taken.")
+    combine: Optional[StrictBool] = Field(default=None, description="Indication whether invoices of different subscriptions should be combined, if possible. If not set, the default platform value will be taken.")
+    quote_version_id: Optional[StrictStr] = Field(default=None, description="The reference to the version of the quote where the subscription is linked to.")
+    upgraded_from_pricing_plan_subscription_id: Optional[StrictStr] = Field(default=None, description="The resource ID of the subscription that this subscription is upgraded from.")
+    upgraded_to_pricing_plan_subscription_id: Optional[StrictStr] = Field(default=None, description="The resource ID of the subscription that this subscription is upgraded to.")
+    payment_acceptor_ids: Optional[List[StrictStr]] = Field(default=None, description="The resource ID(s) of the specific payment acceptors for the subscription")
+    payment_acceptors: Optional[List[PaymentAcceptor]] = None
+    pricing_plan_schedule_infos: Optional[List[PricingPlanScheduleInfo]] = Field(default=None, description="Pricing plan schedule infos linked to this subscription. Only the ACTIVE ones.")
+    pending_review_pricing_plan_schedule_ids: Optional[List[StrictStr]] = Field(default=None, description="The resource IDs of the pricing plan schedules pending review, ordered by start_at.")
+    description: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=256)]] = None
+    custom_fields: Optional[List[CustomFieldValue]] = None
+    init_invoice_on_hold: Optional[StrictBool] = None
+    payment_method_id: Optional[StrictStr] = Field(default=None, description="The ID of the payment method to be used to pay for invoices of this subscription.")
+    pricing_plan_subscription_group_id: Optional[StrictStr] = Field(default=None, description="The resource ID of the pricing plan subscription group where the subscription is part of")
+    pricing_plan_subscription_group: Optional[PricingPlanSubscriptionGroup] = None
+    forward_customer_id: Optional[StrictStr] = Field(default=None, description="The reference to the customer that needs to be used for the invoice (for FORWARD_BILLING)")
+    forward_customer: Optional[Customer] = None
+    inactive_periods: Optional[List[InactivePeriod]] = None
+    display_invoice_sub_lines_per_processing_only_customer: Optional[StrictBool] = None
+    replicate_meter_data_ingest_to_parent: Optional[StrictBool] = None
+    show_original_customer_invoice_line: Optional[StrictBool] = Field(default=None, description="Show an invoice line per (child) customer on the invoice of the `forward_customer_id`. Defaults to the platform setting. Only supported for variant FORWARD_BILLING")
+    show_tax_per_line_item: Optional[StrictBool] = Field(default=None, description="Show the tax per line item on the invoice. When not provided or `true`, the tax is shown per invoice line. When `false`, the tax is only summarized (per tax rate) at the invoice total. This is a display only setting; the tax is always calculated per line item")
+    sales_tax_percentage: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=256)]] = Field(default=None, description="Sales tax for this subscription. If provided, it will override the tax for all items on the invoice. Mandatory for US to US billing when there's no external tax integration. Optional otherwise")
+    next_invoice: Optional[NextInvoice] = None
+    template: Optional[TemplatePricingPlanSubscription] = Field(default=None, description="The configuration fields that can be used when having a template subscription.")
+    linked_integrations: Optional[List[LinkedIntegration]] = None
+    seller_details: Optional[SellerDetails] = None
+    __properties: ClassVar[List[str]] = ["object_type", "id", "created_at", "updated_at", "activated_at", "status", "reference", "name", "purchase_order_number", "customer_id", "customer_reference", "customer", "billing_entity_id", "billing_entity_reference", "billing_entity", "billing_period", "billing_currency", "due_date_configuration", "initial_term", "renewal_term", "auto_renewal", "type", "variant", "billing_time", "combine", "quote_version_id", "upgraded_from_pricing_plan_subscription_id", "upgraded_to_pricing_plan_subscription_id", "payment_acceptor_ids", "payment_acceptors", "pricing_plan_schedule_infos", "pending_review_pricing_plan_schedule_ids", "description", "custom_fields", "init_invoice_on_hold", "payment_method_id", "pricing_plan_subscription_group_id", "pricing_plan_subscription_group", "forward_customer_id", "forward_customer", "inactive_periods", "display_invoice_sub_lines_per_processing_only_customer", "replicate_meter_data_ingest_to_parent", "show_original_customer_invoice_line", "show_tax_per_line_item", "sales_tax_percentage", "next_invoice", "template", "linked_integrations", "seller_details"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['DRAFT', 'ACTIVE', 'VOID', 'ARCHIVED', 'CANCELLED']):
+            raise ValueError("must be one of enum values ('DRAFT', 'ACTIVE', 'VOID', 'ARCHIVED', 'CANCELLED')")
+        return value
+
+    @field_validator('reference', mode="before")
+    def reference_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if isinstance(value, str) and not re.match(r"^\S+$", value):
+            raise ValueError(r"must validate the regular expression /^\S+$/")
+        return value
+
+    @field_validator('name', mode="before")
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if isinstance(value, str) and not re.match(r"^.*$", value):
+            raise ValueError(r"must validate the regular expression /^.*$/")
+        return value
+
+    @field_validator('purchase_order_number', mode="before")
+    def purchase_order_number_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if isinstance(value, str) and not re.match(r"^[a-zA-Z0-9!#$%&-_.*\s]*$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9!#$%&-_.*\s]*$/")
+        return value
+
+    @field_validator('billing_currency')
+    def billing_currency_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHF', 'CLF', 'CLP', 'CNY', 'COP', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'USN', 'UYI', 'UYU', 'UZS', 'VEF', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']):
+            raise ValueError("must be one of enum values ('AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHF', 'CLF', 'CLP', 'CNY', 'COP', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'USN', 'UYI', 'UYU', 'UZS', 'VEF', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL')")
+        return value
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['QUOTE', 'BILLING', 'TEMPLATE']):
+            raise ValueError("must be one of enum values ('QUOTE', 'BILLING', 'TEMPLATE')")
+        return value
+
+    @field_validator('variant')
+    def variant_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['DEFAULT', 'FORWARD_BILLING', 'SELF_BILLING', 'SELLER']):
+            raise ValueError("must be one of enum values ('DEFAULT', 'FORWARD_BILLING', 'SELF_BILLING', 'SELLER')")
+        return value
+
+    @field_validator('billing_time')
+    def billing_time_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['EXACT', 'CALENDAR']):
+            raise ValueError("must be one of enum values ('EXACT', 'CALENDAR')")
+        return value
+
+    @field_validator('description', mode="before")
+    def description_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if isinstance(value, str) and not re.match(r"^.*$", value):
+            raise ValueError(r"must validate the regular expression /^.*$/")
+        return value
+
+    @field_validator('sales_tax_percentage', mode="before")
+    def sales_tax_percentage_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if isinstance(value, str) and not re.match(r"^\S+$", value):
+            raise ValueError(r"must validate the regular expression /^\S+$/")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PricingPlanSubscription from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "object_type",
+            "id",
+            "created_at",
+            "updated_at",
+            "activated_at",
+            "customer",
+            "billing_entity",
+            "upgraded_from_pricing_plan_subscription_id",
+            "upgraded_to_pricing_plan_subscription_id",
+            "payment_acceptors",
+            "pricing_plan_schedule_infos",
+            "pending_review_pricing_plan_schedule_ids",
+            "pricing_plan_subscription_group",
+            "forward_customer",
+            "inactive_periods",
+            "next_invoice",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of customer
+        if self.customer:
+            _dict['customer'] = self.customer.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of billing_entity
+        if self.billing_entity:
+            _dict['billing_entity'] = self.billing_entity.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of billing_period
+        if self.billing_period:
+            _dict['billing_period'] = self.billing_period.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of due_date_configuration
+        if self.due_date_configuration:
+            _dict['due_date_configuration'] = self.due_date_configuration.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of initial_term
+        if self.initial_term:
+            _dict['initial_term'] = self.initial_term.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of renewal_term
+        if self.renewal_term:
+            _dict['renewal_term'] = self.renewal_term.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in payment_acceptors (list)
+        _items = []
+        if self.payment_acceptors:
+            for _item_payment_acceptors in self.payment_acceptors:
+                _items.append(_item_payment_acceptors.to_dict() if _item_payment_acceptors is not None else None)
+            _dict['payment_acceptors'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in pricing_plan_schedule_infos (list)
+        _items = []
+        if self.pricing_plan_schedule_infos:
+            for _item_pricing_plan_schedule_infos in self.pricing_plan_schedule_infos:
+                _items.append(_item_pricing_plan_schedule_infos.to_dict() if _item_pricing_plan_schedule_infos is not None else None)
+            _dict['pricing_plan_schedule_infos'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list)
+        _items = []
+        if self.custom_fields:
+            for _item_custom_fields in self.custom_fields:
+                _items.append(_item_custom_fields.to_dict() if _item_custom_fields is not None else None)
+            _dict['custom_fields'] = _items
+        # override the default output from pydantic by calling `to_dict()` of pricing_plan_subscription_group
+        if self.pricing_plan_subscription_group:
+            _dict['pricing_plan_subscription_group'] = self.pricing_plan_subscription_group.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of forward_customer
+        if self.forward_customer:
+            _dict['forward_customer'] = self.forward_customer.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in inactive_periods (list)
+        _items = []
+        if self.inactive_periods:
+            for _item_inactive_periods in self.inactive_periods:
+                _items.append(_item_inactive_periods.to_dict() if _item_inactive_periods is not None else None)
+            _dict['inactive_periods'] = _items
+        # override the default output from pydantic by calling `to_dict()` of next_invoice
+        if self.next_invoice:
+            _dict['next_invoice'] = self.next_invoice.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of template
+        if self.template:
+            _dict['template'] = self.template.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in linked_integrations (list)
+        _items = []
+        if self.linked_integrations:
+            for _item_linked_integrations in self.linked_integrations:
+                _items.append(_item_linked_integrations.to_dict() if _item_linked_integrations is not None else None)
+            _dict['linked_integrations'] = _items
+        # override the default output from pydantic by calling `to_dict()` of seller_details
+        if self.seller_details:
+            _dict['seller_details'] = self.seller_details.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PricingPlanSubscription from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "object_type": obj.get("object_type"),
+            "id": obj.get("id"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "activated_at": obj.get("activated_at"),
+            "status": obj.get("status"),
+            "reference": obj.get("reference"),
+            "name": obj.get("name"),
+            "purchase_order_number": obj.get("purchase_order_number"),
+            "customer_id": obj.get("customer_id"),
+            "customer_reference": obj.get("customer_reference"),
+            "customer": Customer.from_dict(obj["customer"]) if obj.get("customer") is not None else None,
+            "billing_entity_id": obj.get("billing_entity_id"),
+            "billing_entity_reference": obj.get("billing_entity_reference"),
+            "billing_entity": BillingEntity.from_dict(obj["billing_entity"]) if obj.get("billing_entity") is not None else None,
+            "billing_period": Period.from_dict(obj["billing_period"]) if obj.get("billing_period") is not None else None,
+            "billing_currency": obj.get("billing_currency"),
+            "due_date_configuration": DueDate.from_dict(obj["due_date_configuration"]) if obj.get("due_date_configuration") is not None else None,
+            "initial_term": Period.from_dict(obj["initial_term"]) if obj.get("initial_term") is not None else None,
+            "renewal_term": Period.from_dict(obj["renewal_term"]) if obj.get("renewal_term") is not None else None,
+            "auto_renewal": obj.get("auto_renewal"),
+            "type": obj.get("type"),
+            "variant": obj.get("variant"),
+            "billing_time": obj.get("billing_time"),
+            "combine": obj.get("combine"),
+            "quote_version_id": obj.get("quote_version_id"),
+            "upgraded_from_pricing_plan_subscription_id": obj.get("upgraded_from_pricing_plan_subscription_id"),
+            "upgraded_to_pricing_plan_subscription_id": obj.get("upgraded_to_pricing_plan_subscription_id"),
+            "payment_acceptor_ids": obj.get("payment_acceptor_ids"),
+            "payment_acceptors": [PaymentAcceptor.from_dict(_item) for _item in obj["payment_acceptors"]] if obj.get("payment_acceptors") is not None else None,
+            "pricing_plan_schedule_infos": [PricingPlanScheduleInfo.from_dict(_item) for _item in obj["pricing_plan_schedule_infos"]] if obj.get("pricing_plan_schedule_infos") is not None else None,
+            "pending_review_pricing_plan_schedule_ids": obj.get("pending_review_pricing_plan_schedule_ids"),
+            "description": obj.get("description"),
+            "custom_fields": [CustomFieldValue.from_dict(_item) for _item in obj["custom_fields"]] if obj.get("custom_fields") is not None else None,
+            "init_invoice_on_hold": obj.get("init_invoice_on_hold"),
+            "payment_method_id": obj.get("payment_method_id"),
+            "pricing_plan_subscription_group_id": obj.get("pricing_plan_subscription_group_id"),
+            "pricing_plan_subscription_group": PricingPlanSubscriptionGroup.from_dict(obj["pricing_plan_subscription_group"]) if obj.get("pricing_plan_subscription_group") is not None else None,
+            "forward_customer_id": obj.get("forward_customer_id"),
+            "forward_customer": Customer.from_dict(obj["forward_customer"]) if obj.get("forward_customer") is not None else None,
+            "inactive_periods": [InactivePeriod.from_dict(_item) for _item in obj["inactive_periods"]] if obj.get("inactive_periods") is not None else None,
+            "display_invoice_sub_lines_per_processing_only_customer": obj.get("display_invoice_sub_lines_per_processing_only_customer"),
+            "replicate_meter_data_ingest_to_parent": obj.get("replicate_meter_data_ingest_to_parent"),
+            "show_original_customer_invoice_line": obj.get("show_original_customer_invoice_line"),
+            "show_tax_per_line_item": obj.get("show_tax_per_line_item"),
+            "sales_tax_percentage": obj.get("sales_tax_percentage"),
+            "next_invoice": NextInvoice.from_dict(obj["next_invoice"]) if obj.get("next_invoice") is not None else None,
+            "template": TemplatePricingPlanSubscription.from_dict(obj["template"]) if obj.get("template") is not None else None,
+            "linked_integrations": [LinkedIntegration.from_dict(_item) for _item in obj["linked_integrations"]] if obj.get("linked_integrations") is not None else None,
+            "seller_details": SellerDetails.from_dict(obj["seller_details"]) if obj.get("seller_details") is not None else None
+        })
+        return _obj
+
+

solvimon_python_sdk/models/pricing_plan_subscription_cancel.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class PricingPlanSubscriptionCancel(BaseModel):
+    """
+    PricingPlanSubscriptionCancel
+    """ # noqa: E501
+    type: Optional[StrictStr] = None
+    cancel_at: Optional[datetime] = None
+    cancel_dunning_actions: Optional[StrictBool] = Field(default=None, description="Whether to cancel dunning actions, requires type NOW")
+    reason: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=1000)]] = Field(default=None, description="Optional free-text reason for cancelling the subscription")
+    __properties: ClassVar[List[str]] = ["type", "cancel_at", "cancel_dunning_actions", "reason"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['NOW', 'NEXT_BILLING_PERIOD', 'AFTER_INITIAL_TERM', 'DATE', 'UNDO']):
+            raise ValueError("must be one of enum values ('NOW', 'NEXT_BILLING_PERIOD', 'AFTER_INITIAL_TERM', 'DATE', 'UNDO')")
+        return value
+
+    @field_validator('reason', mode="before")
+    def reason_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if isinstance(value, str) and not re.match(r"^.*$", value):
+            raise ValueError(r"must validate the regular expression /^.*$/")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PricingPlanSubscriptionCancel from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PricingPlanSubscriptionCancel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "cancel_at": obj.get("cancel_at"),
+            "cancel_dunning_actions": obj.get("cancel_dunning_actions"),
+            "reason": obj.get("reason")
+        })
+        return _obj
+
+

solvimon_python_sdk/models/pricing_plan_subscription_cancel_create_request.py

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class PricingPlanSubscriptionCancelCreateRequest(BaseModel):
+    """
+    PricingPlanSubscriptionCancelCreateRequest
+    """ # noqa: E501
+    type: StrictStr
+    cancel_at: Optional[datetime] = None
+    cancel_dunning_actions: Optional[StrictBool] = Field(default=None, description="Whether to cancel dunning actions, requires type NOW")
+    reason: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=1000)]] = Field(default=None, description="Optional free-text reason for cancelling the subscription")
+    __properties: ClassVar[List[str]] = ["type", "cancel_at", "cancel_dunning_actions", "reason"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['NOW', 'NEXT_BILLING_PERIOD', 'AFTER_INITIAL_TERM', 'DATE', 'UNDO']):
+            raise ValueError("must be one of enum values ('NOW', 'NEXT_BILLING_PERIOD', 'AFTER_INITIAL_TERM', 'DATE', 'UNDO')")
+        return value
+
+    @field_validator('reason', mode="before")
+    def reason_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if isinstance(value, str) and not re.match(r"^.*$", value):
+            raise ValueError(r"must validate the regular expression /^.*$/")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PricingPlanSubscriptionCancelCreateRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PricingPlanSubscriptionCancelCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "cancel_at": obj.get("cancel_at"),
+            "cancel_dunning_actions": obj.get("cancel_dunning_actions"),
+            "reason": obj.get("reason")
+        })
+        return _obj
+
+