diff --git a/LICENSE b/LICENSE index b9181f72..b85cedd2 100644 --- a/LICENSE +++ b/LICENSE @@ -3,7 +3,7 @@ License: The MIT License (MIT) http://opensource.org/licenses/MIT -Copyright (c) 2014 - 2024 APIMATIC Limited +Copyright (c) 2014 - 2025 APIMATIC Limited Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 1d0e279d..64e8f1fc 100644 --- a/README.md +++ b/README.md @@ -27,19 +27,19 @@ curl -u :x -H Accept:application/json -H Content-Type:application/json ## Install the Package -The package is compatible with Python versions `3 >=3.7, <= 3.11`. +The package is compatible with Python versions `3.7+`. Install the package from PyPi using the following pip command: ```bash -pip install maxio-advanced-billing-sdk==6.0.0 +pip install maxio-advanced-billing-sdk==6.1.0 ``` You can also view the package at: -https://pypi.python.org/pypi/maxio-advanced-billing-sdk/6.0.0 +https://pypi.python.org/pypi/maxio-advanced-billing-sdk/6.1.0 ## Initialize the API Client -**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/client.md) +**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/client.md) The following parameters are configurable for the API Client: @@ -55,7 +55,7 @@ The following parameters are configurable for the API Client: | `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try.
**Default: 2** | | `retry_statuses` | `Array of int` | The http statuses on which retry is to be done.
**Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** | | `retry_methods` | `Array of string` | The http methods on which retry is to be done.
**Default: ['GET', 'PUT']** | -| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication | +| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication | The API client can be initialized as follows: @@ -85,46 +85,46 @@ The SDK can be configured to use a different environment for making API calls. A This API uses the following authentication schemes. -* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/auth/basic-authentication.md) +* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/auth/basic-authentication.md) ## List of APIs -* [API Exports](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/api-exports.md) -* [Advance Invoice](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/advance-invoice.md) -* [Billing Portal](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/billing-portal.md) -* [Component Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/component-price-points.md) -* [Custom Fields](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/custom-fields.md) -* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/events-based-billing-segments.md) -* [Payment Profiles](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/payment-profiles.md) -* [Product Families](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/product-families.md) -* [Product Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/product-price-points.md) -* [Proforma Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/proforma-invoices.md) -* [Reason Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/reason-codes.md) -* [Referral Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/referral-codes.md) -* [Sales Commissions](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/sales-commissions.md) -* [Subscription Components](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-components.md) -* [Subscription Groups](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-groups.md) -* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-group-invoice-account.md) -* [Subscription Group Status](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-group-status.md) -* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-invoice-account.md) -* [Subscription Notes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-notes.md) -* [Subscription Products](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-products.md) -* [Subscription Status](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-status.md) -* [Coupons](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/coupons.md) -* [Components](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/components.md) -* [Customers](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/customers.md) -* [Events](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/events.md) -* [Insights](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/insights.md) -* [Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/invoices.md) -* [Offers](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/offers.md) -* [Products](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/products.md) -* [Sites](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/sites.md) -* [Subscriptions](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscriptions.md) -* [Webhooks](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/webhooks.md) +* [API Exports](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/api-exports.md) +* [Advance Invoice](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/advance-invoice.md) +* [Billing Portal](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/billing-portal.md) +* [Component Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/component-price-points.md) +* [Custom Fields](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/custom-fields.md) +* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/events-based-billing-segments.md) +* [Payment Profiles](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/payment-profiles.md) +* [Product Families](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/product-families.md) +* [Product Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/product-price-points.md) +* [Proforma Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/proforma-invoices.md) +* [Reason Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/reason-codes.md) +* [Referral Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/referral-codes.md) +* [Sales Commissions](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/sales-commissions.md) +* [Subscription Components](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-components.md) +* [Subscription Groups](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-groups.md) +* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-group-invoice-account.md) +* [Subscription Group Status](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-group-status.md) +* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-invoice-account.md) +* [Subscription Notes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-notes.md) +* [Subscription Products](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-products.md) +* [Subscription Status](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-status.md) +* [Coupons](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/coupons.md) +* [Components](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/components.md) +* [Customers](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/customers.md) +* [Events](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/events.md) +* [Insights](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/insights.md) +* [Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/invoices.md) +* [Offers](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/offers.md) +* [Products](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/products.md) +* [Sites](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/sites.md) +* [Subscriptions](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscriptions.md) +* [Webhooks](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/webhooks.md) ## Classes Documentation -* [Utility Classes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/utility-classes.md) -* [HttpResponse](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/http-response.md) -* [HttpRequest](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/http-request.md) +* [Utility Classes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/utility-classes.md) +* [HttpResponse](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/http-response.md) +* [HttpRequest](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/http-request.md) diff --git a/advancedbilling/controllers/advance_invoice_controller.py b/advancedbilling/controllers/advance_invoice_controller.py index 98e3481f..0d556fad 100644 --- a/advancedbilling/controllers/advance_invoice_controller.py +++ b/advancedbilling/controllers/advance_invoice_controller.py @@ -51,8 +51,8 @@ def issue_advance_invoice(self, Args: subscription_id (int): The Chargify id of the subscription - body (IssueAdvanceInvoiceRequest, optional): TODO: type - description here. + body (IssueAdvanceInvoiceRequest, optional): The request body + parameter. Returns: Invoice: Response from the API. Created @@ -149,7 +149,7 @@ def void_advance_invoice(self, Args: subscription_id (int): The Chargify id of the subscription - body (VoidInvoiceRequest, optional): TODO: type description here. + body (VoidInvoiceRequest, optional): The request body parameter. Returns: Invoice: Response from the API. Created diff --git a/advancedbilling/controllers/base_controller.py b/advancedbilling/controllers/base_controller.py index c1ce5d3b..620251b6 100644 --- a/advancedbilling/controllers/base_controller.py +++ b/advancedbilling/controllers/base_controller.py @@ -30,7 +30,7 @@ class BaseController(object): @staticmethod def user_agent(): - return 'AB SDK Python:6.0.0 on OS {os-info}' + return 'AB SDK Python:6.1.0 on OS {os-info}' @staticmethod def user_agent_parameters(): diff --git a/advancedbilling/controllers/component_price_points_controller.py b/advancedbilling/controllers/component_price_points_controller.py index 0245dafa..d9db4853 100644 --- a/advancedbilling/controllers/component_price_points_controller.py +++ b/advancedbilling/controllers/component_price_points_controller.py @@ -97,8 +97,8 @@ def create_component_price_point(self, Args: component_id (int): The Advanced Billing id of the component - body (CreateComponentPricePointRequest, optional): TODO: type - description here. + body (CreateComponentPricePointRequest, optional): The request + body parameter. Returns: ComponentPricePointResponse: Response from the API. OK @@ -235,8 +235,8 @@ def bulk_create_component_price_points(self, Args: component_id (str): The Advanced Billing id of the component for which you want to fetch price points. - body (CreateComponentPricePointsRequest, optional): TODO: type - description here. + body (CreateComponentPricePointsRequest, optional): The request + body parameter. Returns: ComponentPricePointsResponse: Response from the API. OK @@ -300,8 +300,8 @@ def update_component_price_point(self, When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-price_point-handle` for a string handle. - body (UpdateComponentPricePointRequest, optional): TODO: type - description here. + body (UpdateComponentPricePointRequest, optional): The request + body parameter. Returns: ComponentPricePointResponse: Response from the API. OK @@ -529,8 +529,8 @@ def create_currency_prices(self, Args: price_point_id (int): The Advanced Billing id of the price point - body (CreateCurrencyPricesRequest, optional): TODO: type - description here. + body (CreateCurrencyPricesRequest, optional): The request body + parameter. Returns: ComponentCurrencyPricesResponse: Response from the API. OK @@ -581,8 +581,8 @@ def update_currency_prices(self, Args: price_point_id (int): The Advanced Billing id of the price point - body (UpdateCurrencyPricesRequest, optional): TODO: type - description here. + body (UpdateCurrencyPricesRequest, optional): The request body + parameter. Returns: ComponentCurrencyPricesResponse: Response from the API. OK diff --git a/advancedbilling/controllers/components_controller.py b/advancedbilling/controllers/components_controller.py index 6344379c..55ce1b8e 100644 --- a/advancedbilling/controllers/components_controller.py +++ b/advancedbilling/controllers/components_controller.py @@ -51,8 +51,8 @@ def create_metered_component(self, Args: product_family_id (str): Either the product family's id or its handle prefixed with `handle:` - body (CreateMeteredComponent, optional): TODO: type description - here. + body (CreateMeteredComponent, optional): The request body + parameter. Returns: ComponentResponse: Response from the API. Created @@ -121,8 +121,8 @@ def create_quantity_based_component(self, Args: product_family_id (str): Either the product family's id or its handle prefixed with `handle:` - body (CreateQuantityBasedComponent, optional): TODO: type - description here. + body (CreateQuantityBasedComponent, optional): The request body + parameter. Returns: ComponentResponse: Response from the API. Created @@ -179,7 +179,7 @@ def create_on_off_component(self, Args: product_family_id (str): Either the product family's id or its handle prefixed with `handle:` - body (CreateOnOffComponent, optional): TODO: type description here. + body (CreateOnOffComponent, optional): The request body parameter. Returns: ComponentResponse: Response from the API. Created @@ -240,8 +240,8 @@ def create_prepaid_usage_component(self, Args: product_family_id (str): Either the product family's id or its handle prefixed with `handle:` - body (CreatePrepaidComponent, optional): TODO: type description - here. + body (CreatePrepaidComponent, optional): The request body + parameter. Returns: ComponentResponse: Response from the API. Created @@ -306,7 +306,7 @@ def create_event_based_component(self, Args: product_family_id (str): Either the product family's id or its handle prefixed with `handle:` - body (CreateEBBComponent, optional): TODO: type description here. + body (CreateEBBComponent, optional): The request body parameter. Returns: ComponentResponse: Response from the API. Created @@ -454,8 +454,8 @@ def update_product_family_component(self, component_id (str): Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:` - body (UpdateComponentRequest, optional): TODO: type description - here. + body (UpdateComponentRequest, optional): The request body + parameter. Returns: ComponentResponse: Response from the API. OK @@ -671,8 +671,8 @@ def update_component(self, Args: component_id (str): The id or handle of the component - body (UpdateComponentRequest, optional): TODO: type description - here. + body (UpdateComponentRequest, optional): The request body + parameter. Returns: ComponentResponse: Response from the API. OK diff --git a/advancedbilling/controllers/coupons_controller.py b/advancedbilling/controllers/coupons_controller.py index e6218b0c..c8927e79 100644 --- a/advancedbilling/controllers/coupons_controller.py +++ b/advancedbilling/controllers/coupons_controller.py @@ -60,7 +60,7 @@ def create_coupon(self, Args: product_family_id (int): The Advanced Billing id of the product family to which the coupon belongs - body (CouponRequest, optional): TODO: type description here. + body (CouponRequest, optional): The request body parameter. Returns: CouponResponse: Response from the API. Created @@ -322,7 +322,7 @@ def update_coupon(self, product_family_id (int): The Advanced Billing id of the product family to which the coupon belongs coupon_id (int): The Advanced Billing id of the coupon - body (CouponRequest, optional): TODO: type description here. + body (CouponRequest, optional): The request body parameter. Returns: CouponResponse: Response from the API. OK @@ -627,8 +627,7 @@ def create_or_update_coupon_currency_prices(self, Args: coupon_id (int): The Advanced Billing id of the coupon - body (CouponCurrencyRequest, optional): TODO: type description - here. + body (CouponCurrencyRequest, optional): The request body parameter. Returns: CouponCurrencyResponse: Response from the API. OK @@ -715,7 +714,7 @@ def create_coupon_subcodes(self, Args: coupon_id (int): The Advanced Billing id of the coupon - body (CouponSubcodes, optional): TODO: type description here. + body (CouponSubcodes, optional): The request body parameter. Returns: CouponSubcodesResponse: Response from the API. OK @@ -836,7 +835,7 @@ def update_coupon_subcodes(self, Args: coupon_id (int): The Advanced Billing id of the coupon - body (CouponSubcodes, optional): TODO: type description here. + body (CouponSubcodes, optional): The request body parameter. Returns: CouponSubcodesResponse: Response from the API. OK diff --git a/advancedbilling/controllers/custom_fields_controller.py b/advancedbilling/controllers/custom_fields_controller.py index 625e6518..076e411c 100644 --- a/advancedbilling/controllers/custom_fields_controller.py +++ b/advancedbilling/controllers/custom_fields_controller.py @@ -74,8 +74,8 @@ def create_metafields(self, Args: resource_type (ResourceType): the resource type to which the metafields belong - body (CreateMetafieldsRequest, optional): TODO: type description - here. + body (CreateMetafieldsRequest, optional): The request body + parameter. Returns: List[Metafield]: Response from the API. OK @@ -202,8 +202,8 @@ def update_metafield(self, Args: resource_type (ResourceType): the resource type to which the metafields belong - body (UpdateMetafieldsRequest, optional): TODO: type description - here. + body (UpdateMetafieldsRequest, optional): The request body + parameter. Returns: List[Metafield]: Response from the API. OK @@ -323,8 +323,7 @@ def create_metadata(self, metafields belong resource_id (int): The Advanced Billing id of the customer or the subscription for which the metadata applies - body (CreateMetadataRequest, optional): TODO: type description - here. + body (CreateMetadataRequest, optional): The request body parameter. Returns: List[Metadata]: Response from the API. OK @@ -460,8 +459,7 @@ def update_metadata(self, metafields belong resource_id (int): The Advanced Billing id of the customer or the subscription for which the metadata applies - body (UpdateMetadataRequest, optional): TODO: type description - here. + body (UpdateMetadataRequest, optional): The request body parameter. Returns: List[Metadata]: Response from the API. OK diff --git a/advancedbilling/controllers/customers_controller.py b/advancedbilling/controllers/customers_controller.py index 04c7806c..168c0a95 100644 --- a/advancedbilling/controllers/customers_controller.py +++ b/advancedbilling/controllers/customers_controller.py @@ -69,8 +69,7 @@ def create_customer(self, omer-Locale) Args: - body (CreateCustomerRequest, optional): TODO: type description - here. + body (CreateCustomerRequest, optional): The request body parameter. Returns: CustomerResponse: Response from the API. OK @@ -276,8 +275,7 @@ def update_customer(self, Args: id (int): The Advanced Billing id of the customer - body (UpdateCustomerRequest, optional): TODO: type description - here. + body (UpdateCustomerRequest, optional): The request body parameter. Returns: CustomerResponse: Response from the API. OK diff --git a/advancedbilling/controllers/events_based_billing_segments_controller.py b/advancedbilling/controllers/events_based_billing_segments_controller.py index cd752471..a8240b77 100644 --- a/advancedbilling/controllers/events_based_billing_segments_controller.py +++ b/advancedbilling/controllers/events_based_billing_segments_controller.py @@ -47,7 +47,7 @@ def create_segment(self, component_id (str): ID or Handle for the Component price_point_id (str): ID or Handle for the Price Point belonging to the Component - body (CreateSegmentRequest, optional): TODO: type description here. + body (CreateSegmentRequest, optional): The request body parameter. Returns: SegmentResponse: Response from the API. Created @@ -195,7 +195,7 @@ def update_segment(self, price_point_id (str): ID or Handle of the Price Point belonging to the Component id (float): The ID of the Segment - body (UpdateSegmentRequest, optional): TODO: type description here. + body (UpdateSegmentRequest, optional): The request body parameter. Returns: SegmentResponse: Response from the API. OK @@ -313,7 +313,7 @@ def bulk_create_segments(self, component_id (str): ID or Handle for the Component price_point_id (str): ID or Handle for the Price Point belonging to the Component - body (BulkCreateSegments, optional): TODO: type description here. + body (BulkCreateSegments, optional): The request body parameter. Returns: ListSegmentsResponse: Response from the API. Created @@ -377,7 +377,7 @@ def bulk_update_segments(self, component_id (str): ID or Handle for the Component price_point_id (str): ID or Handle for the Price Point belonging to the Component - body (BulkUpdateSegments, optional): TODO: type description here. + body (BulkUpdateSegments, optional): The request body parameter. Returns: ListSegmentsResponse: Response from the API. OK diff --git a/advancedbilling/controllers/events_controller.py b/advancedbilling/controllers/events_controller.py index 714d6664..ebb9f09d 100644 --- a/advancedbilling/controllers/events_controller.py +++ b/advancedbilling/controllers/events_controller.py @@ -120,10 +120,10 @@ def list_events(self, The maximum allowed values is 200; any per_page value over 200 will be changed to 200. Use in query `per_page=200`. - since_id -- long|int -- Returns events with an id greater - than or equal to the one specified - max_id -- long|int -- Returns events with an id less than + since_id -- int -- Returns events with an id greater than or equal to the one specified + max_id -- int -- Returns events with an id less than or + equal to the one specified direction -- Direction -- The sort direction of the returned events. filter -- List[EventKey] -- You can pass multiple event @@ -253,10 +253,10 @@ def list_subscription_events(self, The maximum allowed values is 200; any per_page value over 200 will be changed to 200. Use in query `per_page=200`. - since_id -- long|int -- Returns events with an id greater - than or equal to the one specified - max_id -- long|int -- Returns events with an id less than + since_id -- int -- Returns events with an id greater than or equal to the one specified + max_id -- int -- Returns events with an id less than or + equal to the one specified direction -- Direction -- The sort direction of the returned events. filter -- List[EventKey] -- You can pass multiple event @@ -339,10 +339,10 @@ def read_events_count(self, The maximum allowed values is 200; any per_page value over 200 will be changed to 200. Use in query `per_page=200`. - since_id -- long|int -- Returns events with an id greater - than or equal to the one specified - max_id -- long|int -- Returns events with an id less than + since_id -- int -- Returns events with an id greater than or equal to the one specified + max_id -- int -- Returns events with an id less than or + equal to the one specified direction -- Direction -- The sort direction of the returned events. filter -- List[EventKey] -- You can pass multiple event diff --git a/advancedbilling/controllers/invoices_controller.py b/advancedbilling/controllers/invoices_controller.py index 94b1eae4..e01dd6fa 100644 --- a/advancedbilling/controllers/invoices_controller.py +++ b/advancedbilling/controllers/invoices_controller.py @@ -53,7 +53,7 @@ def refund_invoice(self, Args: uid (str): The unique identifier for the invoice, this does not refer to the public facing invoice number. - body (RefundInvoiceRequest, optional): TODO: type description here. + body (RefundInvoiceRequest, optional): The request body parameter. Returns: Invoice: Response from the API. OK @@ -365,11 +365,11 @@ def list_invoice_events(self, event from which you want to start the search. All the events before the `since_date` timestamp are not returned in the response. - since_id -- long|int -- The ID of the event from which you - want to start the search(ID is not included. e.g. if - ID is set to 2, then all events with ID 3 and more - will be shown) This parameter is not used if - since_date is defined. + since_id -- int -- The ID of the event from which you want + to start the search(ID is not included. e.g. if ID is + set to 2, then all events with ID 3 and more will be + shown) This parameter is not used if since_date is + defined. page -- int -- Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to @@ -498,8 +498,8 @@ def record_payment_for_invoice(self, Args: uid (str): The unique identifier for the invoice, this does not refer to the public facing invoice number. - body (CreateInvoicePaymentRequest, optional): TODO: type - description here. + body (CreateInvoicePaymentRequest, optional): The request body + parameter. Returns: Invoice: Response from the API. OK @@ -571,8 +571,8 @@ def record_payment_for_multiple_invoices(self, amount must be greater or equal to invoices payment amount sum. Args: - body (CreateMultiInvoicePaymentRequest, optional): TODO: type - description here. + body (CreateMultiInvoicePaymentRequest, optional): The request + body parameter. Returns: MultiInvoicePaymentResponse: Response from the API. OK @@ -751,7 +751,7 @@ def record_payment_for_subscription(self, Args: subscription_id (int): The Chargify id of the subscription - body (RecordPaymentRequest, optional): TODO: type description here. + body (RecordPaymentRequest, optional): The request body parameter. Returns: RecordPaymentResponse: Response from the API. OK @@ -861,7 +861,7 @@ def void_invoice(self, Args: uid (str): The unique identifier for the invoice, this does not refer to the public facing invoice number. - body (VoidInvoiceRequest, optional): TODO: type description here. + body (VoidInvoiceRequest, optional): The request body parameter. Returns: Invoice: Response from the API. OK @@ -1151,7 +1151,7 @@ def create_invoice(self, Args: subscription_id (int): The Chargify id of the subscription - body (CreateInvoiceRequest, optional): TODO: type description here. + body (CreateInvoiceRequest, optional): The request body parameter. Returns: InvoiceResponse: Response from the API. OK @@ -1214,7 +1214,7 @@ def send_invoice(self, Args: uid (str): The unique identifier for the invoice, this does not refer to the public facing invoice number. - body (SendInvoiceRequest, optional): TODO: type description here. + body (SendInvoiceRequest, optional): The request body parameter. Returns: void: Response from the API. No Content @@ -1376,7 +1376,7 @@ def issue_invoice(self, Args: uid (str): The unique identifier for the invoice, this does not refer to the public facing invoice number. - body (IssueInvoiceRequest, optional): TODO: type description here. + body (IssueInvoiceRequest, optional): The request body parameter. Returns: Invoice: Response from the API. OK diff --git a/advancedbilling/controllers/offers_controller.py b/advancedbilling/controllers/offers_controller.py index 1c2fbaa5..21adbaeb 100644 --- a/advancedbilling/controllers/offers_controller.py +++ b/advancedbilling/controllers/offers_controller.py @@ -50,7 +50,7 @@ def create_offer(self, point will be used. Args: - body (CreateOfferRequest, optional): TODO: type description here. + body (CreateOfferRequest, optional): The request body parameter. Returns: OfferResponse: Response from the API. Created diff --git a/advancedbilling/controllers/payment_profiles_controller.py b/advancedbilling/controllers/payment_profiles_controller.py index b758577c..e0af7af8 100644 --- a/advancedbilling/controllers/payment_profiles_controller.py +++ b/advancedbilling/controllers/payment_profiles_controller.py @@ -583,8 +583,8 @@ def update_payment_profile(self, Args: payment_profile_id (int): The Chargify id of the payment profile - body (UpdatePaymentProfileRequest, optional): TODO: type - description here. + body (UpdatePaymentProfileRequest, optional): The request body + parameter. Returns: PaymentProfileResponse: Response from the API. OK @@ -718,8 +718,8 @@ def verify_bank_account(self, Args: bank_account_id (int): Identifier of the bank account in the system. - body (BankAccountVerificationRequest, optional): TODO: type - description here. + body (BankAccountVerificationRequest, optional): The request body + parameter. Returns: BankAccountResponse: Response from the API. OK diff --git a/advancedbilling/controllers/product_families_controller.py b/advancedbilling/controllers/product_families_controller.py index 21b94ceb..5cf95a12 100644 --- a/advancedbilling/controllers/product_families_controller.py +++ b/advancedbilling/controllers/product_families_controller.py @@ -165,8 +165,8 @@ def create_product_family(self, ct-Families). Args: - body (CreateProductFamilyRequest, optional): TODO: type - description here. + body (CreateProductFamilyRequest, optional): The request body + parameter. Returns: ProductFamilyResponse: Response from the API. Created diff --git a/advancedbilling/controllers/product_price_points_controller.py b/advancedbilling/controllers/product_price_points_controller.py index 3e3d72b0..6221930a 100644 --- a/advancedbilling/controllers/product_price_points_controller.py +++ b/advancedbilling/controllers/product_price_points_controller.py @@ -46,8 +46,8 @@ def create_product_price_point(self, Args: product_id (int | str): The id or handle of the product. When using the handle, it must be prefixed with `handle:` - body (CreateProductPricePointRequest, optional): TODO: type - description here. + body (CreateProductPricePointRequest, optional): The request body + parameter. Returns: ProductPricePointResponse: Response from the API. Created @@ -196,8 +196,8 @@ def update_product_price_point(self, Example: `123` for an integer ID, or `handle:example-product-price-point-handle` for a string handle. - body (UpdateProductPricePointRequest, optional): TODO: type - description here. + body (UpdateProductPricePointRequest, optional): The request body + parameter. Returns: ProductPricePointResponse: Response from the API. OK @@ -477,8 +477,8 @@ def bulk_create_product_price_points(self, Args: product_id (int): The Advanced Billing id of the product to which the price points belong - body (BulkCreateProductPricePointsRequest, optional): TODO: type - description here. + body (BulkCreateProductPricePointsRequest, optional): The request + body parameter. Returns: BulkCreateProductPricePointsResponse: Response from the API. @@ -535,8 +535,8 @@ def create_product_currency_prices(self, Args: product_price_point_id (int): The Advanced Billing id of the product price point - body (CreateProductCurrencyPricesRequest, optional): TODO: type - description here. + body (CreateProductCurrencyPricesRequest, optional): The request + body parameter. Returns: CurrencyPricesResponse: Response from the API. OK @@ -591,8 +591,8 @@ def update_product_currency_prices(self, Args: product_price_point_id (int): The Advanced Billing id of the product price point - body (UpdateCurrencyPricesRequest, optional): TODO: type - description here. + body (UpdateCurrencyPricesRequest, optional): The request body + parameter. Returns: CurrencyPricesResponse: Response from the API. OK diff --git a/advancedbilling/controllers/products_controller.py b/advancedbilling/controllers/products_controller.py index 1364d972..aa024c25 100644 --- a/advancedbilling/controllers/products_controller.py +++ b/advancedbilling/controllers/products_controller.py @@ -42,8 +42,8 @@ def create_product(self, Args: product_family_id (str): Either the product family's id or its handle prefixed with `handle:` - body (CreateOrUpdateProductRequest, optional): TODO: type - description here. + body (CreateOrUpdateProductRequest, optional): The request body + parameter. Returns: ProductResponse: Response from the API. Created @@ -139,8 +139,8 @@ def update_product(self, Args: product_id (int): The Advanced Billing id of the product - body (CreateOrUpdateProductRequest, optional): TODO: type - description here. + body (CreateOrUpdateProductRequest, optional): The request body + parameter. Returns: ProductResponse: Response from the API. OK diff --git a/advancedbilling/controllers/proforma_invoices_controller.py b/advancedbilling/controllers/proforma_invoices_controller.py index 43ec9d9d..40c8af6a 100644 --- a/advancedbilling/controllers/proforma_invoices_controller.py +++ b/advancedbilling/controllers/proforma_invoices_controller.py @@ -373,7 +373,7 @@ def void_proforma_invoice(self, Args: proforma_invoice_uid (str): The uid of the proforma invoice - body (VoidInvoiceRequest, optional): TODO: type description here. + body (VoidInvoiceRequest, optional): The request body parameter. Returns: ProformaInvoice: Response from the API. OK @@ -490,8 +490,8 @@ def create_signup_proforma_invoice(self, subscription_id will always be blank. Args: - body (CreateSubscriptionRequest, optional): TODO: type description - here. + body (CreateSubscriptionRequest, optional): The request body + parameter. Returns: ProformaInvoice: Response from the API. Created @@ -549,8 +549,8 @@ def preview_signup_proforma_invoice(self, include (CreateSignupProformaPreviewInclude, optional): Choose to include a proforma invoice preview for the first renewal. Use in query `include=next_proforma_invoice`. - body (CreateSubscriptionRequest, optional): TODO: type description - here. + body (CreateSubscriptionRequest, optional): The request body + parameter. Returns: SignupProformaPreviewResponse: Response from the API. Created diff --git a/advancedbilling/controllers/reason_codes_controller.py b/advancedbilling/controllers/reason_codes_controller.py index d13681bb..84f0f9a1 100644 --- a/advancedbilling/controllers/reason_codes_controller.py +++ b/advancedbilling/controllers/reason_codes_controller.py @@ -48,8 +48,8 @@ def create_reason_code(self, given Site. Args: - body (CreateReasonCodeRequest, optional): TODO: type description - here. + body (CreateReasonCodeRequest, optional): The request body + parameter. Returns: ReasonCodeResponse: Response from the API. OK @@ -196,8 +196,8 @@ def update_reason_code(self, Args: reason_code_id (int): The Advanced Billing id of the reason code - body (UpdateReasonCodeRequest, optional): TODO: type description - here. + body (UpdateReasonCodeRequest, optional): The request body + parameter. Returns: ReasonCodeResponse: Response from the API. OK diff --git a/advancedbilling/controllers/subscription_components_controller.py b/advancedbilling/controllers/subscription_components_controller.py index 58cda37e..6e869a2b 100644 --- a/advancedbilling/controllers/subscription_components_controller.py +++ b/advancedbilling/controllers/subscription_components_controller.py @@ -234,8 +234,8 @@ def bulk_update_subscription_components_price_points(self, Args: subscription_id (int): The Chargify id of the subscription - body (BulkComponentsPricePointAssignment, optional): TODO: type - description here. + body (BulkComponentsPricePointAssignment, optional): The request + body parameter. Returns: BulkComponentsPricePointAssignment: Response from the API. OK @@ -397,8 +397,8 @@ def allocate_component(self, Args: subscription_id (int): The Chargify id of the subscription component_id (int): The Advanced Billing id of the component - body (CreateAllocationRequest, optional): TODO: type description - here. + body (CreateAllocationRequest, optional): The request body + parameter. Returns: AllocationResponse: Response from the API. OK @@ -535,7 +535,7 @@ def allocate_components(self, Args: subscription_id (int): The Chargify id of the subscription - body (AllocateComponents, optional): TODO: type description here. + body (AllocateComponents, optional): The request body parameter. Returns: List[AllocationResponse]: Response from the API. OK @@ -597,8 +597,8 @@ def preview_allocations(self, Args: subscription_id (int): The Chargify id of the subscription - body (PreviewAllocationsRequest, optional): TODO: type description - here. + body (PreviewAllocationsRequest, optional): The request body + parameter. Returns: AllocationPreviewResponse: Response from the API. OK @@ -665,8 +665,8 @@ def update_prepaid_usage_allocation_expiration_date(self, subscription_id (int): The Chargify id of the subscription component_id (int): The Advanced Billing id of the component allocation_id (int): The Advanced Billing id of the allocation - body (UpdateAllocationExpirationDate, optional): TODO: type - description here. + body (UpdateAllocationExpirationDate, optional): The request body + parameter. Returns: void: Response from the API. OK @@ -734,7 +734,7 @@ def delete_prepaid_usage_allocation(self, subscription_id (int): The Chargify id of the subscription component_id (int): The Advanced Billing id of the component allocation_id (int): The Advanced Billing id of the allocation - body (CreditSchemeRequest, optional): TODO: type description here. + body (CreditSchemeRequest, optional): The request body parameter. Returns: void: Response from the API. OK @@ -856,7 +856,7 @@ def create_usage(self, subscription_id (int): The Chargify id of the subscription component_id (int | str): Either the Advanced Billing id for the component or the component's handle prefixed by `handle:` - body (CreateUsageRequest, optional): TODO: type description here. + body (CreateUsageRequest, optional): The request body parameter. Returns: UsageResponse: Response from the API. OK @@ -934,10 +934,10 @@ def list_usages(self, component_id -- int | str -- Either the Advanced Billing id for the component or the component's handle prefixed by `handle:` - since_id -- long|int -- Returns usages with an id greater - than or equal to the one specified - max_id -- long|int -- Returns usages with an id less than + since_id -- int -- Returns usages with an id greater than or equal to the one specified + max_id -- int -- Returns usages with an id less than or + equal to the one specified since_date -- date -- Returns usages with a created_at date greater than or equal to midnight (12:00 AM) on the date specified. @@ -1036,8 +1036,8 @@ def activate_event_based_component(self, Args: subscription_id (int): The Advanced Billing id of the subscription component_id (int): The Advanced Billing id of the component - body (ActivateEventBasedComponent, optional): TODO: type - description here. + body (ActivateEventBasedComponent, optional): The request body + parameter. Returns: void: Response from the API. OK @@ -1148,7 +1148,7 @@ def record_event(self, store_uid (str, optional): If you've attached your own Keen project as an Advanced Billing event data-store, use this parameter to indicate the data-store. - body (EBBEvent, optional): TODO: type description here. + body (EBBEvent, optional): The request body parameter. Returns: void: Response from the API. Created @@ -1201,7 +1201,7 @@ def bulk_record_events(self, store_uid (str, optional): If you've attached your own Keen project as an Advanced Billing event data-store, use this parameter to indicate the data-store. - body (List[EBBEvent], optional): TODO: type description here. + body (List[EBBEvent], optional): The request body parameter. Returns: void: Response from the API. Created diff --git a/advancedbilling/controllers/subscription_group_invoice_account_controller.py b/advancedbilling/controllers/subscription_group_invoice_account_controller.py index c180e825..516c9656 100644 --- a/advancedbilling/controllers/subscription_group_invoice_account_controller.py +++ b/advancedbilling/controllers/subscription_group_invoice_account_controller.py @@ -42,8 +42,8 @@ def create_subscription_group_prepayment(self, Args: uid (str): The uid of the subscription group - body (SubscriptionGroupPrepaymentRequest, optional): TODO: type - description here. + body (SubscriptionGroupPrepaymentRequest, optional): The request + body parameter. Returns: SubscriptionGroupPrepaymentResponse: Response from the API. OK @@ -166,8 +166,8 @@ def issue_subscription_group_service_credit(self, Args: uid (str): The uid of the subscription group - body (IssueServiceCreditRequest, optional): TODO: type description - here. + body (IssueServiceCreditRequest, optional): The request body + parameter. Returns: ServiceCreditResponse: Response from the API. OK @@ -217,8 +217,8 @@ def deduct_subscription_group_service_credit(self, Args: uid (str): The uid of the subscription group - body (DeductServiceCreditRequest, optional): TODO: type - description here. + body (DeductServiceCreditRequest, optional): The request body + parameter. Returns: ServiceCredit: Response from the API. Created diff --git a/advancedbilling/controllers/subscription_group_status_controller.py b/advancedbilling/controllers/subscription_group_status_controller.py index 245aff3d..715f3c88 100644 --- a/advancedbilling/controllers/subscription_group_status_controller.py +++ b/advancedbilling/controllers/subscription_group_status_controller.py @@ -41,8 +41,8 @@ def cancel_subscriptions_in_group(self, Args: uid (str): The uid of the subscription group - body (CancelGroupedSubscriptionsRequest, optional): TODO: type - description here. + body (CancelGroupedSubscriptionsRequest, optional): The request + body parameter. Returns: void: Response from the API. OK @@ -189,8 +189,8 @@ def reactivate_subscription_group(self, Args: uid (str): The uid of the subscription group - body (ReactivateSubscriptionGroupRequest, optional): TODO: type - description here. + body (ReactivateSubscriptionGroupRequest, optional): The request + body parameter. Returns: ReactivateSubscriptionGroupResponse: Response from the API. OK diff --git a/advancedbilling/controllers/subscription_groups_controller.py b/advancedbilling/controllers/subscription_groups_controller.py index b74f35a6..84bafb70 100644 --- a/advancedbilling/controllers/subscription_groups_controller.py +++ b/advancedbilling/controllers/subscription_groups_controller.py @@ -53,8 +53,8 @@ def signup_with_subscription_group(self, instead. Args: - body (SubscriptionGroupSignupRequest, optional): TODO: type - description here. + body (SubscriptionGroupSignupRequest, optional): The request body + parameter. Returns: SubscriptionGroupSignupResponse: Response from the API. Created @@ -95,8 +95,8 @@ def create_subscription_group(self, Creates a subscription group with given members. Args: - body (CreateSubscriptionGroupRequest, optional): TODO: type - description here. + body (CreateSubscriptionGroupRequest, optional): The request body + parameter. Returns: SubscriptionGroupResponse: Response from the API. OK @@ -270,8 +270,8 @@ def update_subscription_group_members(self, Args: uid (str): The uid of the subscription group - body (UpdateSubscriptionGroupRequest, optional): TODO: type - description here. + body (UpdateSubscriptionGroupRequest, optional): The request body + parameter. Returns: SubscriptionGroupResponse: Response from the API. OK @@ -431,8 +431,8 @@ def add_subscription_to_group(self, Args: subscription_id (int): The Chargify id of the subscription - body (AddSubscriptionToAGroup, optional): TODO: type description - here. + body (AddSubscriptionToAGroup, optional): The request body + parameter. Returns: SubscriptionGroupResponse: Response from the API. OK diff --git a/advancedbilling/controllers/subscription_invoice_account_controller.py b/advancedbilling/controllers/subscription_invoice_account_controller.py index 8c942543..34441932 100644 --- a/advancedbilling/controllers/subscription_invoice_account_controller.py +++ b/advancedbilling/controllers/subscription_invoice_account_controller.py @@ -88,8 +88,8 @@ def create_prepayment(self, Args: subscription_id (int): The Chargify id of the subscription - body (CreatePrepaymentRequest, optional): TODO: type description - here. + body (CreatePrepaymentRequest, optional): The request body + parameter. Returns: CreatePrepaymentResponse: Response from the API. Created @@ -212,8 +212,8 @@ def issue_service_credit(self, Args: subscription_id (int): The Chargify id of the subscription - body (IssueServiceCreditRequest, optional): TODO: type description - here. + body (IssueServiceCreditRequest, optional): The request body + parameter. Returns: ServiceCredit: Response from the API. Created @@ -263,8 +263,8 @@ def deduct_service_credit(self, Args: subscription_id (int): The Chargify id of the subscription - body (DeductServiceCreditRequest, optional): TODO: type - description here. + body (DeductServiceCreditRequest, optional): The request body + parameter. Returns: void: Response from the API. OK @@ -310,9 +310,9 @@ def refund_prepayment(self, Args: subscription_id (int): The Chargify id of the subscription - prepayment_id (long|int): id of prepayment - body (RefundPrepaymentRequest, optional): TODO: type description - here. + prepayment_id (int): id of prepayment + body (RefundPrepaymentRequest, optional): The request body + parameter. Returns: PrepaymentResponse: Response from the API. Created diff --git a/advancedbilling/controllers/subscription_notes_controller.py b/advancedbilling/controllers/subscription_notes_controller.py index 3a6e179a..254362c6 100644 --- a/advancedbilling/controllers/subscription_notes_controller.py +++ b/advancedbilling/controllers/subscription_notes_controller.py @@ -43,8 +43,8 @@ def create_subscription_note(self, Args: subscription_id (int): The Chargify id of the subscription - body (UpdateSubscriptionNoteRequest, optional): TODO: type - description here. + body (UpdateSubscriptionNoteRequest, optional): The request body + parameter. Returns: SubscriptionNoteResponse: Response from the API. OK @@ -209,8 +209,8 @@ def update_subscription_note(self, Args: subscription_id (int): The Chargify id of the subscription note_id (int): The Advanced Billing id of the note - body (UpdateSubscriptionNoteRequest, optional): TODO: type - description here. + body (UpdateSubscriptionNoteRequest, optional): The request body + parameter. Returns: SubscriptionNoteResponse: Response from the API. OK diff --git a/advancedbilling/controllers/subscription_products_controller.py b/advancedbilling/controllers/subscription_products_controller.py index a28089d5..380a3244 100644 --- a/advancedbilling/controllers/subscription_products_controller.py +++ b/advancedbilling/controllers/subscription_products_controller.py @@ -129,8 +129,8 @@ def migrate_subscription_product(self, Args: subscription_id (int): The Chargify id of the subscription - body (SubscriptionProductMigrationRequest, optional): TODO: type - description here. + body (SubscriptionProductMigrationRequest, optional): The request + body parameter. Returns: SubscriptionResponse: Response from the API. OK @@ -185,8 +185,8 @@ def preview_subscription_product_migration(self, Args: subscription_id (int): The Chargify id of the subscription - body (SubscriptionMigrationPreviewRequest, optional): TODO: type - description here. + body (SubscriptionMigrationPreviewRequest, optional): The request + body parameter. Returns: SubscriptionMigrationPreviewResponse: Response from the API. OK diff --git a/advancedbilling/controllers/subscription_status_controller.py b/advancedbilling/controllers/subscription_status_controller.py index 7a92c564..d9372b9f 100644 --- a/advancedbilling/controllers/subscription_status_controller.py +++ b/advancedbilling/controllers/subscription_status_controller.py @@ -84,7 +84,7 @@ def cancel_subscription(self, Args: subscription_id (int): The Chargify id of the subscription - body (CancellationRequest, optional): TODO: type description here. + body (CancellationRequest, optional): The request body parameter. Returns: SubscriptionResponse: Response from the API. OK @@ -187,7 +187,7 @@ def pause_subscription(self, Args: subscription_id (int): The Chargify id of the subscription - body (PauseRequest, optional): TODO: type description here. + body (PauseRequest, optional): The request body parameter. Returns: SubscriptionResponse: Response from the API. OK @@ -241,7 +241,7 @@ def update_automatic_subscription_resumption(self, Args: subscription_id (int): The Chargify id of the subscription - body (PauseRequest, optional): TODO: type description here. + body (PauseRequest, optional): The request body parameter. Returns: SubscriptionResponse: Response from the API. OK @@ -428,8 +428,8 @@ def reactivate_subscription(self, Args: subscription_id (int): The Chargify id of the subscription - body (ReactivateSubscriptionRequest, optional): TODO: type - description here. + body (ReactivateSubscriptionRequest, optional): The request body + parameter. Returns: SubscriptionResponse: Response from the API. OK @@ -483,7 +483,7 @@ def initiate_delayed_cancellation(self, Args: subscription_id (int): The Chargify id of the subscription - body (CancellationRequest, optional): TODO: type description here. + body (CancellationRequest, optional): The request body parameter. Returns: DelayedCancellationResponse: Response from the API. OK @@ -649,8 +649,7 @@ def preview_renewal(self, Args: subscription_id (int): The Chargify id of the subscription - body (RenewalPreviewRequest, optional): TODO: type description - here. + body (RenewalPreviewRequest, optional): The request body parameter. Returns: RenewalPreviewResponse: Response from the API. OK diff --git a/advancedbilling/controllers/subscriptions_controller.py b/advancedbilling/controllers/subscriptions_controller.py index 3b9a37c2..42084f88 100644 --- a/advancedbilling/controllers/subscriptions_controller.py +++ b/advancedbilling/controllers/subscriptions_controller.py @@ -861,8 +861,8 @@ def create_subscription(self, ``` Args: - body (CreateSubscriptionRequest, optional): TODO: type description - here. + body (CreateSubscriptionRequest, optional): The request body + parameter. Returns: SubscriptionResponse: Response from the API. Created @@ -1130,8 +1130,8 @@ def update_subscription(self, Args: subscription_id (int): The Chargify id of the subscription - body (UpdateSubscriptionRequest, optional): TODO: type description - here. + body (UpdateSubscriptionRequest, optional): The request body + parameter. Returns: SubscriptionResponse: Response from the API. OK @@ -1407,8 +1407,8 @@ def update_prepaid_subscription_configuration(self, Args: subscription_id (int): The Chargify id of the subscription - body (UpsertPrepaidConfigurationRequest, optional): TODO: type - description here. + body (UpsertPrepaidConfigurationRequest, optional): The request + body parameter. Returns: PrepaidConfigurationResponse: Response from the API. OK @@ -1489,8 +1489,8 @@ def preview_subscription(self, please feel free to leave off the billing information. Args: - body (CreateSubscriptionRequest, optional): TODO: type description - here. + body (CreateSubscriptionRequest, optional): The request body + parameter. Returns: SubscriptionPreviewResponse: Response from the API. OK @@ -1548,7 +1548,7 @@ def apply_coupons_to_subscription(self, subscription_id (int): The Chargify id of the subscription code (str, optional): A code for the coupon that would be applied to a subscription - body (AddCouponsRequest, optional): TODO: type description here. + body (AddCouponsRequest, optional): The request body parameter. Returns: SubscriptionResponse: Response from the API. OK @@ -1694,8 +1694,8 @@ def activate_subscription(self, Args: subscription_id (int): The Chargify id of the subscription - body (ActivateSubscriptionRequest, optional): TODO: type - description here. + body (ActivateSubscriptionRequest, optional): The request body + parameter. Returns: SubscriptionResponse: Response from the API. OK diff --git a/advancedbilling/controllers/webhooks_controller.py b/advancedbilling/controllers/webhooks_controller.py index 9c8af226..c8a6a4d6 100644 --- a/advancedbilling/controllers/webhooks_controller.py +++ b/advancedbilling/controllers/webhooks_controller.py @@ -147,8 +147,7 @@ def enable_webhooks(self, This method allows you to enable webhooks via API for your site Args: - body (EnableWebhooksRequest, optional): TODO: type description - here. + body (EnableWebhooksRequest, optional): The request body parameter. Returns: EnableWebhooksResponse: Response from the API. OK @@ -192,8 +191,7 @@ def replay_webhooks(self, request. Args: - body (ReplayWebhooksRequest, optional): TODO: type description - here. + body (ReplayWebhooksRequest, optional): The request body parameter. Returns: ReplayWebhooksResponse: Response from the API. OK @@ -238,8 +236,8 @@ def create_endpoint(self, ks-Reference#events) Args: - body (CreateOrUpdateEndpointRequest, optional): TODO: type - description here. + body (CreateOrUpdateEndpointRequest, optional): The request body + parameter. Returns: EndpointResponse: Response from the API. OK @@ -324,8 +322,8 @@ def update_endpoint(self, Args: endpoint_id (int): The Advanced Billing id for the endpoint that should be updated - body (CreateOrUpdateEndpointRequest, optional): TODO: type - description here. + body (CreateOrUpdateEndpointRequest, optional): The request body + parameter. Returns: EndpointResponse: Response from the API. OK diff --git a/advancedbilling/exceptions/api_exception.py b/advancedbilling/exceptions/api_exception.py index 09899011..0d5b71cc 100644 --- a/advancedbilling/exceptions/api_exception.py +++ b/advancedbilling/exceptions/api_exception.py @@ -33,3 +33,8 @@ def __init__(self, self.reason = reason self.response = response self.response_code = response.status_code + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'status_code={self.response_code!s}, ' + f'message={self.reason!s})') diff --git a/advancedbilling/exceptions/component_allocation_error_exception.py b/advancedbilling/exceptions/component_allocation_error_exception.py index a133c62c..ce2c3dc8 100644 --- a/advancedbilling/exceptions/component_allocation_error_exception.py +++ b/advancedbilling/exceptions/component_allocation_error_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.component_allocation_error_item import ComponentAllocationErrorItem -class ComponentAllocationErrorException(advancedbilling.exceptions.api_exception.APIException): +class ComponentAllocationErrorException(APIException): def __init__(self, reason, response): """Constructor for the ComponentAllocationErrorException class @@ -41,3 +41,9 @@ def unbox(self, dictionary): self.errors = [ComponentAllocationErrorItem.from_dictionary(x) for x in dictionary.get('errors')] else: self.errors = None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/component_price_point_error_exception.py b/advancedbilling/exceptions/component_price_point_error_exception.py index 6fd64f5c..b7dea78c 100644 --- a/advancedbilling/exceptions/component_price_point_error_exception.py +++ b/advancedbilling/exceptions/component_price_point_error_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.component_price_point_error_item import ComponentPricePointErrorItem -class ComponentPricePointErrorException(advancedbilling.exceptions.api_exception.APIException): +class ComponentPricePointErrorException(APIException): def __init__(self, reason, response): """Constructor for the ComponentPricePointErrorException class @@ -41,3 +41,9 @@ def unbox(self, dictionary): self.errors = [ComponentPricePointErrorItem.from_dictionary(x) for x in dictionary.get('errors')] else: self.errors = None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/customer_error_response_exception.py b/advancedbilling/exceptions/customer_error_response_exception.py index 84ccfa02..f912fc0d 100644 --- a/advancedbilling/exceptions/customer_error_response_exception.py +++ b/advancedbilling/exceptions/customer_error_response_exception.py @@ -8,10 +8,10 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException -class CustomerErrorResponseException(advancedbilling.exceptions.api_exception.APIException): +class CustomerErrorResponseException(APIException): def __init__(self, reason, response): """Constructor for the CustomerErrorResponseException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ from advancedbilling.utilities.union_type_lookup import UnionTypeLookUp self.errors = APIHelper.deserialize_union_type(UnionTypeLookUp.get('CustomerErrorResponseErrors'), dictionary.get('errors'), False) if dictionary.get('errors') is not None else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/error_array_map_response_exception.py b/advancedbilling/exceptions/error_array_map_response_exception.py index 8ed31a2f..95718fb1 100644 --- a/advancedbilling/exceptions/error_array_map_response_exception.py +++ b/advancedbilling/exceptions/error_array_map_response_exception.py @@ -8,10 +8,10 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException -class ErrorArrayMapResponseException(advancedbilling.exceptions.api_exception.APIException): +class ErrorArrayMapResponseException(APIException): def __init__(self, reason, response): """Constructor for the ErrorArrayMapResponseException class @@ -36,3 +36,9 @@ def unbox(self, dictionary): """ self.errors = dictionary.get("errors") if dictionary.get("errors") else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/error_list_response_exception.py b/advancedbilling/exceptions/error_list_response_exception.py index ea5be3ac..ba2fb0a5 100644 --- a/advancedbilling/exceptions/error_list_response_exception.py +++ b/advancedbilling/exceptions/error_list_response_exception.py @@ -8,10 +8,10 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException -class ErrorListResponseException(advancedbilling.exceptions.api_exception.APIException): +class ErrorListResponseException(APIException): def __init__(self, reason, response): """Constructor for the ErrorListResponseException class @@ -36,3 +36,9 @@ def unbox(self, dictionary): """ self.errors = dictionary.get("errors") if dictionary.get("errors") else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/error_string_map_response_exception.py b/advancedbilling/exceptions/error_string_map_response_exception.py index 223affae..65ec4472 100644 --- a/advancedbilling/exceptions/error_string_map_response_exception.py +++ b/advancedbilling/exceptions/error_string_map_response_exception.py @@ -8,10 +8,10 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException -class ErrorStringMapResponseException(advancedbilling.exceptions.api_exception.APIException): +class ErrorStringMapResponseException(APIException): def __init__(self, reason, response): """Constructor for the ErrorStringMapResponseException class @@ -36,3 +36,9 @@ def unbox(self, dictionary): """ self.errors = dictionary.get("errors") if dictionary.get("errors") else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/event_based_billing_list_segments_errors_exception.py b/advancedbilling/exceptions/event_based_billing_list_segments_errors_exception.py index da3fee65..ca261531 100644 --- a/advancedbilling/exceptions/event_based_billing_list_segments_errors_exception.py +++ b/advancedbilling/exceptions/event_based_billing_list_segments_errors_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.errors import Errors -class EventBasedBillingListSegmentsErrorsException(advancedbilling.exceptions.api_exception.APIException): +class EventBasedBillingListSegmentsErrorsException(APIException): def __init__(self, reason, response): """Constructor for the EventBasedBillingListSegmentsErrorsException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ self.errors = Errors.from_dictionary(dictionary.get('errors')) if 'errors' in dictionary.keys() else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/event_based_billing_segment_errors_exception.py b/advancedbilling/exceptions/event_based_billing_segment_errors_exception.py index f87251cf..a28da47d 100644 --- a/advancedbilling/exceptions/event_based_billing_segment_errors_exception.py +++ b/advancedbilling/exceptions/event_based_billing_segment_errors_exception.py @@ -8,10 +8,10 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException -class EventBasedBillingSegmentErrorsException(advancedbilling.exceptions.api_exception.APIException): +class EventBasedBillingSegmentErrorsException(APIException): def __init__(self, reason, response): """Constructor for the EventBasedBillingSegmentErrorsException class @@ -36,3 +36,9 @@ def unbox(self, dictionary): """ self.errors = dictionary.get("errors") if dictionary.get("errors") else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/event_based_billing_segment_exception.py b/advancedbilling/exceptions/event_based_billing_segment_exception.py index ddd811a5..b5b00dad 100644 --- a/advancedbilling/exceptions/event_based_billing_segment_exception.py +++ b/advancedbilling/exceptions/event_based_billing_segment_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.event_based_billing_segment_error import EventBasedBillingSegmentError -class EventBasedBillingSegmentException(advancedbilling.exceptions.api_exception.APIException): +class EventBasedBillingSegmentException(APIException): def __init__(self, reason, response): """Constructor for the EventBasedBillingSegmentException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ self.errors = EventBasedBillingSegmentError.from_dictionary(dictionary.get('errors')) if dictionary.get('errors') else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/product_price_point_error_response_exception.py b/advancedbilling/exceptions/product_price_point_error_response_exception.py index 2ca681a9..17762f09 100644 --- a/advancedbilling/exceptions/product_price_point_error_response_exception.py +++ b/advancedbilling/exceptions/product_price_point_error_response_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.product_price_point_errors import ProductPricePointErrors -class ProductPricePointErrorResponseException(advancedbilling.exceptions.api_exception.APIException): +class ProductPricePointErrorResponseException(APIException): def __init__(self, reason, response): """Constructor for the ProductPricePointErrorResponseException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ self.errors = ProductPricePointErrors.from_dictionary(dictionary.get('errors')) if dictionary.get('errors') else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/proforma_bad_request_error_response_exception.py b/advancedbilling/exceptions/proforma_bad_request_error_response_exception.py index 90e37a50..5cc84bfa 100644 --- a/advancedbilling/exceptions/proforma_bad_request_error_response_exception.py +++ b/advancedbilling/exceptions/proforma_bad_request_error_response_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.proforma_error import ProformaError -class ProformaBadRequestErrorResponseException(advancedbilling.exceptions.api_exception.APIException): +class ProformaBadRequestErrorResponseException(APIException): def __init__(self, reason, response): """Constructor for the ProformaBadRequestErrorResponseException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ self.errors = ProformaError.from_dictionary(dictionary.get('errors')) if 'errors' in dictionary.keys() else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/refund_prepayment_base_errors_response_exception.py b/advancedbilling/exceptions/refund_prepayment_base_errors_response_exception.py index 03ee7f92..2dc2c984 100644 --- a/advancedbilling/exceptions/refund_prepayment_base_errors_response_exception.py +++ b/advancedbilling/exceptions/refund_prepayment_base_errors_response_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.refund_prepayment_base_refund_error import RefundPrepaymentBaseRefundError -class RefundPrepaymentBaseErrorsResponseException(advancedbilling.exceptions.api_exception.APIException): +class RefundPrepaymentBaseErrorsResponseException(APIException): def __init__(self, reason, response): """Constructor for the RefundPrepaymentBaseErrorsResponseException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ self.errors = RefundPrepaymentBaseRefundError.from_dictionary(dictionary.get('errors')) if 'errors' in dictionary.keys() else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/single_error_response_exception.py b/advancedbilling/exceptions/single_error_response_exception.py index 48861db2..5dbf32da 100644 --- a/advancedbilling/exceptions/single_error_response_exception.py +++ b/advancedbilling/exceptions/single_error_response_exception.py @@ -8,10 +8,10 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException -class SingleErrorResponseException(advancedbilling.exceptions.api_exception.APIException): +class SingleErrorResponseException(APIException): def __init__(self, reason, response): """Constructor for the SingleErrorResponseException class @@ -36,3 +36,9 @@ def unbox(self, dictionary): """ self.error = dictionary.get("error") if dictionary.get("error") else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'error={self.error!s})') diff --git a/advancedbilling/exceptions/single_string_error_response_exception.py b/advancedbilling/exceptions/single_string_error_response_exception.py index bd89c764..b3229152 100644 --- a/advancedbilling/exceptions/single_string_error_response_exception.py +++ b/advancedbilling/exceptions/single_string_error_response_exception.py @@ -8,10 +8,10 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException -class SingleStringErrorResponseException(advancedbilling.exceptions.api_exception.APIException): +class SingleStringErrorResponseException(APIException): def __init__(self, reason, response): """Constructor for the SingleStringErrorResponseException class @@ -36,3 +36,9 @@ def unbox(self, dictionary): """ self.errors = dictionary.get("errors") if dictionary.get("errors") else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/subscription_add_coupon_error_exception.py b/advancedbilling/exceptions/subscription_add_coupon_error_exception.py index 1d3bb55d..f50b0c1b 100644 --- a/advancedbilling/exceptions/subscription_add_coupon_error_exception.py +++ b/advancedbilling/exceptions/subscription_add_coupon_error_exception.py @@ -8,10 +8,10 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException -class SubscriptionAddCouponErrorException(advancedbilling.exceptions.api_exception.APIException): +class SubscriptionAddCouponErrorException(APIException): def __init__(self, reason, response): """Constructor for the SubscriptionAddCouponErrorException class @@ -39,3 +39,12 @@ def unbox(self, dictionary): self.coupon_code = dictionary.get("coupon_code") if dictionary.get("coupon_code") else None self.coupon_codes = dictionary.get("coupon_codes") if dictionary.get("coupon_codes") else None self.subscription = dictionary.get("subscription") if dictionary.get("subscription") else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'codes={self.codes!s}, ' + f'coupon_code={self.coupon_code!s}, ' + f'coupon_codes={self.coupon_codes!s}, ' + f'subscription={self.subscription!s})') diff --git a/advancedbilling/exceptions/subscription_component_allocation_error_exception.py b/advancedbilling/exceptions/subscription_component_allocation_error_exception.py index 23f7303c..29cde71e 100644 --- a/advancedbilling/exceptions/subscription_component_allocation_error_exception.py +++ b/advancedbilling/exceptions/subscription_component_allocation_error_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.subscription_component_allocation_error_item import SubscriptionComponentAllocationErrorItem -class SubscriptionComponentAllocationErrorException(advancedbilling.exceptions.api_exception.APIException): +class SubscriptionComponentAllocationErrorException(APIException): def __init__(self, reason, response): """Constructor for the SubscriptionComponentAllocationErrorException class @@ -41,3 +41,9 @@ def unbox(self, dictionary): self.errors = [SubscriptionComponentAllocationErrorItem.from_dictionary(x) for x in dictionary.get('errors')] else: self.errors = None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/subscription_group_create_error_response_exception.py b/advancedbilling/exceptions/subscription_group_create_error_response_exception.py index 44d69285..24a46d6f 100644 --- a/advancedbilling/exceptions/subscription_group_create_error_response_exception.py +++ b/advancedbilling/exceptions/subscription_group_create_error_response_exception.py @@ -8,10 +8,10 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException -class SubscriptionGroupCreateErrorResponseException(advancedbilling.exceptions.api_exception.APIException): +class SubscriptionGroupCreateErrorResponseException(APIException): def __init__(self, reason, response): """Constructor for the SubscriptionGroupCreateErrorResponseException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ from advancedbilling.utilities.union_type_lookup import UnionTypeLookUp self.errors = APIHelper.deserialize_union_type(UnionTypeLookUp.get('SubscriptionGroupCreateErrorResponseErrors'), dictionary.get('errors'), False) if dictionary.get('errors') is not None else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/subscription_group_signup_error_response_exception.py b/advancedbilling/exceptions/subscription_group_signup_error_response_exception.py index 947c91c2..36b77bf0 100644 --- a/advancedbilling/exceptions/subscription_group_signup_error_response_exception.py +++ b/advancedbilling/exceptions/subscription_group_signup_error_response_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.subscription_group_signup_error import SubscriptionGroupSignupError -class SubscriptionGroupSignupErrorResponseException(advancedbilling.exceptions.api_exception.APIException): +class SubscriptionGroupSignupErrorResponseException(APIException): def __init__(self, reason, response): """Constructor for the SubscriptionGroupSignupErrorResponseException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ self.errors = SubscriptionGroupSignupError.from_dictionary(dictionary.get('errors')) if dictionary.get('errors') else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/subscription_group_update_error_response_exception.py b/advancedbilling/exceptions/subscription_group_update_error_response_exception.py index 49b6a8e6..5766ddc5 100644 --- a/advancedbilling/exceptions/subscription_group_update_error_response_exception.py +++ b/advancedbilling/exceptions/subscription_group_update_error_response_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.subscription_group_update_error import SubscriptionGroupUpdateError -class SubscriptionGroupUpdateErrorResponseException(advancedbilling.exceptions.api_exception.APIException): +class SubscriptionGroupUpdateErrorResponseException(APIException): def __init__(self, reason, response): """Constructor for the SubscriptionGroupUpdateErrorResponseException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ self.errors = SubscriptionGroupUpdateError.from_dictionary(dictionary.get('errors')) if 'errors' in dictionary.keys() else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/subscription_remove_coupon_errors_exception.py b/advancedbilling/exceptions/subscription_remove_coupon_errors_exception.py index 2e3dfe66..df83c319 100644 --- a/advancedbilling/exceptions/subscription_remove_coupon_errors_exception.py +++ b/advancedbilling/exceptions/subscription_remove_coupon_errors_exception.py @@ -8,10 +8,10 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException -class SubscriptionRemoveCouponErrorsException(advancedbilling.exceptions.api_exception.APIException): +class SubscriptionRemoveCouponErrorsException(APIException): def __init__(self, reason, response): """Constructor for the SubscriptionRemoveCouponErrorsException class @@ -36,3 +36,9 @@ def unbox(self, dictionary): """ self.subscription = dictionary.get("subscription") if dictionary.get("subscription") else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'subscription={self.subscription!s})') diff --git a/advancedbilling/exceptions/subscription_response_error_exception.py b/advancedbilling/exceptions/subscription_response_error_exception.py index 702a4d3a..8936afea 100644 --- a/advancedbilling/exceptions/subscription_response_error_exception.py +++ b/advancedbilling/exceptions/subscription_response_error_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.subscription import Subscription -class SubscriptionResponseErrorException(advancedbilling.exceptions.api_exception.APIException): +class SubscriptionResponseErrorException(APIException): def __init__(self, reason, response): """Constructor for the SubscriptionResponseErrorException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ self.subscription = Subscription.from_dictionary(dictionary.get('subscription')) if 'subscription' in dictionary.keys() else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'subscription={self.subscription!s})') diff --git a/advancedbilling/exceptions/subscriptions_mrr_error_response_exception.py b/advancedbilling/exceptions/subscriptions_mrr_error_response_exception.py index 2d518ed2..ec5a3c74 100644 --- a/advancedbilling/exceptions/subscriptions_mrr_error_response_exception.py +++ b/advancedbilling/exceptions/subscriptions_mrr_error_response_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.attribute_error import AttributeError -class SubscriptionsMrrErrorResponseException(advancedbilling.exceptions.api_exception.APIException): +class SubscriptionsMrrErrorResponseException(APIException): def __init__(self, reason, response): """Constructor for the SubscriptionsMrrErrorResponseException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ self.errors = AttributeError.from_dictionary(dictionary.get('errors')) if dictionary.get('errors') else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/exceptions/too_many_management_link_requests_error_exception.py b/advancedbilling/exceptions/too_many_management_link_requests_error_exception.py index 806bec4c..1a43608b 100644 --- a/advancedbilling/exceptions/too_many_management_link_requests_error_exception.py +++ b/advancedbilling/exceptions/too_many_management_link_requests_error_exception.py @@ -8,11 +8,11 @@ """ from advancedbilling.api_helper import APIHelper -import advancedbilling.exceptions.api_exception +from advancedbilling.exceptions.api_exception import APIException from advancedbilling.models.too_many_management_link_requests import TooManyManagementLinkRequests -class TooManyManagementLinkRequestsErrorException(advancedbilling.exceptions.api_exception.APIException): +class TooManyManagementLinkRequestsErrorException(APIException): def __init__(self, reason, response): """Constructor for the TooManyManagementLinkRequestsErrorException class @@ -37,3 +37,9 @@ def unbox(self, dictionary): """ self.errors = TooManyManagementLinkRequests.from_dictionary(dictionary.get('errors')) if dictionary.get('errors') else None + + def __str__(self): + base_str = super().__str__() + return (f'{self.__class__.__name__}(' + f'{base_str[base_str.find("(") + 1:-1]}, ' + f'errors={self.errors!s})') diff --git a/advancedbilling/models/account_balance.py b/advancedbilling/models/account_balance.py index 2c496e7b..42c3a99e 100644 --- a/advancedbilling/models/account_balance.py +++ b/advancedbilling/models/account_balance.py @@ -13,13 +13,10 @@ class AccountBalance(object): """Implementation of the 'Account Balance' model. - TODO: type model description here. - Attributes: - balance_in_cents (long|int): The balance in cents. - automatic_balance_in_cents (long|int): The automatic balance in cents. - remittance_balance_in_cents (long|int): The remittance balance in - cents. + balance_in_cents (int): The balance in cents. + automatic_balance_in_cents (int): The automatic balance in cents. + remittance_balance_in_cents (int): The remittance balance in cents. additional_properties (Dict[str, object]): The additional properties for the model. @@ -92,3 +89,17 @@ def from_dictionary(cls, automatic_balance_in_cents, remittance_balance_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'balance_in_cents={self.balance_in_cents!r}, ' + f'automatic_balance_in_cents={self.automatic_balance_in_cents!r}, ' + f'remittance_balance_in_cents={self.remittance_balance_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'balance_in_cents={self.balance_in_cents!s}, ' + f'automatic_balance_in_cents={self.automatic_balance_in_cents!s}, ' + f'remittance_balance_in_cents={self.remittance_balance_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/account_balances.py b/advancedbilling/models/account_balances.py index e3889d21..31134e54 100644 --- a/advancedbilling/models/account_balances.py +++ b/advancedbilling/models/account_balances.py @@ -14,8 +14,6 @@ class AccountBalances(object): """Implementation of the 'Account Balances' model. - TODO: type model description here. - Attributes: open_invoices (AccountBalance): The balance, in cents, of the sum of the subscription's open, payable invoices. @@ -108,3 +106,21 @@ def from_dictionary(cls, service_credits, prepayments, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'open_invoices={self.open_invoices!r}, ' + f'pending_invoices={self.pending_invoices!r}, ' + f'pending_discounts={self.pending_discounts!r}, ' + f'service_credits={self.service_credits!r}, ' + f'prepayments={self.prepayments!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'open_invoices={self.open_invoices!s}, ' + f'pending_invoices={self.pending_invoices!s}, ' + f'pending_discounts={self.pending_discounts!s}, ' + f'service_credits={self.service_credits!s}, ' + f'prepayments={self.prepayments!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/ach_agreement.py b/advancedbilling/models/ach_agreement.py index 7fd0cdbf..63814151 100644 --- a/advancedbilling/models/ach_agreement.py +++ b/advancedbilling/models/ach_agreement.py @@ -121,3 +121,19 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'agreement_terms={self.agreement_terms!r}, ' + f'authorizer_first_name={self.authorizer_first_name!r}, ' + f'authorizer_last_name={self.authorizer_last_name!r}, ' + f'ip_address={self.ip_address!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'agreement_terms={self.agreement_terms!s}, ' + f'authorizer_first_name={self.authorizer_first_name!s}, ' + f'authorizer_last_name={self.authorizer_last_name!s}, ' + f'ip_address={self.ip_address!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/activate_event_based_component.py b/advancedbilling/models/activate_event_based_component.py index 3b5da93f..2ab30751 100644 --- a/advancedbilling/models/activate_event_based_component.py +++ b/advancedbilling/models/activate_event_based_component.py @@ -15,8 +15,6 @@ class ActivateEventBasedComponent(object): """Implementation of the 'Activate Event-Based Component' model. - TODO: type model description here. - Attributes: price_point_id (int): The Chargify id of the price point billing_schedule (BillingSchedule): This attribute is particularly @@ -92,3 +90,17 @@ def from_dictionary(cls, billing_schedule, custom_price, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_point_id={self.price_point_id!r}, ' + f'billing_schedule={self.billing_schedule!r}, ' + f'custom_price={self.custom_price!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_point_id={self.price_point_id!s}, ' + f'billing_schedule={self.billing_schedule!s}, ' + f'custom_price={self.custom_price!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/activate_subscription_request.py b/advancedbilling/models/activate_subscription_request.py index 6abd026e..50862e7a 100644 --- a/advancedbilling/models/activate_subscription_request.py +++ b/advancedbilling/models/activate_subscription_request.py @@ -13,8 +13,6 @@ class ActivateSubscriptionRequest(object): """Implementation of the 'Activate Subscription Request' model. - TODO: type model description here. - Attributes: revert_on_failure (bool): You may choose how to handle the activation failure. `true` means do not change the subscription’s state and @@ -79,3 +77,13 @@ def from_dictionary(cls, # Return an object of this model return cls(revert_on_failure, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'revert_on_failure={self.revert_on_failure!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'revert_on_failure={self.revert_on_failure!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/add_coupons_request.py b/advancedbilling/models/add_coupons_request.py index 5fd3828d..59d17e01 100644 --- a/advancedbilling/models/add_coupons_request.py +++ b/advancedbilling/models/add_coupons_request.py @@ -13,10 +13,8 @@ class AddCouponsRequest(object): """Implementation of the 'Add Coupons Request' model. - TODO: type model description here. - Attributes: - codes (List[str]): TODO: type description here. + codes (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(codes, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'codes={self.codes!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'codes={self.codes!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/add_subscription_to_a_group.py b/advancedbilling/models/add_subscription_to_a_group.py index 561e6c64..77635e98 100644 --- a/advancedbilling/models/add_subscription_to_a_group.py +++ b/advancedbilling/models/add_subscription_to_a_group.py @@ -14,10 +14,8 @@ class AddSubscriptionToAGroup(object): """Implementation of the 'Add Subscription to a Group' model. - TODO: type model description here. - Attributes: - group (GroupSettings): TODO: type description here. + group (GroupSettings): The model property of type GroupSettings. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(group, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'group={self.group!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'group={self.group!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/address_change.py b/advancedbilling/models/address_change.py index 0e1a9c5d..b07652d1 100644 --- a/advancedbilling/models/address_change.py +++ b/advancedbilling/models/address_change.py @@ -13,11 +13,9 @@ class AddressChange(object): """Implementation of the 'Address Change' model. - TODO: type model description here. - Attributes: - before (InvoiceAddress): TODO: type description here. - after (InvoiceAddress): TODO: type description here. + before (InvoiceAddress): The model property of type InvoiceAddress. + after (InvoiceAddress): The model property of type InvoiceAddress. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,15 @@ def from_dictionary(cls, return cls(before, after, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'before={self.before!r}, ' + f'after={self.after!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'before={self.before!s}, ' + f'after={self.after!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/agreement_acceptance.py b/advancedbilling/models/agreement_acceptance.py index bf31b206..f178a448 100644 --- a/advancedbilling/models/agreement_acceptance.py +++ b/advancedbilling/models/agreement_acceptance.py @@ -20,10 +20,10 @@ class AgreementAcceptance(object): terms_url (str): Required when creating a subscription with Maxio Payments. Either terms_url or provacy_policy_url required when providing agreement_acceptance params. - privacy_policy_url (str): TODO: type description here. - return_refund_policy_url (str): TODO: type description here. - delivery_policy_url (str): TODO: type description here. - secure_checkout_policy_url (str): TODO: type description here. + privacy_policy_url (str): The model property of type str. + return_refund_policy_url (str): The model property of type str. + delivery_policy_url (str): The model property of type str. + secure_checkout_policy_url (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -134,3 +134,23 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'ip_address={self.ip_address!r}, ' + f'terms_url={self.terms_url!r}, ' + f'privacy_policy_url={self.privacy_policy_url!r}, ' + f'return_refund_policy_url={self.return_refund_policy_url!r}, ' + f'delivery_policy_url={self.delivery_policy_url!r}, ' + f'secure_checkout_policy_url={self.secure_checkout_policy_url!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'ip_address={self.ip_address!s}, ' + f'terms_url={self.terms_url!s}, ' + f'privacy_policy_url={self.privacy_policy_url!s}, ' + f'return_refund_policy_url={self.return_refund_policy_url!s}, ' + f'delivery_policy_url={self.delivery_policy_url!s}, ' + f'secure_checkout_policy_url={self.secure_checkout_policy_url!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/all_vaults.py b/advancedbilling/models/all_vaults.py index a25bc470..7714c313 100644 --- a/advancedbilling/models/all_vaults.py +++ b/advancedbilling/models/all_vaults.py @@ -16,40 +16,40 @@ class AllVaults(object): Use `bogus` for testing. Attributes: - ADYEN: TODO: type description here. - AUTHORIZENET: TODO: type description here. - BEANSTREAM: TODO: type description here. - BLUE_SNAP: TODO: type description here. - BOGUS: TODO: type description here. - BRAINTREE1: TODO: type description here. - BRAINTREE_BLUE: TODO: type description here. - CHECKOUT: TODO: type description here. - CYBERSOURCE: TODO: type description here. - ELAVON: TODO: type description here. - EWAY: TODO: type description here. - EWAY_RAPID: TODO: type description here. - EWAY_RAPID_STD: TODO: type description here. - FIRSTDATA: TODO: type description here. - FORTE: TODO: type description here. - GOCARDLESS: TODO: type description here. - LITLE: TODO: type description here. - MAXIO_PAYMENTS: TODO: type description here. - MAXP: TODO: type description here. - MODUSLINK: TODO: type description here. - MONERIS: TODO: type description here. - NMI: TODO: type description here. - ORBITAL: TODO: type description here. - PAYMENT_EXPRESS: TODO: type description here. - PAYMILL: TODO: type description here. - PAYPAL: TODO: type description here. - PAYPAL_COMPLETE: TODO: type description here. - PIN: TODO: type description here. - SQUARE: TODO: type description here. - STRIPE: TODO: type description here. - STRIPE_CONNECT: TODO: type description here. - TRUST_COMMERCE: TODO: type description here. - UNIPAAS: TODO: type description here. - WIRECARD: TODO: type description here. + ADYEN: The enum member of type str. + AUTHORIZENET: The enum member of type str. + BEANSTREAM: The enum member of type str. + BLUE_SNAP: The enum member of type str. + BOGUS: The enum member of type str. + BRAINTREE1: The enum member of type str. + BRAINTREE_BLUE: The enum member of type str. + CHECKOUT: The enum member of type str. + CYBERSOURCE: The enum member of type str. + ELAVON: The enum member of type str. + EWAY: The enum member of type str. + EWAY_RAPID: The enum member of type str. + EWAY_RAPID_STD: The enum member of type str. + FIRSTDATA: The enum member of type str. + FORTE: The enum member of type str. + GOCARDLESS: The enum member of type str. + LITLE: The enum member of type str. + MAXIO_PAYMENTS: The enum member of type str. + MAXP: The enum member of type str. + MODUSLINK: The enum member of type str. + MONERIS: The enum member of type str. + NMI: The enum member of type str. + ORBITAL: The enum member of type str. + PAYMENT_EXPRESS: The enum member of type str. + PAYMILL: The enum member of type str. + PAYPAL: The enum member of type str. + PAYPAL_COMPLETE: The enum member of type str. + PIN: The enum member of type str. + SQUARE: The enum member of type str. + STRIPE: The enum member of type str. + STRIPE_CONNECT: The enum member of type str. + TRUST_COMMERCE: The enum member of type str. + UNIPAAS: The enum member of type str. + WIRECARD: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/allocate_components.py b/advancedbilling/models/allocate_components.py index ecd80deb..a5ecaa17 100644 --- a/advancedbilling/models/allocate_components.py +++ b/advancedbilling/models/allocate_components.py @@ -14,13 +14,12 @@ class AllocateComponents(object): """Implementation of the 'Allocate Components' model. - TODO: type model description here. - Attributes: - proration_upgrade_scheme (str): TODO: type description here. - proration_downgrade_scheme (str): TODO: type description here. - allocations (List[CreateAllocation]): TODO: type description here. - accrue_charge (bool): TODO: type description here. + proration_upgrade_scheme (str): The model property of type str. + proration_downgrade_scheme (str): The model property of type str. + allocations (List[CreateAllocation]): The model property of type + List[CreateAllocation]. + accrue_charge (bool): The model property of type bool. upgrade_charge (CreditType): The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, @@ -146,3 +145,27 @@ def from_dictionary(cls, payment_collection_method, initiate_dunning, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'proration_upgrade_scheme={self.proration_upgrade_scheme!r}, ' + f'proration_downgrade_scheme={self.proration_downgrade_scheme!r}, ' + f'allocations={self.allocations!r}, ' + f'accrue_charge={self.accrue_charge!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'payment_collection_method={self.payment_collection_method!r}, ' + f'initiate_dunning={self.initiate_dunning!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'proration_upgrade_scheme={self.proration_upgrade_scheme!s}, ' + f'proration_downgrade_scheme={self.proration_downgrade_scheme!s}, ' + f'allocations={self.allocations!s}, ' + f'accrue_charge={self.accrue_charge!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'payment_collection_method={self.payment_collection_method!s}, ' + f'initiate_dunning={self.initiate_dunning!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/allocation.py b/advancedbilling/models/allocation.py index 6cd0deb5..abcdb8f1 100644 --- a/advancedbilling/models/allocation.py +++ b/advancedbilling/models/allocation.py @@ -14,8 +14,6 @@ class Allocation(object): """Implementation of the 'Allocation' model. - TODO: type model description here. - Attributes: allocation_id (int): The allocation unique id component_id (int): The integer component ID for the allocation. This @@ -41,9 +39,9 @@ class Allocation(object): proration_downgrade_scheme (str): The scheme used if the proration was a downgrade. This is only present when the allocation was created mid-period. - price_point_id (int): TODO: type description here. - price_point_name (str): TODO: type description here. - price_point_handle (str): TODO: type description here. + price_point_id (int): The model property of type int. + price_point_name (str): The model property of type str. + price_point_handle (str): The model property of type str. interval (int): The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only @@ -51,7 +49,7 @@ class Allocation(object): interval_unit (IntervalUnit): A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. - previous_price_point_id (int): TODO: type description here. + previous_price_point_id (int): The model property of type int. accrue_charge (bool): If the change in cost is an upgrade, this determines if the charge should accrue to the next renewal or if capture should be attempted immediately. @@ -66,10 +64,11 @@ class Allocation(object): upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, `prorated`, `none`. - payment (PaymentForAllocation): TODO: type description here. - expires_at (datetime): TODO: type description here. - used_quantity (long|int): TODO: type description here. - charge_id (long|int): TODO: type description here. + payment (PaymentForAllocation): The model property of type + PaymentForAllocation. + expires_at (datetime): The model property of type datetime. + used_quantity (int): The model property of type int. + charge_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -304,3 +303,61 @@ def from_dictionary(cls, used_quantity, charge_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'allocation_id={self.allocation_id!r}, ' + f'component_id={self.component_id!r}, ' + f'component_handle={self.component_handle!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'quantity={self.quantity!r}, ' + f'previous_quantity={self.previous_quantity!r}, ' + f'memo={self.memo!r}, ' + f'timestamp={self.timestamp!r}, ' + f'created_at={self.created_at!r}, ' + f'proration_upgrade_scheme={self.proration_upgrade_scheme!r}, ' + f'proration_downgrade_scheme={self.proration_downgrade_scheme!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'price_point_name={self.price_point_name!r}, ' + f'price_point_handle={self.price_point_handle!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'previous_price_point_id={self.previous_price_point_id!r}, ' + f'accrue_charge={self.accrue_charge!r}, ' + f'initiate_dunning={self.initiate_dunning!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'payment={self.payment!r}, ' + f'expires_at={self.expires_at!r}, ' + f'used_quantity={self.used_quantity!r}, ' + f'charge_id={self.charge_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'allocation_id={self.allocation_id!s}, ' + f'component_id={self.component_id!s}, ' + f'component_handle={self.component_handle!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'quantity={self.quantity!s}, ' + f'previous_quantity={self.previous_quantity!s}, ' + f'memo={self.memo!s}, ' + f'timestamp={self.timestamp!s}, ' + f'created_at={self.created_at!s}, ' + f'proration_upgrade_scheme={self.proration_upgrade_scheme!s}, ' + f'proration_downgrade_scheme={self.proration_downgrade_scheme!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'price_point_name={self.price_point_name!s}, ' + f'price_point_handle={self.price_point_handle!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'previous_price_point_id={self.previous_price_point_id!s}, ' + f'accrue_charge={self.accrue_charge!s}, ' + f'initiate_dunning={self.initiate_dunning!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'payment={self.payment!s}, ' + f'expires_at={self.expires_at!s}, ' + f'used_quantity={self.used_quantity!s}, ' + f'charge_id={self.charge_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/allocation_expiration_date.py b/advancedbilling/models/allocation_expiration_date.py index af3d8d57..d0a5825b 100644 --- a/advancedbilling/models/allocation_expiration_date.py +++ b/advancedbilling/models/allocation_expiration_date.py @@ -13,10 +13,8 @@ class AllocationExpirationDate(object): """Implementation of the 'Allocation Expiration Date' model. - TODO: type model description here. - Attributes: - expires_at (datetime): TODO: type description here. + expires_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(expires_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'expires_at={self.expires_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'expires_at={self.expires_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/allocation_preview.py b/advancedbilling/models/allocation_preview.py index e258a736..eea5cc4b 100644 --- a/advancedbilling/models/allocation_preview.py +++ b/advancedbilling/models/allocation_preview.py @@ -15,24 +15,24 @@ class AllocationPreview(object): """Implementation of the 'Allocation Preview' model. - TODO: type model description here. - Attributes: - start_date (datetime): TODO: type description here. - end_date (datetime): TODO: type description here. - subtotal_in_cents (long|int): TODO: type description here. - total_tax_in_cents (long|int): TODO: type description here. - total_discount_in_cents (long|int): TODO: type description here. - total_in_cents (long|int): TODO: type description here. - direction (AllocationPreviewDirection): TODO: type description here. - proration_scheme (str): TODO: type description here. - line_items (List[AllocationPreviewLineItem]): TODO: type description - here. - accrue_charge (bool): TODO: type description here. - allocations (List[AllocationPreviewItem]): TODO: type description here. - period_type (str): TODO: type description here. - existing_balance_in_cents (long|int): An integer representing the - amount of the subscription's current balance + start_date (datetime): The model property of type datetime. + end_date (datetime): The model property of type datetime. + subtotal_in_cents (int): The model property of type int. + total_tax_in_cents (int): The model property of type int. + total_discount_in_cents (int): The model property of type int. + total_in_cents (int): The model property of type int. + direction (AllocationPreviewDirection): The model property of type + AllocationPreviewDirection. + proration_scheme (str): The model property of type str. + line_items (List[AllocationPreviewLineItem]): The model property of + type List[AllocationPreviewLineItem]. + accrue_charge (bool): The model property of type bool. + allocations (List[AllocationPreviewItem]): The model property of type + List[AllocationPreviewItem]. + period_type (str): The model property of type str. + existing_balance_in_cents (int): An integer representing the amount of + the subscription's current balance additional_properties (Dict[str, object]): The additional properties for the model. @@ -178,3 +178,37 @@ def from_dictionary(cls, period_type, existing_balance_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'start_date={self.start_date!r}, ' + f'end_date={self.end_date!r}, ' + f'subtotal_in_cents={self.subtotal_in_cents!r}, ' + f'total_tax_in_cents={self.total_tax_in_cents!r}, ' + f'total_discount_in_cents={self.total_discount_in_cents!r}, ' + f'total_in_cents={self.total_in_cents!r}, ' + f'direction={self.direction!r}, ' + f'proration_scheme={self.proration_scheme!r}, ' + f'line_items={self.line_items!r}, ' + f'accrue_charge={self.accrue_charge!r}, ' + f'allocations={self.allocations!r}, ' + f'period_type={self.period_type!r}, ' + f'existing_balance_in_cents={self.existing_balance_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'start_date={self.start_date!s}, ' + f'end_date={self.end_date!s}, ' + f'subtotal_in_cents={self.subtotal_in_cents!s}, ' + f'total_tax_in_cents={self.total_tax_in_cents!s}, ' + f'total_discount_in_cents={self.total_discount_in_cents!s}, ' + f'total_in_cents={self.total_in_cents!s}, ' + f'direction={self.direction!s}, ' + f'proration_scheme={self.proration_scheme!s}, ' + f'line_items={self.line_items!s}, ' + f'accrue_charge={self.accrue_charge!s}, ' + f'allocations={self.allocations!s}, ' + f'period_type={self.period_type!s}, ' + f'existing_balance_in_cents={self.existing_balance_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/allocation_preview_direction.py b/advancedbilling/models/allocation_preview_direction.py index c4ba5d8a..423580da 100644 --- a/advancedbilling/models/allocation_preview_direction.py +++ b/advancedbilling/models/allocation_preview_direction.py @@ -12,11 +12,9 @@ class AllocationPreviewDirection(object): """Implementation of the 'Allocation Preview Direction' enum. - TODO: type enum description here. - Attributes: - UPGRADE: TODO: type description here. - DOWNGRADE: TODO: type description here. + UPGRADE: The enum member of type str. + DOWNGRADE: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/allocation_preview_item.py b/advancedbilling/models/allocation_preview_item.py index 14e77e5a..b6b74097 100644 --- a/advancedbilling/models/allocation_preview_item.py +++ b/advancedbilling/models/allocation_preview_item.py @@ -13,18 +13,18 @@ class AllocationPreviewItem(object): """Implementation of the 'Allocation Preview Item' model. - TODO: type model description here. - Attributes: - component_id (int): TODO: type description here. - subscription_id (int): TODO: type description here. - quantity (int | str | None): TODO: type description here. - previous_quantity (int | str | None): TODO: type description here. - memo (str): TODO: type description here. - timestamp (str): TODO: type description here. - proration_upgrade_scheme (str): TODO: type description here. - proration_downgrade_scheme (str): TODO: type description here. - accrue_charge (bool): TODO: type description here. + component_id (int): The model property of type int. + subscription_id (int): The model property of type int. + quantity (int | str | None): The model property of type int | str | + None. + previous_quantity (int | str | None): The model property of type int | + str | None. + memo (str): The model property of type str. + timestamp (str): The model property of type str. + proration_upgrade_scheme (str): The model property of type str. + proration_downgrade_scheme (str): The model property of type str. + accrue_charge (bool): The model property of type bool. upgrade_charge (CreditType): The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, @@ -33,7 +33,7 @@ class AllocationPreviewItem(object): upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, `prorated`, `none`. - price_point_id (int): TODO: type description here. + price_point_id (int): The model property of type int. interval (int): The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only @@ -41,10 +41,10 @@ class AllocationPreviewItem(object): interval_unit (IntervalUnit): A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. - previous_price_point_id (int): TODO: type description here. - price_point_handle (str): TODO: type description here. - price_point_name (str): TODO: type description here. - component_handle (str): TODO: type description here. + previous_price_point_id (int): The model property of type int. + price_point_handle (str): The model property of type str. + price_point_name (str): The model property of type str. + component_handle (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -227,3 +227,47 @@ def from_dictionary(cls, price_point_name, component_handle, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'quantity={self.quantity!r}, ' + f'previous_quantity={self.previous_quantity!r}, ' + f'memo={self.memo!r}, ' + f'timestamp={self.timestamp!r}, ' + f'proration_upgrade_scheme={self.proration_upgrade_scheme!r}, ' + f'proration_downgrade_scheme={self.proration_downgrade_scheme!r}, ' + f'accrue_charge={self.accrue_charge!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'previous_price_point_id={self.previous_price_point_id!r}, ' + f'price_point_handle={self.price_point_handle!r}, ' + f'price_point_name={self.price_point_name!r}, ' + f'component_handle={self.component_handle!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'quantity={self.quantity!s}, ' + f'previous_quantity={self.previous_quantity!s}, ' + f'memo={self.memo!s}, ' + f'timestamp={self.timestamp!s}, ' + f'proration_upgrade_scheme={self.proration_upgrade_scheme!s}, ' + f'proration_downgrade_scheme={self.proration_downgrade_scheme!s}, ' + f'accrue_charge={self.accrue_charge!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'previous_price_point_id={self.previous_price_point_id!s}, ' + f'price_point_handle={self.price_point_handle!s}, ' + f'price_point_name={self.price_point_name!s}, ' + f'component_handle={self.component_handle!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/allocation_preview_line_item.py b/advancedbilling/models/allocation_preview_line_item.py index bff2d4c9..dff6202e 100644 --- a/advancedbilling/models/allocation_preview_line_item.py +++ b/advancedbilling/models/allocation_preview_line_item.py @@ -13,19 +13,17 @@ class AllocationPreviewLineItem(object): """Implementation of the 'Allocation Preview Line Item' model. - TODO: type model description here. - Attributes: transaction_type (LineItemTransactionType): A handle for the line item transaction type kind (AllocationPreviewLineItemKind): A handle for the line item kind for allocation preview - amount_in_cents (long|int): TODO: type description here. - memo (str): TODO: type description here. - discount_amount_in_cents (long|int): TODO: type description here. - taxable_amount_in_cents (long|int): TODO: type description here. - component_id (int): TODO: type description here. - component_handle (str): TODO: type description here. + amount_in_cents (int): The model property of type int. + memo (str): The model property of type str. + discount_amount_in_cents (int): The model property of type int. + taxable_amount_in_cents (int): The model property of type int. + component_id (int): The model property of type int. + component_handle (str): The model property of type str. direction (AllocationPreviewDirection): Visible when using Fine-grained Component Control additional_properties (Dict[str, object]): The additional properties @@ -137,3 +135,29 @@ def from_dictionary(cls, component_handle, direction, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'transaction_type={self.transaction_type!r}, ' + f'kind={self.kind!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'memo={self.memo!r}, ' + f'discount_amount_in_cents={self.discount_amount_in_cents!r}, ' + f'taxable_amount_in_cents={self.taxable_amount_in_cents!r}, ' + f'component_id={self.component_id!r}, ' + f'component_handle={self.component_handle!r}, ' + f'direction={self.direction!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'transaction_type={self.transaction_type!s}, ' + f'kind={self.kind!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'memo={self.memo!s}, ' + f'discount_amount_in_cents={self.discount_amount_in_cents!s}, ' + f'taxable_amount_in_cents={self.taxable_amount_in_cents!s}, ' + f'component_id={self.component_id!s}, ' + f'component_handle={self.component_handle!s}, ' + f'direction={self.direction!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/allocation_preview_line_item_kind.py b/advancedbilling/models/allocation_preview_line_item_kind.py index a9e56732..eac61e0e 100644 --- a/advancedbilling/models/allocation_preview_line_item_kind.py +++ b/advancedbilling/models/allocation_preview_line_item_kind.py @@ -15,10 +15,10 @@ class AllocationPreviewLineItemKind(object): A handle for the line item kind for allocation preview Attributes: - QUANTITY_BASED_COMPONENT: TODO: type description here. - ON_OFF_COMPONENT: TODO: type description here. - COUPON: TODO: type description here. - TAX: TODO: type description here. + QUANTITY_BASED_COMPONENT: The enum member of type str. + ON_OFF_COMPONENT: The enum member of type str. + COUPON: The enum member of type str. + TAX: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/allocation_preview_response.py b/advancedbilling/models/allocation_preview_response.py index eafdee9a..37e4eee1 100644 --- a/advancedbilling/models/allocation_preview_response.py +++ b/advancedbilling/models/allocation_preview_response.py @@ -13,10 +13,9 @@ class AllocationPreviewResponse(object): """Implementation of the 'Allocation Preview Response' model. - TODO: type model description here. - Attributes: - allocation_preview (AllocationPreview): TODO: type description here. + allocation_preview (AllocationPreview): The model property of type + AllocationPreview. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(allocation_preview, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'allocation_preview={self.allocation_preview!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'allocation_preview={self.allocation_preview!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/allocation_response.py b/advancedbilling/models/allocation_response.py index dd7d0db7..20d65056 100644 --- a/advancedbilling/models/allocation_response.py +++ b/advancedbilling/models/allocation_response.py @@ -14,10 +14,8 @@ class AllocationResponse(object): """Implementation of the 'Allocation Response' model. - TODO: type model description here. - Attributes: - allocation (Allocation): TODO: type description here. + allocation (Allocation): The model property of type Allocation. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(allocation, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'allocation={self.allocation!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'allocation={self.allocation!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/allocation_settings.py b/advancedbilling/models/allocation_settings.py index a51c0622..fb632d3f 100644 --- a/advancedbilling/models/allocation_settings.py +++ b/advancedbilling/models/allocation_settings.py @@ -13,8 +13,6 @@ class AllocationSettings(object): """Implementation of the 'Allocation Settings' model. - TODO: type model description here. - Attributes: upgrade_charge (CreditType): The type of credit to be created when upgrading/downgrading. Defaults to the component and then site @@ -97,3 +95,17 @@ def from_dictionary(cls, downgrade_credit, accrue_charge, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'accrue_charge={self.accrue_charge!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'accrue_charge={self.accrue_charge!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/apple_pay_payment_profile.py b/advancedbilling/models/apple_pay_payment_profile.py index bdbf4e0f..08b7711a 100644 --- a/advancedbilling/models/apple_pay_payment_profile.py +++ b/advancedbilling/models/apple_pay_payment_profile.py @@ -14,8 +14,6 @@ class ApplePayPaymentProfile(object): """Implementation of the 'ApplePay Payment Profile' model. - TODO: type model description here. - Attributes: id (int): The Chargify-assigned ID of the Apple Pay payment profile. first_name (str): The first name of the Apple Pay account holder @@ -36,12 +34,12 @@ class ApplePayPaymentProfile(object): Pay account billing_country (str): The current billing address country for the Apple Pay account - customer_vault_token (str): TODO: type description here. + customer_vault_token (str): The model property of type str. billing_address_2 (str): The current billing street address, second line, for the Apple Pay account - payment_type (PaymentType): TODO: type description here. - site_gateway_setting_id (int): TODO: type description here. - gateway_handle (str): TODO: type description here. + payment_type (PaymentType): The model property of type PaymentType. + site_gateway_setting_id (int): The model property of type int. + gateway_handle (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -234,3 +232,43 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('payment_type'), type_callable=lambda value: PaymentType.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'customer_id={self.customer_id!r}, ' + f'current_vault={self.current_vault!r}, ' + f'vault_token={self.vault_token!r}, ' + f'billing_address={self.billing_address!r}, ' + f'billing_city={self.billing_city!r}, ' + f'billing_state={self.billing_state!r}, ' + f'billing_zip={self.billing_zip!r}, ' + f'billing_country={self.billing_country!r}, ' + f'customer_vault_token={self.customer_vault_token!r}, ' + f'billing_address_2={self.billing_address_2!r}, ' + f'payment_type={self.payment_type!r}, ' + f'site_gateway_setting_id={self.site_gateway_setting_id!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'customer_id={self.customer_id!s}, ' + f'current_vault={self.current_vault!s}, ' + f'vault_token={self.vault_token!s}, ' + f'billing_address={self.billing_address!s}, ' + f'billing_city={self.billing_city!s}, ' + f'billing_state={self.billing_state!s}, ' + f'billing_zip={self.billing_zip!s}, ' + f'billing_country={self.billing_country!s}, ' + f'customer_vault_token={self.customer_vault_token!s}, ' + f'billing_address_2={self.billing_address_2!s}, ' + f'payment_type={self.payment_type!s}, ' + f'site_gateway_setting_id={self.site_gateway_setting_id!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/apple_pay_vault.py b/advancedbilling/models/apple_pay_vault.py index 3ab1b62a..412e450c 100644 --- a/advancedbilling/models/apple_pay_vault.py +++ b/advancedbilling/models/apple_pay_vault.py @@ -15,7 +15,7 @@ class ApplePayVault(object): The vault that stores the payment profile with the provided vault_token. Attributes: - BRAINTREE_BLUE: TODO: type description here. + BRAINTREE_BLUE: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/applied_credit_note_data.py b/advancedbilling/models/applied_credit_note_data.py index caf52787..cc3eda55 100644 --- a/advancedbilling/models/applied_credit_note_data.py +++ b/advancedbilling/models/applied_credit_note_data.py @@ -13,8 +13,6 @@ class AppliedCreditNoteData(object): """Implementation of the 'Applied Credit Note Data' model. - TODO: type model description here. - Attributes: uid (str): The UID of the credit note number (str): The number of the credit note @@ -100,3 +98,15 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'number={self.number!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'number={self.number!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/apply_credit_note_event.py b/advancedbilling/models/apply_credit_note_event.py index bbab878c..2b5c0deb 100644 --- a/advancedbilling/models/apply_credit_note_event.py +++ b/advancedbilling/models/apply_credit_note_event.py @@ -16,13 +16,12 @@ class ApplyCreditNoteEvent(object): """Implementation of the 'Apply Credit Note Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (ApplyCreditNoteEventData): Example schema for an `apply_credit_note` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: ApplyCreditNoteEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/apply_credit_note_event_data.py b/advancedbilling/models/apply_credit_note_event_data.py index 8ed2f4d8..3b3720f1 100644 --- a/advancedbilling/models/apply_credit_note_event_data.py +++ b/advancedbilling/models/apply_credit_note_event_data.py @@ -189,3 +189,31 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('applied_amount'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'credit_note_number={self.credit_note_number!r}, ' + f'credit_note_uid={self.credit_note_uid!r}, ' + f'original_amount={self.original_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'memo={self.memo!r}, ' + f'role={self.role!r}, ' + f'consolidated_invoice={self.consolidated_invoice!r}, ' + f'applied_credit_notes={self.applied_credit_notes!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'credit_note_number={self.credit_note_number!s}, ' + f'credit_note_uid={self.credit_note_uid!s}, ' + f'original_amount={self.original_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'memo={self.memo!s}, ' + f'role={self.role!s}, ' + f'consolidated_invoice={self.consolidated_invoice!s}, ' + f'applied_credit_notes={self.applied_credit_notes!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/apply_debit_note_event.py b/advancedbilling/models/apply_debit_note_event.py index 582e3c80..bce3ff51 100644 --- a/advancedbilling/models/apply_debit_note_event.py +++ b/advancedbilling/models/apply_debit_note_event.py @@ -16,13 +16,12 @@ class ApplyDebitNoteEvent(object): """Implementation of the 'Apply Debit Note Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (ApplyDebitNoteEventData): Example schema for an `apply_debit_note` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: ApplyDebitNoteEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/apply_debit_note_event_data.py b/advancedbilling/models/apply_debit_note_event_data.py index 4008ca91..ac915562 100644 --- a/advancedbilling/models/apply_debit_note_event_data.py +++ b/advancedbilling/models/apply_debit_note_event_data.py @@ -150,3 +150,23 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('applied_amount'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'debit_note_number={self.debit_note_number!r}, ' + f'debit_note_uid={self.debit_note_uid!r}, ' + f'original_amount={self.original_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'memo={self.memo!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'debit_note_number={self.debit_note_number!s}, ' + f'debit_note_uid={self.debit_note_uid!s}, ' + f'original_amount={self.original_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'memo={self.memo!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/apply_payment_event.py b/advancedbilling/models/apply_payment_event.py index d664f7d3..709f6c85 100644 --- a/advancedbilling/models/apply_payment_event.py +++ b/advancedbilling/models/apply_payment_event.py @@ -16,13 +16,12 @@ class ApplyPaymentEvent(object): """Implementation of the 'Apply Payment Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (ApplyPaymentEventData): Example schema for an `apply_payment` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: ApplyPaymentEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/apply_payment_event_data.py b/advancedbilling/models/apply_payment_event_data.py index 9036a978..1d3ccc9c 100644 --- a/advancedbilling/models/apply_payment_event_data.py +++ b/advancedbilling/models/apply_payment_event_data.py @@ -17,8 +17,8 @@ class ApplyPaymentEventData(object): Example schema for an `apply_payment` event Attributes: - consolidation_level (InvoiceConsolidationLevel): TODO: type - description here. + consolidation_level (InvoiceConsolidationLevel): The model property of + type InvoiceConsolidationLevel. memo (str): The payment memo original_amount (str): The full, original amount of the payment transaction as a string in full units. Incoming payments can be @@ -39,10 +39,10 @@ class ApplyPaymentEventData(object): PaymentMethodPaypal): A nested data structure detailing the method of payment transaction_id (int): The Chargify id of the original payment - parent_invoice_number (int): TODO: type description here. - remaining_prepayment_amount (str): TODO: type description here. - prepayment (bool): TODO: type description here. - external (bool): TODO: type description here. + parent_invoice_number (int): The model property of type int. + remaining_prepayment_amount (str): The model property of type str. + prepayment (bool): The model property of type bool. + external (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -203,3 +203,33 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('transaction_time'), type_callable=lambda value: isinstance(value, str)) \ and UnionTypeLookUp.get('Invoice-Event-Payment').validate(dictionary.get('payment_method')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'consolidation_level={self.consolidation_level!r}, ' + f'memo={self.memo!r}, ' + f'original_amount={self.original_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'payment_method={self.payment_method!r}, ' + f'transaction_id={self.transaction_id!r}, ' + f'parent_invoice_number={self.parent_invoice_number!r}, ' + f'remaining_prepayment_amount={self.remaining_prepayment_amount!r}, ' + f'prepayment={self.prepayment!r}, ' + f'external={self.external!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'consolidation_level={self.consolidation_level!s}, ' + f'memo={self.memo!s}, ' + f'original_amount={self.original_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'payment_method={self.payment_method!s}, ' + f'transaction_id={self.transaction_id!s}, ' + f'parent_invoice_number={self.parent_invoice_number!s}, ' + f'remaining_prepayment_amount={self.remaining_prepayment_amount!s}, ' + f'prepayment={self.prepayment!s}, ' + f'external={self.external!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/attribute_error.py b/advancedbilling/models/attribute_error.py index 35606562..58717ce5 100644 --- a/advancedbilling/models/attribute_error.py +++ b/advancedbilling/models/attribute_error.py @@ -12,10 +12,8 @@ class AttributeError(object): """Implementation of the 'Attribute Error' model. - TODO: type model description here. - Attributes: - attribute (List[str]): TODO: type description here. + attribute (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -64,3 +62,13 @@ def from_dictionary(cls, # Return an object of this model return cls(attribute, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'attribute={self.attribute!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'attribute={self.attribute!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/auto_invite.py b/advancedbilling/models/auto_invite.py index 638ed6ab..6b5f9ba4 100644 --- a/advancedbilling/models/auto_invite.py +++ b/advancedbilling/models/auto_invite.py @@ -12,8 +12,6 @@ class AutoInvite(object): """Implementation of the 'Auto Invite' enum. - TODO: type enum description here. - Attributes: NO: Do not send the invitation email. YES: Automatically send the invitation email. diff --git a/advancedbilling/models/auto_resume.py b/advancedbilling/models/auto_resume.py index 9deaddd4..c13e8eaa 100644 --- a/advancedbilling/models/auto_resume.py +++ b/advancedbilling/models/auto_resume.py @@ -13,10 +13,9 @@ class AutoResume(object): """Implementation of the 'Auto Resume' model. - TODO: type model description here. - Attributes: - automatically_resume_at (datetime): TODO: type description here. + automatically_resume_at (datetime): The model property of type + datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -77,3 +76,13 @@ def from_dictionary(cls, # Return an object of this model return cls(automatically_resume_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'automatically_resume_at={self.automatically_resume_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'automatically_resume_at={self.automatically_resume_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/backport_invoice_event.py b/advancedbilling/models/backport_invoice_event.py index c6f782ff..b2fa315c 100644 --- a/advancedbilling/models/backport_invoice_event.py +++ b/advancedbilling/models/backport_invoice_event.py @@ -15,13 +15,12 @@ class BackportInvoiceEvent(object): """Implementation of the 'Backport Invoice Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (Invoice): Example schema for an `backport_invoice` event additional_properties (Dict[str, object]): The additional properties for the model. @@ -135,3 +134,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: Invoice.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bank_account_attributes.py b/advancedbilling/models/bank_account_attributes.py index 8df760d6..5cfa8ec2 100644 --- a/advancedbilling/models/bank_account_attributes.py +++ b/advancedbilling/models/bank_account_attributes.py @@ -13,10 +13,8 @@ class BankAccountAttributes(object): """Implementation of the 'Bank Account Attributes' model. - TODO: type model description here. - Attributes: - chargify_token (str): TODO: type description here. + chargify_token (str): The model property of type str. bank_name (str): (Required when creating a subscription with ACH or GoCardless) The name of the bank where the customer’s account resides @@ -34,10 +32,10 @@ class BankAccountAttributes(object): GoCardless). International Bank Account Number. Alternatively, local bank details can be provided bank_account_holder_type (BankAccountHolderType): Defaults to personal - payment_type (PaymentType): TODO: type description here. + payment_type (PaymentType): The model property of type PaymentType. current_vault (BankAccountVault): The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. - vault_token (str): TODO: type description here. + vault_token (str): The model property of type str. customer_vault_token (str): (only for Authorize.Net CIM storage or Square) The customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token @@ -193,3 +191,35 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'chargify_token={self.chargify_token!r}, ' + f'bank_name={self.bank_name!r}, ' + f'bank_routing_number={self.bank_routing_number!r}, ' + f'bank_account_number={self.bank_account_number!r}, ' + f'bank_account_type={self.bank_account_type!r}, ' + f'bank_branch_code={self.bank_branch_code!r}, ' + f'bank_iban={self.bank_iban!r}, ' + f'bank_account_holder_type={self.bank_account_holder_type!r}, ' + f'payment_type={self.payment_type!r}, ' + f'current_vault={self.current_vault!r}, ' + f'vault_token={self.vault_token!r}, ' + f'customer_vault_token={self.customer_vault_token!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'chargify_token={self.chargify_token!s}, ' + f'bank_name={self.bank_name!s}, ' + f'bank_routing_number={self.bank_routing_number!s}, ' + f'bank_account_number={self.bank_account_number!s}, ' + f'bank_account_type={self.bank_account_type!s}, ' + f'bank_branch_code={self.bank_branch_code!s}, ' + f'bank_iban={self.bank_iban!s}, ' + f'bank_account_holder_type={self.bank_account_holder_type!s}, ' + f'payment_type={self.payment_type!s}, ' + f'current_vault={self.current_vault!s}, ' + f'vault_token={self.vault_token!s}, ' + f'customer_vault_token={self.customer_vault_token!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bank_account_holder_type.py b/advancedbilling/models/bank_account_holder_type.py index 07c124f2..67fa130d 100644 --- a/advancedbilling/models/bank_account_holder_type.py +++ b/advancedbilling/models/bank_account_holder_type.py @@ -15,8 +15,8 @@ class BankAccountHolderType(object): Defaults to personal Attributes: - PERSONAL: TODO: type description here. - BUSINESS: TODO: type description here. + PERSONAL: The enum member of type str. + BUSINESS: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/bank_account_payment_profile.py b/advancedbilling/models/bank_account_payment_profile.py index 6f0e532d..c12c972a 100644 --- a/advancedbilling/models/bank_account_payment_profile.py +++ b/advancedbilling/models/bank_account_payment_profile.py @@ -14,8 +14,6 @@ class BankAccountPaymentProfile(object): """Implementation of the 'Bank Account Payment Profile' model. - TODO: type model description here. - Attributes: id (int): The Chargify-assigned ID of the stored bank account. This value can be used as an input to payment_profile_id when creating @@ -53,11 +51,11 @@ class BankAccountPaymentProfile(object): with X’s (i.e. ‘XXXXXXX1111’) bank_account_type (BankAccountType): Defaults to checking bank_account_holder_type (BankAccountHolderType): Defaults to personal - payment_type (PaymentType): TODO: type description here. + payment_type (PaymentType): The model property of type PaymentType. verified (bool): denotes whether a bank account has been verified by providing the amounts of two small deposits made into the account - site_gateway_setting_id (int): TODO: type description here. - gateway_handle (str): TODO: type description here. + site_gateway_setting_id (int): The model property of type int. + gateway_handle (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -293,3 +291,55 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('payment_type'), type_callable=lambda value: PaymentType.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'customer_id={self.customer_id!r}, ' + f'current_vault={self.current_vault!r}, ' + f'vault_token={self.vault_token!r}, ' + f'billing_address={self.billing_address!r}, ' + f'billing_city={self.billing_city!r}, ' + f'billing_state={self.billing_state!r}, ' + f'billing_zip={self.billing_zip!r}, ' + f'billing_country={self.billing_country!r}, ' + f'customer_vault_token={self.customer_vault_token!r}, ' + f'billing_address_2={self.billing_address_2!r}, ' + f'bank_name={self.bank_name!r}, ' + f'masked_bank_routing_number={self.masked_bank_routing_number!r}, ' + f'masked_bank_account_number={self.masked_bank_account_number!r}, ' + f'bank_account_type={self.bank_account_type!r}, ' + f'bank_account_holder_type={self.bank_account_holder_type!r}, ' + f'payment_type={self.payment_type!r}, ' + f'verified={self.verified!r}, ' + f'site_gateway_setting_id={self.site_gateway_setting_id!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'customer_id={self.customer_id!s}, ' + f'current_vault={self.current_vault!s}, ' + f'vault_token={self.vault_token!s}, ' + f'billing_address={self.billing_address!s}, ' + f'billing_city={self.billing_city!s}, ' + f'billing_state={self.billing_state!s}, ' + f'billing_zip={self.billing_zip!s}, ' + f'billing_country={self.billing_country!s}, ' + f'customer_vault_token={self.customer_vault_token!s}, ' + f'billing_address_2={self.billing_address_2!s}, ' + f'bank_name={self.bank_name!s}, ' + f'masked_bank_routing_number={self.masked_bank_routing_number!s}, ' + f'masked_bank_account_number={self.masked_bank_account_number!s}, ' + f'bank_account_type={self.bank_account_type!s}, ' + f'bank_account_holder_type={self.bank_account_holder_type!s}, ' + f'payment_type={self.payment_type!s}, ' + f'verified={self.verified!s}, ' + f'site_gateway_setting_id={self.site_gateway_setting_id!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bank_account_response.py b/advancedbilling/models/bank_account_response.py index 1b60e54c..159eda24 100644 --- a/advancedbilling/models/bank_account_response.py +++ b/advancedbilling/models/bank_account_response.py @@ -13,11 +13,9 @@ class BankAccountResponse(object): """Implementation of the 'Bank Account Response' model. - TODO: type model description here. - Attributes: - payment_profile (BankAccountPaymentProfile): TODO: type description - here. + payment_profile (BankAccountPaymentProfile): The model property of + type BankAccountPaymentProfile. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(payment_profile, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile={self.payment_profile!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile={self.payment_profile!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bank_account_type.py b/advancedbilling/models/bank_account_type.py index 509c4c33..072b69eb 100644 --- a/advancedbilling/models/bank_account_type.py +++ b/advancedbilling/models/bank_account_type.py @@ -15,8 +15,8 @@ class BankAccountType(object): Defaults to checking Attributes: - CHECKING: TODO: type description here. - SAVINGS: TODO: type description here. + CHECKING: The enum member of type str. + SAVINGS: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/bank_account_vault.py b/advancedbilling/models/bank_account_vault.py index bd6c51dc..56f81d75 100644 --- a/advancedbilling/models/bank_account_vault.py +++ b/advancedbilling/models/bank_account_vault.py @@ -16,14 +16,14 @@ class BankAccountVault(object): Use `bogus` for testing. Attributes: - AUTHORIZENET: TODO: type description here. - BLUE_SNAP: TODO: type description here. - BOGUS: TODO: type description here. - FORTE: TODO: type description here. - GOCARDLESS: TODO: type description here. - MAXIO_PAYMENTS: TODO: type description here. - MAXP: TODO: type description here. - STRIPE_CONNECT: TODO: type description here. + AUTHORIZENET: The enum member of type str. + BLUE_SNAP: The enum member of type str. + BOGUS: The enum member of type str. + FORTE: The enum member of type str. + GOCARDLESS: The enum member of type str. + MAXIO_PAYMENTS: The enum member of type str. + MAXP: The enum member of type str. + STRIPE_CONNECT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/bank_account_verification.py b/advancedbilling/models/bank_account_verification.py index 9e004d84..819b471e 100644 --- a/advancedbilling/models/bank_account_verification.py +++ b/advancedbilling/models/bank_account_verification.py @@ -13,11 +13,9 @@ class BankAccountVerification(object): """Implementation of the 'Bank Account Verification' model. - TODO: type model description here. - Attributes: - deposit_1_in_cents (long|int): TODO: type description here. - deposit_2_in_cents (long|int): TODO: type description here. + deposit_1_in_cents (int): The model property of type int. + deposit_2_in_cents (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -78,3 +76,15 @@ def from_dictionary(cls, return cls(deposit_1_in_cents, deposit_2_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'deposit_1_in_cents={self.deposit_1_in_cents!r}, ' + f'deposit_2_in_cents={self.deposit_2_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'deposit_1_in_cents={self.deposit_1_in_cents!s}, ' + f'deposit_2_in_cents={self.deposit_2_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bank_account_verification_request.py b/advancedbilling/models/bank_account_verification_request.py index 41b395a5..f61a6f08 100644 --- a/advancedbilling/models/bank_account_verification_request.py +++ b/advancedbilling/models/bank_account_verification_request.py @@ -13,11 +13,9 @@ class BankAccountVerificationRequest(object): """Implementation of the 'Bank Account Verification Request' model. - TODO: type model description here. - Attributes: - bank_account_verification (BankAccountVerification): TODO: type - description here. + bank_account_verification (BankAccountVerification): The model + property of type BankAccountVerification. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(bank_account_verification, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'bank_account_verification={self.bank_account_verification!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'bank_account_verification={self.bank_account_verification!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/base_refund_error.py b/advancedbilling/models/base_refund_error.py index 93d4ebb7..5c95638c 100644 --- a/advancedbilling/models/base_refund_error.py +++ b/advancedbilling/models/base_refund_error.py @@ -13,10 +13,8 @@ class BaseRefundError(object): """Implementation of the 'Base Refund Error' model. - TODO: type model description here. - Attributes: - base (List[object]): TODO: type description here. + base (List[object]): The model property of type List[object]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(base, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'base={self.base!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'base={self.base!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/base_string_error.py b/advancedbilling/models/base_string_error.py index 3903dbb8..deb99114 100644 --- a/advancedbilling/models/base_string_error.py +++ b/advancedbilling/models/base_string_error.py @@ -16,7 +16,7 @@ class BaseStringError(object): The error is base if it is not directly associated with a single attribute. Attributes: - base (List[str]): TODO: type description here. + base (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +70,13 @@ def from_dictionary(cls, # Return an object of this model return cls(base, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'base={self.base!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'base={self.base!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/basic_date_field.py b/advancedbilling/models/basic_date_field.py index 7189c0d7..728f3217 100644 --- a/advancedbilling/models/basic_date_field.py +++ b/advancedbilling/models/basic_date_field.py @@ -15,8 +15,8 @@ class BasicDateField(object): Allows to filter by `created_at` or `updated_at`. Attributes: - UPDATED_AT: TODO: type description here. - CREATED_AT: TODO: type description here. + UPDATED_AT: The enum member of type str. + CREATED_AT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/batch_job.py b/advancedbilling/models/batch_job.py index adda9a31..82e09dbd 100644 --- a/advancedbilling/models/batch_job.py +++ b/advancedbilling/models/batch_job.py @@ -13,14 +13,12 @@ class BatchJob(object): """Implementation of the 'Batch-Job' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - finished_at (datetime): TODO: type description here. - row_count (int): TODO: type description here. - created_at (datetime): TODO: type description here. - completed (str): TODO: type description here. + id (int): The model property of type int. + finished_at (datetime): The model property of type datetime. + row_count (int): The model property of type int. + created_at (datetime): The model property of type datetime. + completed (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -114,3 +112,21 @@ def from_dictionary(cls, created_at, completed, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'finished_at={self.finished_at!r}, ' + f'row_count={self.row_count!r}, ' + f'created_at={self.created_at!r}, ' + f'completed={self.completed!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'finished_at={self.finished_at!s}, ' + f'row_count={self.row_count!s}, ' + f'created_at={self.created_at!s}, ' + f'completed={self.completed!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/batch_job_response.py b/advancedbilling/models/batch_job_response.py index 18ceb301..5ef9a4c8 100644 --- a/advancedbilling/models/batch_job_response.py +++ b/advancedbilling/models/batch_job_response.py @@ -13,10 +13,8 @@ class BatchJobResponse(object): """Implementation of the 'Batch Job Response' model. - TODO: type model description here. - Attributes: - batchjob (BatchJob): TODO: type description here. + batchjob (BatchJob): The model property of type BatchJob. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(batchjob, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'batchjob={self.batchjob!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'batchjob={self.batchjob!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/billing_manifest.py b/advancedbilling/models/billing_manifest.py index 3097b9c4..5343447f 100644 --- a/advancedbilling/models/billing_manifest.py +++ b/advancedbilling/models/billing_manifest.py @@ -14,18 +14,17 @@ class BillingManifest(object): """Implementation of the 'Billing Manifest' model. - TODO: type model description here. - Attributes: - line_items (List[BillingManifestItem]): TODO: type description here. - total_in_cents (long|int): TODO: type description here. - total_discount_in_cents (long|int): TODO: type description here. - total_tax_in_cents (long|int): TODO: type description here. - subtotal_in_cents (long|int): TODO: type description here. - start_date (datetime): TODO: type description here. - end_date (datetime): TODO: type description here. - period_type (str): TODO: type description here. - existing_balance_in_cents (long|int): TODO: type description here. + line_items (List[BillingManifestItem]): The model property of type + List[BillingManifestItem]. + total_in_cents (int): The model property of type int. + total_discount_in_cents (int): The model property of type int. + total_tax_in_cents (int): The model property of type int. + subtotal_in_cents (int): The model property of type int. + start_date (datetime): The model property of type datetime. + end_date (datetime): The model property of type datetime. + period_type (str): The model property of type str. + existing_balance_in_cents (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -151,3 +150,29 @@ def from_dictionary(cls, period_type, existing_balance_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'line_items={self.line_items!r}, ' + f'total_in_cents={self.total_in_cents!r}, ' + f'total_discount_in_cents={self.total_discount_in_cents!r}, ' + f'total_tax_in_cents={self.total_tax_in_cents!r}, ' + f'subtotal_in_cents={self.subtotal_in_cents!r}, ' + f'start_date={self.start_date!r}, ' + f'end_date={self.end_date!r}, ' + f'period_type={self.period_type!r}, ' + f'existing_balance_in_cents={self.existing_balance_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'line_items={self.line_items!s}, ' + f'total_in_cents={self.total_in_cents!s}, ' + f'total_discount_in_cents={self.total_discount_in_cents!s}, ' + f'total_tax_in_cents={self.total_tax_in_cents!s}, ' + f'subtotal_in_cents={self.subtotal_in_cents!s}, ' + f'start_date={self.start_date!s}, ' + f'end_date={self.end_date!s}, ' + f'period_type={self.period_type!s}, ' + f'existing_balance_in_cents={self.existing_balance_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/billing_manifest_item.py b/advancedbilling/models/billing_manifest_item.py index 254e5e3f..3f6f4cec 100644 --- a/advancedbilling/models/billing_manifest_item.py +++ b/advancedbilling/models/billing_manifest_item.py @@ -13,25 +13,23 @@ class BillingManifestItem(object): """Implementation of the 'Billing Manifest Item' model. - TODO: type model description here. - Attributes: transaction_type (LineItemTransactionType): A handle for the line item transaction type kind (BillingManifestLineItemKind): A handle for the billing manifest line item kind - amount_in_cents (long|int): TODO: type description here. - memo (str): TODO: type description here. - discount_amount_in_cents (long|int): TODO: type description here. - taxable_amount_in_cents (long|int): TODO: type description here. - component_id (int): TODO: type description here. - component_handle (str): TODO: type description here. - component_name (str): TODO: type description here. - product_id (int): TODO: type description here. - product_handle (str): TODO: type description here. - product_name (str): TODO: type description here. - period_range_start (str): TODO: type description here. - period_range_end (str): TODO: type description here. + amount_in_cents (int): The model property of type int. + memo (str): The model property of type str. + discount_amount_in_cents (int): The model property of type int. + taxable_amount_in_cents (int): The model property of type int. + component_id (int): The model property of type int. + component_handle (str): The model property of type str. + component_name (str): The model property of type str. + product_id (int): The model property of type int. + product_handle (str): The model property of type str. + product_name (str): The model property of type str. + period_range_start (str): The model property of type str. + period_range_end (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -176,3 +174,39 @@ def from_dictionary(cls, period_range_start, period_range_end, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'transaction_type={self.transaction_type!r}, ' + f'kind={self.kind!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'memo={self.memo!r}, ' + f'discount_amount_in_cents={self.discount_amount_in_cents!r}, ' + f'taxable_amount_in_cents={self.taxable_amount_in_cents!r}, ' + f'component_id={self.component_id!r}, ' + f'component_handle={self.component_handle!r}, ' + f'component_name={self.component_name!r}, ' + f'product_id={self.product_id!r}, ' + f'product_handle={self.product_handle!r}, ' + f'product_name={self.product_name!r}, ' + f'period_range_start={self.period_range_start!r}, ' + f'period_range_end={self.period_range_end!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'transaction_type={self.transaction_type!s}, ' + f'kind={self.kind!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'memo={self.memo!s}, ' + f'discount_amount_in_cents={self.discount_amount_in_cents!s}, ' + f'taxable_amount_in_cents={self.taxable_amount_in_cents!s}, ' + f'component_id={self.component_id!s}, ' + f'component_handle={self.component_handle!s}, ' + f'component_name={self.component_name!s}, ' + f'product_id={self.product_id!s}, ' + f'product_handle={self.product_handle!s}, ' + f'product_name={self.product_name!s}, ' + f'period_range_start={self.period_range_start!s}, ' + f'period_range_end={self.period_range_end!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/billing_manifest_line_item_kind.py b/advancedbilling/models/billing_manifest_line_item_kind.py index 5d086a28..8d15c48d 100644 --- a/advancedbilling/models/billing_manifest_line_item_kind.py +++ b/advancedbilling/models/billing_manifest_line_item_kind.py @@ -15,12 +15,12 @@ class BillingManifestLineItemKind(object): A handle for the billing manifest line item kind Attributes: - BASELINE: TODO: type description here. - INITIAL: TODO: type description here. - TRIAL: TODO: type description here. - COUPON: TODO: type description here. - COMPONENT: TODO: type description here. - TAX: TODO: type description here. + BASELINE: The enum member of type str. + INITIAL: The enum member of type str. + TRIAL: The enum member of type str. + COUPON: The enum member of type str. + COMPONENT: The enum member of type str. + TAX: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/billing_schedule.py b/advancedbilling/models/billing_schedule.py index 991db937..ce142d8f 100644 --- a/advancedbilling/models/billing_schedule.py +++ b/advancedbilling/models/billing_schedule.py @@ -100,3 +100,13 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'initial_billing_at={self.initial_billing_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'initial_billing_at={self.initial_billing_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/breakouts.py b/advancedbilling/models/breakouts.py index 276aeea5..084134f8 100644 --- a/advancedbilling/models/breakouts.py +++ b/advancedbilling/models/breakouts.py @@ -13,13 +13,11 @@ class Breakouts(object): """Implementation of the 'Breakouts' model. - TODO: type model description here. - Attributes: - plan_amount_in_cents (long|int): TODO: type description here. - plan_amount_formatted (str): TODO: type description here. - usage_amount_in_cents (long|int): TODO: type description here. - usage_amount_formatted (str): TODO: type description here. + plan_amount_in_cents (int): The model property of type int. + plan_amount_formatted (str): The model property of type str. + usage_amount_in_cents (int): The model property of type int. + usage_amount_formatted (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -94,3 +92,19 @@ def from_dictionary(cls, usage_amount_in_cents, usage_amount_formatted, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'plan_amount_in_cents={self.plan_amount_in_cents!r}, ' + f'plan_amount_formatted={self.plan_amount_formatted!r}, ' + f'usage_amount_in_cents={self.usage_amount_in_cents!r}, ' + f'usage_amount_formatted={self.usage_amount_formatted!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'plan_amount_in_cents={self.plan_amount_in_cents!s}, ' + f'plan_amount_formatted={self.plan_amount_formatted!s}, ' + f'usage_amount_in_cents={self.usage_amount_in_cents!s}, ' + f'usage_amount_formatted={self.usage_amount_formatted!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bulk_components_price_point_assignment.py b/advancedbilling/models/bulk_components_price_point_assignment.py index 740e4c2e..e34aa26c 100644 --- a/advancedbilling/models/bulk_components_price_point_assignment.py +++ b/advancedbilling/models/bulk_components_price_point_assignment.py @@ -14,11 +14,9 @@ class BulkComponentsPricePointAssignment(object): """Implementation of the 'Bulk Components Price Point Assignment' model. - TODO: type model description here. - Attributes: - components (List[ComponentPricePointAssignment]): TODO: type - description here. + components (List[ComponentPricePointAssignment]): The model property + of type List[ComponentPricePointAssignment]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -76,3 +74,13 @@ def from_dictionary(cls, # Return an object of this model return cls(components, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'components={self.components!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'components={self.components!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bulk_create_product_price_points_request.py b/advancedbilling/models/bulk_create_product_price_points_request.py index 9454581c..b47f3bfd 100644 --- a/advancedbilling/models/bulk_create_product_price_points_request.py +++ b/advancedbilling/models/bulk_create_product_price_points_request.py @@ -13,11 +13,9 @@ class BulkCreateProductPricePointsRequest(object): """Implementation of the 'Bulk Create Product Price Points Request' model. - TODO: type model description here. - Attributes: - price_points (List[CreateProductPricePoint]): TODO: type description - here. + price_points (List[CreateProductPricePoint]): The model property of + type List[CreateProductPricePoint]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -68,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(price_points, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bulk_create_product_price_points_response.py b/advancedbilling/models/bulk_create_product_price_points_response.py index e717a700..e5fe6021 100644 --- a/advancedbilling/models/bulk_create_product_price_points_response.py +++ b/advancedbilling/models/bulk_create_product_price_points_response.py @@ -14,10 +14,9 @@ class BulkCreateProductPricePointsResponse(object): """Implementation of the 'Bulk Create Product Price Points Response' model. - TODO: type model description here. - Attributes: - price_points (List[ProductPricePoint]): TODO: type description here. + price_points (List[ProductPricePoint]): The model property of type + List[ProductPricePoint]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -75,3 +74,13 @@ def from_dictionary(cls, # Return an object of this model return cls(price_points, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bulk_create_segments.py b/advancedbilling/models/bulk_create_segments.py index 0328a383..8972dd5d 100644 --- a/advancedbilling/models/bulk_create_segments.py +++ b/advancedbilling/models/bulk_create_segments.py @@ -14,10 +14,9 @@ class BulkCreateSegments(object): """Implementation of the 'Bulk Create Segments' model. - TODO: type model description here. - Attributes: - segments (List[CreateSegment]): TODO: type description here. + segments (List[CreateSegment]): The model property of type + List[CreateSegment]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -75,3 +74,13 @@ def from_dictionary(cls, # Return an object of this model return cls(segments, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'segments={self.segments!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'segments={self.segments!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bulk_update_segments.py b/advancedbilling/models/bulk_update_segments.py index 9ea36748..427103a0 100644 --- a/advancedbilling/models/bulk_update_segments.py +++ b/advancedbilling/models/bulk_update_segments.py @@ -14,10 +14,9 @@ class BulkUpdateSegments(object): """Implementation of the 'Bulk Update Segments' model. - TODO: type model description here. - Attributes: - segments (List[BulkUpdateSegmentsItem]): TODO: type description here. + segments (List[BulkUpdateSegmentsItem]): The model property of type + List[BulkUpdateSegmentsItem]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -75,3 +74,13 @@ def from_dictionary(cls, # Return an object of this model return cls(segments, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'segments={self.segments!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'segments={self.segments!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/bulk_update_segments_item.py b/advancedbilling/models/bulk_update_segments_item.py index 858f4e27..0f1210b2 100644 --- a/advancedbilling/models/bulk_update_segments_item.py +++ b/advancedbilling/models/bulk_update_segments_item.py @@ -13,15 +13,14 @@ class BulkUpdateSegmentsItem(object): """Implementation of the 'Bulk Update Segments Item' model. - TODO: type model description here. - Attributes: id (int): The ID of the segment you want to update. pricing_scheme (PricingScheme): The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.h tml) for an overview of pricing schemes. - prices (List[CreateOrUpdateSegmentPrice]): TODO: type description here. + prices (List[CreateOrUpdateSegmentPrice]): The model property of type + List[CreateOrUpdateSegmentPrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -82,3 +81,17 @@ def from_dictionary(cls, pricing_scheme, prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/calendar_billing.py b/advancedbilling/models/calendar_billing.py index f304a983..dfbfb6f1 100644 --- a/advancedbilling/models/calendar_billing.py +++ b/advancedbilling/models/calendar_billing.py @@ -18,8 +18,8 @@ class CalendarBilling(object): Attributes: snap_day (int | str | None): A day of month that subscription will be processed on. Can be 1 up to 28 or 'end'. - calendar_billing_first_charge (FirstChargeType): TODO: type - description here. + calendar_billing_first_charge (FirstChargeType): The model property of + type FirstChargeType. additional_properties (Dict[str, object]): The additional properties for the model. @@ -103,3 +103,15 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'snap_day={self.snap_day!r}, ' + f'calendar_billing_first_charge={self.calendar_billing_first_charge!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'snap_day={self.snap_day!s}, ' + f'calendar_billing_first_charge={self.calendar_billing_first_charge!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/cancel_grouped_subscriptions_request.py b/advancedbilling/models/cancel_grouped_subscriptions_request.py index 189c2ac0..c76a2280 100644 --- a/advancedbilling/models/cancel_grouped_subscriptions_request.py +++ b/advancedbilling/models/cancel_grouped_subscriptions_request.py @@ -13,10 +13,8 @@ class CancelGroupedSubscriptionsRequest(object): """Implementation of the 'Cancel Grouped Subscriptions Request' model. - TODO: type model description here. - Attributes: - charge_unbilled_usage (bool): TODO: type description here. + charge_unbilled_usage (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(charge_unbilled_usage, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'charge_unbilled_usage={self.charge_unbilled_usage!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'charge_unbilled_usage={self.charge_unbilled_usage!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/cancellation_method.py b/advancedbilling/models/cancellation_method.py index 835a6587..3013c9d3 100644 --- a/advancedbilling/models/cancellation_method.py +++ b/advancedbilling/models/cancellation_method.py @@ -16,12 +16,12 @@ class CancellationMethod(object): canceled. It is nil if the subscription's state is not canceled. Attributes: - MERCHANT_UI: TODO: type description here. - MERCHANT_API: TODO: type description here. - DUNNING: TODO: type description here. - BILLING_PORTAL: TODO: type description here. - UNKNOWN: TODO: type description here. - IMPORTED: TODO: type description here. + MERCHANT_UI: The enum member of type str. + MERCHANT_API: The enum member of type str. + DUNNING: The enum member of type str. + BILLING_PORTAL: The enum member of type str. + UNKNOWN: The enum member of type str. + IMPORTED: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/cancellation_options.py b/advancedbilling/models/cancellation_options.py index ff76d665..d25ac02b 100644 --- a/advancedbilling/models/cancellation_options.py +++ b/advancedbilling/models/cancellation_options.py @@ -13,8 +13,6 @@ class CancellationOptions(object): """Implementation of the 'Cancellation Options' model. - TODO: type model description here. - Attributes: cancellation_message (str): For your internal use. An indication as to why the subscription is being canceled. @@ -80,3 +78,15 @@ def from_dictionary(cls, return cls(cancellation_message, reason_code, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'cancellation_message={self.cancellation_message!r}, ' + f'reason_code={self.reason_code!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'cancellation_message={self.cancellation_message!s}, ' + f'reason_code={self.reason_code!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/cancellation_request.py b/advancedbilling/models/cancellation_request.py index cca0bc8f..15c21897 100644 --- a/advancedbilling/models/cancellation_request.py +++ b/advancedbilling/models/cancellation_request.py @@ -13,10 +13,9 @@ class CancellationRequest(object): """Implementation of the 'Cancellation Request' model. - TODO: type model description here. - Attributes: - subscription (CancellationOptions): TODO: type description here. + subscription (CancellationOptions): The model property of type + CancellationOptions. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/card_type.py b/advancedbilling/models/card_type.py index fa2318a5..33932ec0 100644 --- a/advancedbilling/models/card_type.py +++ b/advancedbilling/models/card_type.py @@ -15,42 +15,42 @@ class CardType(object): The type of card used. Attributes: - VISA: TODO: type description here. - MASTER: TODO: type description here. - ELO: TODO: type description here. - CABAL: TODO: type description here. - ALELO: TODO: type description here. - DISCOVER: TODO: type description here. - AMERICAN_EXPRESS: TODO: type description here. - NARANJA: TODO: type description here. - DINERS_CLUB: TODO: type description here. - JCB: TODO: type description here. - DANKORT: TODO: type description here. - MAESTRO: TODO: type description here. - MAESTRO_NO_LUHN: TODO: type description here. - FORBRUGSFORENINGEN: TODO: type description here. - SODEXO: TODO: type description here. - ALIA: TODO: type description here. - VR: TODO: type description here. - UNIONPAY: TODO: type description here. - CARNET: TODO: type description here. - CARTES_BANCAIRES: TODO: type description here. - OLIMPICA: TODO: type description here. - CREDITEL: TODO: type description here. - CONFIABLE: TODO: type description here. - SYNCHRONY: TODO: type description here. - ROUTEX: TODO: type description here. - MADA: TODO: type description here. - BP_PLUS: TODO: type description here. - PASSCARD: TODO: type description here. - EDENRED: TODO: type description here. - ANDA: TODO: type description here. - TARJETAD: TODO: type description here. - HIPERCARD: TODO: type description here. - BOGUS: TODO: type description here. - SWITCH: TODO: type description here. - SOLO: TODO: type description here. - LASER: TODO: type description here. + VISA: The enum member of type str. + MASTER: The enum member of type str. + ELO: The enum member of type str. + CABAL: The enum member of type str. + ALELO: The enum member of type str. + DISCOVER: The enum member of type str. + AMERICAN_EXPRESS: The enum member of type str. + NARANJA: The enum member of type str. + DINERS_CLUB: The enum member of type str. + JCB: The enum member of type str. + DANKORT: The enum member of type str. + MAESTRO: The enum member of type str. + MAESTRO_NO_LUHN: The enum member of type str. + FORBRUGSFORENINGEN: The enum member of type str. + SODEXO: The enum member of type str. + ALIA: The enum member of type str. + VR: The enum member of type str. + UNIONPAY: The enum member of type str. + CARNET: The enum member of type str. + CARTES_BANCAIRES: The enum member of type str. + OLIMPICA: The enum member of type str. + CREDITEL: The enum member of type str. + CONFIABLE: The enum member of type str. + SYNCHRONY: The enum member of type str. + ROUTEX: The enum member of type str. + MADA: The enum member of type str. + BP_PLUS: The enum member of type str. + PASSCARD: The enum member of type str. + EDENRED: The enum member of type str. + ANDA: The enum member of type str. + TARJETAD: The enum member of type str. + HIPERCARD: The enum member of type str. + BOGUS: The enum member of type str. + SWITCH: The enum member of type str. + SOLO: The enum member of type str. + LASER: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/change_chargeback_status_event.py b/advancedbilling/models/change_chargeback_status_event.py index 7c1e5473..b46a63b9 100644 --- a/advancedbilling/models/change_chargeback_status_event.py +++ b/advancedbilling/models/change_chargeback_status_event.py @@ -16,13 +16,12 @@ class ChangeChargebackStatusEvent(object): """Implementation of the 'Change Chargeback Status Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (ChangeChargebackStatusEventData): Example schema for an `change_chargeback_status` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: ChangeChargebackStatusEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/change_chargeback_status_event_data.py b/advancedbilling/models/change_chargeback_status_event_data.py index 9984584f..53ff99ac 100644 --- a/advancedbilling/models/change_chargeback_status_event_data.py +++ b/advancedbilling/models/change_chargeback_status_event_data.py @@ -17,7 +17,8 @@ class ChangeChargebackStatusEventData(object): Example schema for an `change_chargeback_status` event Attributes: - chargeback_status (ChargebackStatus): TODO: type description here. + chargeback_status (ChargebackStatus): The model property of type + ChargebackStatus. additional_properties (Dict[str, object]): The additional properties for the model. @@ -90,3 +91,13 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('chargeback_status'), type_callable=lambda value: ChargebackStatus.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'chargeback_status={self.chargeback_status!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'chargeback_status={self.chargeback_status!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/change_invoice_collection_method_event.py b/advancedbilling/models/change_invoice_collection_method_event.py index d391a7a0..6bc4c6ae 100644 --- a/advancedbilling/models/change_invoice_collection_method_event.py +++ b/advancedbilling/models/change_invoice_collection_method_event.py @@ -16,13 +16,12 @@ class ChangeInvoiceCollectionMethodEvent(object): """Implementation of the 'Change Invoice Collection Method Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (ChangeInvoiceCollectionMethodEventData): Example schema for an `change_invoice_collection_method` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: ChangeInvoiceCollectionMethodEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/change_invoice_collection_method_event_data.py b/advancedbilling/models/change_invoice_collection_method_event_data.py index b62ff796..fcf90f68 100644 --- a/advancedbilling/models/change_invoice_collection_method_event_data.py +++ b/advancedbilling/models/change_invoice_collection_method_event_data.py @@ -100,3 +100,15 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('to_collection_method'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'from_collection_method={self.from_collection_method!r}, ' + f'to_collection_method={self.to_collection_method!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'from_collection_method={self.from_collection_method!s}, ' + f'to_collection_method={self.to_collection_method!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/change_invoice_status_event.py b/advancedbilling/models/change_invoice_status_event.py index 8cd65a00..ea4d22a7 100644 --- a/advancedbilling/models/change_invoice_status_event.py +++ b/advancedbilling/models/change_invoice_status_event.py @@ -16,13 +16,12 @@ class ChangeInvoiceStatusEvent(object): """Implementation of the 'Change Invoice Status Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (ChangeInvoiceStatusEventData): Example schema for an `change_invoice_status` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: ChangeInvoiceStatusEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/change_invoice_status_event_data.py b/advancedbilling/models/change_invoice_status_event_data.py index 9c0f2b15..9b84ba51 100644 --- a/advancedbilling/models/change_invoice_status_event_data.py +++ b/advancedbilling/models/change_invoice_status_event_data.py @@ -29,8 +29,8 @@ class ChangeInvoiceStatusEventData(object): changes have been made. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/2425228782964 5-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. - consolidation_level (InvoiceConsolidationLevel): TODO: type - description here. + consolidation_level (InvoiceConsolidationLevel): The model property of + type InvoiceConsolidationLevel. additional_properties (Dict[str, object]): The additional properties for the model. @@ -136,3 +136,21 @@ def validate(cls, dictionary): type_callable=lambda value: InvoiceStatus.validate(value)) \ and APIHelper.is_valid_type(value=dictionary.get('to_status'), type_callable=lambda value: InvoiceStatus.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'gateway_trans_id={self.gateway_trans_id!r}, ' + f'amount={self.amount!r}, ' + f'from_status={self.from_status!r}, ' + f'to_status={self.to_status!r}, ' + f'consolidation_level={self.consolidation_level!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'gateway_trans_id={self.gateway_trans_id!s}, ' + f'amount={self.amount!s}, ' + f'from_status={self.from_status!s}, ' + f'to_status={self.to_status!s}, ' + f'consolidation_level={self.consolidation_level!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/chargeback_status.py b/advancedbilling/models/chargeback_status.py index 98dfe9b4..73032e8e 100644 --- a/advancedbilling/models/chargeback_status.py +++ b/advancedbilling/models/chargeback_status.py @@ -15,10 +15,10 @@ class ChargebackStatus(object): The current chargeback status. Attributes: - OPEN: TODO: type description here. - LOST: TODO: type description here. - WON: TODO: type description here. - CLOSED: TODO: type description here. + OPEN: The enum member of type str. + LOST: The enum member of type str. + WON: The enum member of type str. + CLOSED: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/chargify_ebb.py b/advancedbilling/models/chargify_ebb.py index fcc9d8b4..965693b5 100644 --- a/advancedbilling/models/chargify_ebb.py +++ b/advancedbilling/models/chargify_ebb.py @@ -13,8 +13,6 @@ class ChargifyEBB(object): """Implementation of the 'Chargify EBB' model. - TODO: type model description here. - Attributes: timestamp (datetime): This timestamp determines what billing period the event will be billed in. If your request payload does not @@ -127,3 +125,23 @@ def from_dictionary(cls, subscription_id, subscription_reference, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'timestamp={self.timestamp!r}, ' + f'id={self.id!r}, ' + f'created_at={self.created_at!r}, ' + f'uniqueness_token={self.uniqueness_token!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'subscription_reference={self.subscription_reference!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'timestamp={self.timestamp!s}, ' + f'id={self.id!s}, ' + f'created_at={self.created_at!s}, ' + f'uniqueness_token={self.uniqueness_token!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'subscription_reference={self.subscription_reference!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/cleanup_scope.py b/advancedbilling/models/cleanup_scope.py index 65bdc2ad..8e70408a 100644 --- a/advancedbilling/models/cleanup_scope.py +++ b/advancedbilling/models/cleanup_scope.py @@ -18,8 +18,8 @@ class CleanupScope(object): to 0. Attributes: - ALL: TODO: type description here. - CUSTOMERS: TODO: type description here. + ALL: The enum member of type str. + CUSTOMERS: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/collection_method.py b/advancedbilling/models/collection_method.py index 1378c2ef..7e164644 100644 --- a/advancedbilling/models/collection_method.py +++ b/advancedbilling/models/collection_method.py @@ -18,10 +18,10 @@ class CollectionMethod(object): `remittance`, `automatic`, `prepaid`. Attributes: - AUTOMATIC: TODO: type description here. - REMITTANCE: TODO: type description here. - PREPAID: TODO: type description here. - INVOICE: TODO: type description here. + AUTOMATIC: The enum member of type str. + REMITTANCE: The enum member of type str. + PREPAID: The enum member of type str. + INVOICE: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/component.py b/advancedbilling/models/component.py index e61ca58b..31bfa700 100644 --- a/advancedbilling/models/component.py +++ b/advancedbilling/models/component.py @@ -14,15 +14,14 @@ class Component(object): """Implementation of the 'Component' model. - TODO: type model description here. - Attributes: id (int): The unique ID assigned to the component by Chargify. This ID can be used to fetch the component from the API. name (str): The name of the Component, suitable for display on statements. i.e. Text Messages. handle (str): The component API handle - pricing_scheme (PricingScheme): TODO: type description here. + pricing_scheme (PricingScheme): The model property of type + PricingScheme. unit_name (str): The name of the unit that the component’s usage is measured in. i.e. message unit_price (str): The amount the customer will be charged per unit. @@ -32,14 +31,14 @@ class Component(object): Component belongs product_family_name (str): The name of the Product Family to which the Component belongs - price_per_unit_in_cents (long|int): deprecated - use unit_price instead + price_per_unit_in_cents (int): deprecated - use unit_price instead kind (ComponentKind): A handle for the component type archived (bool): Boolean flag describing whether a component is archived or not. taxable (bool): Boolean flag describing whether a component is taxable or not. description (str): The description of the component. - default_price_point_id (int): TODO: type description here. + default_price_point_id (int): The model property of type int. overage_prices (List[ComponentPrice]): Applicable only to prepaid usage components. An array of overage price brackets. prices (List[ComponentPrice]): An array of price brackets. If the @@ -49,12 +48,12 @@ class Component(object): associated with the component price_points_url (str): URL that points to the location to read the existing price points via GET request - default_price_point_name (str): TODO: type description here. + default_price_point_name (str): The model property of type str. tax_code (str): A string representing the tax code related to the component type. This is especially important when using the Avalara service to tax based on locale. This attribute has a max length of 10 characters. - recurring (bool): TODO: type description here. + recurring (bool): The model property of type bool. upgrade_charge (CreditType): The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, @@ -72,10 +71,10 @@ class Component(object): hide_date_range_on_invoice (bool): (Only available on Relationship Invoicing sites) Boolean flag describing if the service date range should show for the component on generated invoices. - allow_fractional_quantities (bool): TODO: type description here. + allow_fractional_quantities (bool): The model property of type bool. item_category (ItemCategory): One of the following: Business Software, Consumer Software, Digital Services, Physical Goods, Other - use_site_exchange_rate (bool): TODO: type description here. + use_site_exchange_rate (bool): The model property of type bool. accounting_code (str): E.g. Internal ID or SKU Number event_based_billing_metric_id (int): (Only for Event Based Components) This is an ID of a metric attached to the component. This metric @@ -401,3 +400,79 @@ def from_dictionary(cls, interval, interval_unit, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'unit_name={self.unit_name!r}, ' + f'unit_price={self.unit_price!r}, ' + f'product_family_id={self.product_family_id!r}, ' + f'product_family_name={self.product_family_name!r}, ' + f'price_per_unit_in_cents={self.price_per_unit_in_cents!r}, ' + f'kind={self.kind!r}, ' + f'archived={self.archived!r}, ' + f'taxable={self.taxable!r}, ' + f'description={self.description!r}, ' + f'default_price_point_id={self.default_price_point_id!r}, ' + f'overage_prices={self.overage_prices!r}, ' + f'prices={self.prices!r}, ' + f'price_point_count={self.price_point_count!r}, ' + f'price_points_url={self.price_points_url!r}, ' + f'default_price_point_name={self.default_price_point_name!r}, ' + f'tax_code={self.tax_code!r}, ' + f'recurring={self.recurring!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'archived_at={self.archived_at!r}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!r}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!r}, ' + f'item_category={self.item_category!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'accounting_code={self.accounting_code!r}, ' + f'event_based_billing_metric_id={self.event_based_billing_metric_id!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'unit_name={self.unit_name!s}, ' + f'unit_price={self.unit_price!s}, ' + f'product_family_id={self.product_family_id!s}, ' + f'product_family_name={self.product_family_name!s}, ' + f'price_per_unit_in_cents={self.price_per_unit_in_cents!s}, ' + f'kind={self.kind!s}, ' + f'archived={self.archived!s}, ' + f'taxable={self.taxable!s}, ' + f'description={self.description!s}, ' + f'default_price_point_id={self.default_price_point_id!s}, ' + f'overage_prices={self.overage_prices!s}, ' + f'prices={self.prices!s}, ' + f'price_point_count={self.price_point_count!s}, ' + f'price_points_url={self.price_points_url!s}, ' + f'default_price_point_name={self.default_price_point_name!s}, ' + f'tax_code={self.tax_code!s}, ' + f'recurring={self.recurring!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'archived_at={self.archived_at!s}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!s}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!s}, ' + f'item_category={self.item_category!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'accounting_code={self.accounting_code!s}, ' + f'event_based_billing_metric_id={self.event_based_billing_metric_id!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_allocation_change.py b/advancedbilling/models/component_allocation_change.py index 4e60bd34..a5618540 100644 --- a/advancedbilling/models/component_allocation_change.py +++ b/advancedbilling/models/component_allocation_change.py @@ -13,16 +13,15 @@ class ComponentAllocationChange(object): """Implementation of the 'Component Allocation Change' model. - TODO: type model description here. - Attributes: - previous_allocation (int): TODO: type description here. - new_allocation (int): TODO: type description here. - component_id (int): TODO: type description here. - component_handle (str): TODO: type description here. - memo (str): TODO: type description here. - allocation_id (int): TODO: type description here. - allocated_quantity (int | str | None): TODO: type description here. + previous_allocation (int): The model property of type int. + new_allocation (int): The model property of type int. + component_id (int): The model property of type int. + component_handle (str): The model property of type str. + memo (str): The model property of type str. + allocation_id (int): The model property of type int. + allocated_quantity (int | str | None): The model property of type int + | str | None. additional_properties (Dict[str, object]): The additional properties for the model. @@ -151,3 +150,25 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('allocation_id'), type_callable=lambda value: isinstance(value, int)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'previous_allocation={self.previous_allocation!r}, ' + f'new_allocation={self.new_allocation!r}, ' + f'component_id={self.component_id!r}, ' + f'component_handle={self.component_handle!r}, ' + f'memo={self.memo!r}, ' + f'allocation_id={self.allocation_id!r}, ' + f'allocated_quantity={self.allocated_quantity!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'previous_allocation={self.previous_allocation!s}, ' + f'new_allocation={self.new_allocation!s}, ' + f'component_id={self.component_id!s}, ' + f'component_handle={self.component_handle!s}, ' + f'memo={self.memo!s}, ' + f'allocation_id={self.allocation_id!s}, ' + f'allocated_quantity={self.allocated_quantity!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_allocation_error_item.py b/advancedbilling/models/component_allocation_error_item.py index fc2bb6dd..85d86053 100644 --- a/advancedbilling/models/component_allocation_error_item.py +++ b/advancedbilling/models/component_allocation_error_item.py @@ -13,13 +13,11 @@ class ComponentAllocationErrorItem(object): """Implementation of the 'Component Allocation Error Item' model. - TODO: type model description here. - Attributes: - component_id (int): TODO: type description here. - message (str): TODO: type description here. - kind (str): TODO: type description here. - on (str): TODO: type description here. + component_id (int): The model property of type int. + message (str): The model property of type str. + kind (str): The model property of type str. + on (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -94,3 +92,19 @@ def from_dictionary(cls, kind, on, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!r}, ' + f'message={self.message!r}, ' + f'kind={self.kind!r}, ' + f'on={self.on!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!s}, ' + f'message={self.message!s}, ' + f'kind={self.kind!s}, ' + f'on={self.on!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_cost_data.py b/advancedbilling/models/component_cost_data.py index 95383147..a7943104 100644 --- a/advancedbilling/models/component_cost_data.py +++ b/advancedbilling/models/component_cost_data.py @@ -14,19 +14,18 @@ class ComponentCostData(object): """Implementation of the 'Component Cost Data' model. - TODO: type model description here. - Attributes: - component_code_id (int): TODO: type description here. - price_point_id (int): TODO: type description here. - product_id (int): TODO: type description here. - quantity (str): TODO: type description here. - amount (str): TODO: type description here. + component_code_id (int): The model property of type int. + price_point_id (int): The model property of type int. + product_id (int): The model property of type int. + quantity (str): The model property of type str. + amount (str): The model property of type str. pricing_scheme (PricingScheme): The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.h tml) for an overview of pricing schemes. - tiers (List[ComponentCostDataRateTier]): TODO: type description here. + tiers (List[ComponentCostDataRateTier]): The model property of type + List[ComponentCostDataRateTier]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -152,3 +151,25 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_code_id={self.component_code_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'product_id={self.product_id!r}, ' + f'quantity={self.quantity!r}, ' + f'amount={self.amount!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'tiers={self.tiers!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_code_id={self.component_code_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'product_id={self.product_id!s}, ' + f'quantity={self.quantity!s}, ' + f'amount={self.amount!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'tiers={self.tiers!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_cost_data_rate_tier.py b/advancedbilling/models/component_cost_data_rate_tier.py index edda0fd8..5fa0518d 100644 --- a/advancedbilling/models/component_cost_data_rate_tier.py +++ b/advancedbilling/models/component_cost_data_rate_tier.py @@ -13,14 +13,12 @@ class ComponentCostDataRateTier(object): """Implementation of the 'Component Cost Data Rate Tier' model. - TODO: type model description here. - Attributes: - starting_quantity (int): TODO: type description here. - ending_quantity (int): TODO: type description here. - quantity (str): TODO: type description here. - unit_price (str): TODO: type description here. - amount (str): TODO: type description here. + starting_quantity (int): The model property of type int. + ending_quantity (int): The model property of type int. + quantity (str): The model property of type str. + unit_price (str): The model property of type str. + amount (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -128,3 +126,21 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'starting_quantity={self.starting_quantity!r}, ' + f'ending_quantity={self.ending_quantity!r}, ' + f'quantity={self.quantity!r}, ' + f'unit_price={self.unit_price!r}, ' + f'amount={self.amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'starting_quantity={self.starting_quantity!s}, ' + f'ending_quantity={self.ending_quantity!s}, ' + f'quantity={self.quantity!s}, ' + f'unit_price={self.unit_price!s}, ' + f'amount={self.amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_currency_price.py b/advancedbilling/models/component_currency_price.py index d3536723..33cb658b 100644 --- a/advancedbilling/models/component_currency_price.py +++ b/advancedbilling/models/component_currency_price.py @@ -13,15 +13,13 @@ class ComponentCurrencyPrice(object): """Implementation of the 'Component Currency Price' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - currency (str): TODO: type description here. - price (str): TODO: type description here. - formatted_price (str): TODO: type description here. - price_id (int): TODO: type description here. - price_point_id (int): TODO: type description here. + id (int): The model property of type int. + currency (str): The model property of type str. + price (str): The model property of type str. + formatted_price (str): The model property of type str. + price_id (int): The model property of type int. + price_point_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -110,3 +108,23 @@ def from_dictionary(cls, price_id, price_point_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'currency={self.currency!r}, ' + f'price={self.price!r}, ' + f'formatted_price={self.formatted_price!r}, ' + f'price_id={self.price_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'currency={self.currency!s}, ' + f'price={self.price!s}, ' + f'formatted_price={self.formatted_price!s}, ' + f'price_id={self.price_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_currency_prices_response.py b/advancedbilling/models/component_currency_prices_response.py index a3ab46bf..a3e2076b 100644 --- a/advancedbilling/models/component_currency_prices_response.py +++ b/advancedbilling/models/component_currency_prices_response.py @@ -13,11 +13,9 @@ class ComponentCurrencyPricesResponse(object): """Implementation of the 'Component Currency Prices Response' model. - TODO: type model description here. - Attributes: - currency_prices (List[ComponentCurrencyPrice]): TODO: type description - here. + currency_prices (List[ComponentCurrencyPrice]): The model property of + type List[ComponentCurrencyPrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -68,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(currency_prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_custom_price.py b/advancedbilling/models/component_custom_price.py index deefe27f..d7225b61 100644 --- a/advancedbilling/models/component_custom_price.py +++ b/advancedbilling/models/component_custom_price.py @@ -142,3 +142,21 @@ def validate(cls, dictionary): type_callable=lambda value: Price.validate(value), is_model_dict=True, is_inner_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'tax_included={self.tax_included!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'prices={self.prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'tax_included={self.tax_included!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'prices={self.prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_kind.py b/advancedbilling/models/component_kind.py index 2658b8c6..7ed9569d 100644 --- a/advancedbilling/models/component_kind.py +++ b/advancedbilling/models/component_kind.py @@ -15,11 +15,11 @@ class ComponentKind(object): A handle for the component type Attributes: - METERED_COMPONENT: TODO: type description here. - QUANTITY_BASED_COMPONENT: TODO: type description here. - ON_OFF_COMPONENT: TODO: type description here. - PREPAID_USAGE_COMPONENT: TODO: type description here. - EVENT_BASED_COMPONENT: TODO: type description here. + METERED_COMPONENT: The enum member of type str. + QUANTITY_BASED_COMPONENT: The enum member of type str. + ON_OFF_COMPONENT: The enum member of type str. + PREPAID_USAGE_COMPONENT: The enum member of type str. + EVENT_BASED_COMPONENT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/component_price.py b/advancedbilling/models/component_price.py index 3837214f..05af58de 100644 --- a/advancedbilling/models/component_price.py +++ b/advancedbilling/models/component_price.py @@ -13,17 +13,15 @@ class ComponentPrice(object): """Implementation of the 'Component Price' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - component_id (int): TODO: type description here. - starting_quantity (int): TODO: type description here. - ending_quantity (int): TODO: type description here. - unit_price (str): TODO: type description here. - price_point_id (int): TODO: type description here. - formatted_unit_price (str): TODO: type description here. - segment_id (int): TODO: type description here. + id (int): The model property of type int. + component_id (int): The model property of type int. + starting_quantity (int): The model property of type int. + ending_quantity (int): The model property of type int. + unit_price (str): The model property of type str. + price_point_id (int): The model property of type int. + formatted_unit_price (str): The model property of type str. + segment_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -131,3 +129,27 @@ def from_dictionary(cls, formatted_unit_price, segment_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'component_id={self.component_id!r}, ' + f'starting_quantity={self.starting_quantity!r}, ' + f'ending_quantity={self.ending_quantity!r}, ' + f'unit_price={self.unit_price!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'formatted_unit_price={self.formatted_unit_price!r}, ' + f'segment_id={self.segment_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'component_id={self.component_id!s}, ' + f'starting_quantity={self.starting_quantity!s}, ' + f'ending_quantity={self.ending_quantity!s}, ' + f'unit_price={self.unit_price!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'formatted_unit_price={self.formatted_unit_price!s}, ' + f'segment_id={self.segment_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_price_point.py b/advancedbilling/models/component_price_point.py index d12387a3..5ca4f7f8 100644 --- a/advancedbilling/models/component_price_point.py +++ b/advancedbilling/models/component_price_point.py @@ -15,27 +15,26 @@ class ComponentPricePoint(object): """Implementation of the 'Component Price Point' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. + id (int): The model property of type int. mtype (PricePointType): Price point type. We expose the following types: 1. **default**: a price point that is marked as a default price for a certain product. 2. **custom**: a custom price point. 3. **catalog**: a price point that is **not** marked as a default price for a certain product and is **not** a custom one. default (bool): Note: Refer to type attribute instead - name (str): TODO: type description here. + name (str): The model property of type str. pricing_scheme (PricingScheme): The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.h tml) for an overview of pricing schemes. - component_id (int): TODO: type description here. - handle (str): TODO: type description here. - archived_at (datetime): TODO: type description here. - created_at (datetime): TODO: type description here. - updated_at (datetime): TODO: type description here. - prices (List[ComponentPrice]): TODO: type description here. + component_id (int): The model property of type int. + handle (str): The model property of type str. + archived_at (datetime): The model property of type datetime. + created_at (datetime): The model property of type datetime. + updated_at (datetime): The model property of type datetime. + prices (List[ComponentPrice]): The model property of type + List[ComponentPrice]. use_site_exchange_rate (bool): Whether to use the site level exchange rate or define your own prices for each currency if you have multiple currencies defined on the site. Defaults to true during @@ -43,7 +42,7 @@ class ComponentPricePoint(object): subscription_id (int): (only used for Custom Pricing - ie. when the price point's type is `custom`) The id of the subscription that the custom price point is for. - tax_included (bool): TODO: type description here. + tax_included (bool): The model property of type bool. interval (int): The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only @@ -306,3 +305,57 @@ def from_dictionary(cls, expiration_interval, expiration_interval_unit, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'mtype={self.mtype!r}, ' + f'default={self.default!r}, ' + f'name={self.name!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'component_id={self.component_id!r}, ' + f'handle={self.handle!r}, ' + f'archived_at={self.archived_at!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'prices={self.prices!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'tax_included={self.tax_included!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'currency_prices={self.currency_prices!r}, ' + f'overage_prices={self.overage_prices!r}, ' + f'overage_pricing_scheme={self.overage_pricing_scheme!r}, ' + f'renew_prepaid_allocation={self.renew_prepaid_allocation!r}, ' + f'rollover_prepaid_remainder={self.rollover_prepaid_remainder!r}, ' + f'expiration_interval={self.expiration_interval!r}, ' + f'expiration_interval_unit={self.expiration_interval_unit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'mtype={self.mtype!s}, ' + f'default={self.default!s}, ' + f'name={self.name!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'component_id={self.component_id!s}, ' + f'handle={self.handle!s}, ' + f'archived_at={self.archived_at!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'prices={self.prices!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'tax_included={self.tax_included!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'currency_prices={self.currency_prices!s}, ' + f'overage_prices={self.overage_prices!s}, ' + f'overage_pricing_scheme={self.overage_pricing_scheme!s}, ' + f'renew_prepaid_allocation={self.renew_prepaid_allocation!s}, ' + f'rollover_prepaid_remainder={self.rollover_prepaid_remainder!s}, ' + f'expiration_interval={self.expiration_interval!s}, ' + f'expiration_interval_unit={self.expiration_interval_unit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_price_point_assignment.py b/advancedbilling/models/component_price_point_assignment.py index ff7690b5..239bfdfb 100644 --- a/advancedbilling/models/component_price_point_assignment.py +++ b/advancedbilling/models/component_price_point_assignment.py @@ -13,11 +13,10 @@ class ComponentPricePointAssignment(object): """Implementation of the 'Component Price Point Assignment' model. - TODO: type model description here. - Attributes: - component_id (int): TODO: type description here. - price_point (str | int | None): TODO: type description here. + component_id (int): The model property of type int. + price_point (str | int | None): The model property of type str | int | + None. additional_properties (Dict[str, object]): The additional properties for the model. @@ -79,3 +78,15 @@ def from_dictionary(cls, return cls(component_id, price_point, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!r}, ' + f'price_point={self.price_point!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!s}, ' + f'price_point={self.price_point!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_price_point_error_item.py b/advancedbilling/models/component_price_point_error_item.py index f7c7946d..38256f2e 100644 --- a/advancedbilling/models/component_price_point_error_item.py +++ b/advancedbilling/models/component_price_point_error_item.py @@ -13,12 +13,10 @@ class ComponentPricePointErrorItem(object): """Implementation of the 'Component PricePoint Error Item' model. - TODO: type model description here. - Attributes: - component_id (int): TODO: type description here. - message (str): TODO: type description here. - price_point (int): TODO: type description here. + component_id (int): The model property of type int. + message (str): The model property of type str. + price_point (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -86,3 +84,17 @@ def from_dictionary(cls, message, price_point, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!r}, ' + f'message={self.message!r}, ' + f'price_point={self.price_point!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!s}, ' + f'message={self.message!s}, ' + f'price_point={self.price_point!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_price_point_item.py b/advancedbilling/models/component_price_point_item.py index 82d067bd..c3b54a34 100644 --- a/advancedbilling/models/component_price_point_item.py +++ b/advancedbilling/models/component_price_point_item.py @@ -14,11 +14,9 @@ class ComponentPricePointItem(object): """Implementation of the 'Component Price Point Item' model. - TODO: type model description here. - Attributes: - name (str): TODO: type description here. - handle (str): TODO: type description here. + name (str): The model property of type str. + handle (str): The model property of type str. pricing_scheme (PricingScheme): The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.h @@ -30,7 +28,7 @@ class ComponentPricePointItem(object): interval_unit (IntervalUnit): A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. - prices (List[Price]): TODO: type description here. + prices (List[Price]): The model property of type List[Price]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -149,3 +147,23 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'prices={self.prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'prices={self.prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_price_point_response.py b/advancedbilling/models/component_price_point_response.py index 3e107729..a2360da1 100644 --- a/advancedbilling/models/component_price_point_response.py +++ b/advancedbilling/models/component_price_point_response.py @@ -13,10 +13,9 @@ class ComponentPricePointResponse(object): """Implementation of the 'Component Price Point Response' model. - TODO: type model description here. - Attributes: - price_point (ComponentPricePoint): TODO: type description here. + price_point (ComponentPricePoint): The model property of type + ComponentPricePoint. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(price_point, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_price_points_response.py b/advancedbilling/models/component_price_points_response.py index 57ec015e..b0f4a68b 100644 --- a/advancedbilling/models/component_price_points_response.py +++ b/advancedbilling/models/component_price_points_response.py @@ -15,11 +15,11 @@ class ComponentPricePointsResponse(object): """Implementation of the 'Component Price Points response' model. - TODO: type model description here. - Attributes: - price_points (List[ComponentPricePoint]): TODO: type description here. - meta (ListPublicKeysMeta): TODO: type description here. + price_points (List[ComponentPricePoint]): The model property of type + List[ComponentPricePoint]. + meta (ListPublicKeysMeta): The model property of type + ListPublicKeysMeta. additional_properties (Dict[str, object]): The additional properties for the model. @@ -84,3 +84,15 @@ def from_dictionary(cls, return cls(price_points, meta, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!r}, ' + f'meta={self.meta!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!s}, ' + f'meta={self.meta!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/component_response.py b/advancedbilling/models/component_response.py index b096da4c..64f093fe 100644 --- a/advancedbilling/models/component_response.py +++ b/advancedbilling/models/component_response.py @@ -13,10 +13,8 @@ class ComponentResponse(object): """Implementation of the 'Component Response' model. - TODO: type model description here. - Attributes: - component (Component): TODO: type description here. + component (Component): The model property of type Component. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(component, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component={self.component!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component={self.component!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/compounding_strategy.py b/advancedbilling/models/compounding_strategy.py index fa3b6a7d..c1cf6c8b 100644 --- a/advancedbilling/models/compounding_strategy.py +++ b/advancedbilling/models/compounding_strategy.py @@ -19,8 +19,8 @@ class CompoundingStrategy(object): before other discounts are applied. Attributes: - COMPOUND: TODO: type description here. - FULLPRICE: TODO: type description here. + COMPOUND: The enum member of type str. + FULLPRICE: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/consolidated_invoice.py b/advancedbilling/models/consolidated_invoice.py index 7d5335fc..6160bae4 100644 --- a/advancedbilling/models/consolidated_invoice.py +++ b/advancedbilling/models/consolidated_invoice.py @@ -14,10 +14,8 @@ class ConsolidatedInvoice(object): """Implementation of the 'Consolidated Invoice' model. - TODO: type model description here. - Attributes: - invoices (List[Invoice]): TODO: type description here. + invoices (List[Invoice]): The model property of type List[Invoice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -75,3 +73,13 @@ def from_dictionary(cls, # Return an object of this model return cls(invoices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'invoices={self.invoices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'invoices={self.invoices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/count_response.py b/advancedbilling/models/count_response.py index 4720bbb1..425b5fed 100644 --- a/advancedbilling/models/count_response.py +++ b/advancedbilling/models/count_response.py @@ -13,10 +13,8 @@ class CountResponse(object): """Implementation of the 'Count Response' model. - TODO: type model description here. - Attributes: - count (int): TODO: type description here. + count (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(count, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'count={self.count!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'count={self.count!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon.py b/advancedbilling/models/coupon.py index 98264d94..1ae67ad3 100644 --- a/advancedbilling/models/coupon.py +++ b/advancedbilling/models/coupon.py @@ -15,32 +15,31 @@ class Coupon(object): """Implementation of the 'Coupon' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - name (str): TODO: type description here. - code (str): TODO: type description here. - description (str): TODO: type description here. - amount (float): TODO: type description here. - amount_in_cents (long|int): TODO: type description here. - product_family_id (int): TODO: type description here. - product_family_name (str): TODO: type description here. - start_date (datetime): TODO: type description here. + id (int): The model property of type int. + name (str): The model property of type str. + code (str): The model property of type str. + description (str): The model property of type str. + amount (float): The model property of type float. + amount_in_cents (int): The model property of type int. + product_family_id (int): The model property of type int. + product_family_name (str): The model property of type str. + start_date (datetime): The model property of type datetime. end_date (datetime): After the given time, this coupon code will be invalid for new signups. Recurring discounts started before this date will continue to recur even after this date. - percentage (str): TODO: type description here. - recurring (bool): TODO: type description here. - recurring_scheme (RecurringScheme): TODO: type description here. - duration_period_count (int): TODO: type description here. - duration_interval (int): TODO: type description here. - duration_interval_unit (str): TODO: type description here. - duration_interval_span (str): TODO: type description here. + percentage (str): The model property of type str. + recurring (bool): The model property of type bool. + recurring_scheme (RecurringScheme): The model property of type + RecurringScheme. + duration_period_count (int): The model property of type int. + duration_interval (int): The model property of type int. + duration_interval_unit (str): The model property of type str. + duration_interval_span (str): The model property of type str. allow_negative_balance (bool): If set to true, discount is not limited (credits will carry forward to next billing). - archived_at (datetime): TODO: type description here. - conversion_limit (str): TODO: type description here. + archived_at (datetime): The model property of type datetime. + conversion_limit (str): The model property of type str. stackable (bool): A stackable coupon can be combined with other coupons on a Subscription. compounding_strategy (CompoundingStrategy): Applicable only to @@ -49,15 +48,17 @@ class Coupon(object): have been calculated. For `full-price`, Percentage-based discounts will always be calculated against the original item price, before other discounts are applied. - use_site_exchange_rate (bool): TODO: type description here. - created_at (datetime): TODO: type description here. - updated_at (datetime): TODO: type description here. - discount_type (DiscountType): TODO: type description here. - exclude_mid_period_allocations (bool): TODO: type description here. - apply_on_cancel_at_end_of_period (bool): TODO: type description here. - apply_on_subscription_expiration (bool): TODO: type description here. - coupon_restrictions (List[CouponRestriction]): TODO: type description - here. + use_site_exchange_rate (bool): The model property of type bool. + created_at (datetime): The model property of type datetime. + updated_at (datetime): The model property of type datetime. + discount_type (DiscountType): The model property of type DiscountType. + exclude_mid_period_allocations (bool): The model property of type bool. + apply_on_cancel_at_end_of_period (bool): The model property of type + bool. + apply_on_subscription_expiration (bool): The model property of type + bool. + coupon_restrictions (List[CouponRestriction]): The model property of + type List[CouponRestriction]. currency_prices (List[CouponCurrency]): Returned in read, find, and list endpoints if the query parameter is provided. additional_properties (Dict[str, object]): The additional properties @@ -352,3 +353,73 @@ def from_dictionary(cls, coupon_restrictions, currency_prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'name={self.name!r}, ' + f'code={self.code!r}, ' + f'description={self.description!r}, ' + f'amount={self.amount!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'product_family_id={self.product_family_id!r}, ' + f'product_family_name={self.product_family_name!r}, ' + f'start_date={self.start_date!r}, ' + f'end_date={self.end_date!r}, ' + f'percentage={self.percentage!r}, ' + f'recurring={self.recurring!r}, ' + f'recurring_scheme={self.recurring_scheme!r}, ' + f'duration_period_count={self.duration_period_count!r}, ' + f'duration_interval={self.duration_interval!r}, ' + f'duration_interval_unit={self.duration_interval_unit!r}, ' + f'duration_interval_span={self.duration_interval_span!r}, ' + f'allow_negative_balance={self.allow_negative_balance!r}, ' + f'archived_at={self.archived_at!r}, ' + f'conversion_limit={self.conversion_limit!r}, ' + f'stackable={self.stackable!r}, ' + f'compounding_strategy={self.compounding_strategy!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'discount_type={self.discount_type!r}, ' + f'exclude_mid_period_allocations={self.exclude_mid_period_allocations!r}, ' + f'apply_on_cancel_at_end_of_period={self.apply_on_cancel_at_end_of_period!r}, ' + f'apply_on_subscription_expiration={self.apply_on_subscription_expiration!r}, ' + f'coupon_restrictions={self.coupon_restrictions!r}, ' + f'currency_prices={self.currency_prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'name={self.name!s}, ' + f'code={self.code!s}, ' + f'description={self.description!s}, ' + f'amount={self.amount!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'product_family_id={self.product_family_id!s}, ' + f'product_family_name={self.product_family_name!s}, ' + f'start_date={self.start_date!s}, ' + f'end_date={self.end_date!s}, ' + f'percentage={self.percentage!s}, ' + f'recurring={self.recurring!s}, ' + f'recurring_scheme={self.recurring_scheme!s}, ' + f'duration_period_count={self.duration_period_count!s}, ' + f'duration_interval={self.duration_interval!s}, ' + f'duration_interval_unit={self.duration_interval_unit!s}, ' + f'duration_interval_span={self.duration_interval_span!s}, ' + f'allow_negative_balance={self.allow_negative_balance!s}, ' + f'archived_at={self.archived_at!s}, ' + f'conversion_limit={self.conversion_limit!s}, ' + f'stackable={self.stackable!s}, ' + f'compounding_strategy={self.compounding_strategy!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'discount_type={self.discount_type!s}, ' + f'exclude_mid_period_allocations={self.exclude_mid_period_allocations!s}, ' + f'apply_on_cancel_at_end_of_period={self.apply_on_cancel_at_end_of_period!s}, ' + f'apply_on_subscription_expiration={self.apply_on_subscription_expiration!s}, ' + f'coupon_restrictions={self.coupon_restrictions!s}, ' + f'currency_prices={self.currency_prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon_currency.py b/advancedbilling/models/coupon_currency.py index e1d9c50b..d29e59d2 100644 --- a/advancedbilling/models/coupon_currency.py +++ b/advancedbilling/models/coupon_currency.py @@ -13,13 +13,11 @@ class CouponCurrency(object): """Implementation of the 'Coupon Currency' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - currency (str): TODO: type description here. - price (float): TODO: type description here. - coupon_id (int): TODO: type description here. + id (int): The model property of type int. + currency (str): The model property of type str. + price (float): The model property of type float. + coupon_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -99,3 +97,19 @@ def from_dictionary(cls, price, coupon_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'currency={self.currency!r}, ' + f'price={self.price!r}, ' + f'coupon_id={self.coupon_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'currency={self.currency!s}, ' + f'price={self.price!s}, ' + f'coupon_id={self.coupon_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon_currency_request.py b/advancedbilling/models/coupon_currency_request.py index 8165e11e..4c98aeb9 100644 --- a/advancedbilling/models/coupon_currency_request.py +++ b/advancedbilling/models/coupon_currency_request.py @@ -13,11 +13,9 @@ class CouponCurrencyRequest(object): """Implementation of the 'Coupon Currency Request' model. - TODO: type model description here. - Attributes: - currency_prices (List[UpdateCouponCurrency]): TODO: type description - here. + currency_prices (List[UpdateCouponCurrency]): The model property of + type List[UpdateCouponCurrency]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -68,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(currency_prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon_currency_response.py b/advancedbilling/models/coupon_currency_response.py index fb645964..50e5b2af 100644 --- a/advancedbilling/models/coupon_currency_response.py +++ b/advancedbilling/models/coupon_currency_response.py @@ -14,10 +14,9 @@ class CouponCurrencyResponse(object): """Implementation of the 'Coupon Currency Response' model. - TODO: type model description here. - Attributes: - currency_prices (List[CouponCurrency]): TODO: type description here. + currency_prices (List[CouponCurrency]): The model property of type + List[CouponCurrency]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -75,3 +74,13 @@ def from_dictionary(cls, # Return an object of this model return cls(currency_prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon_payload.py b/advancedbilling/models/coupon_payload.py index c817d51b..0c9a9ca5 100644 --- a/advancedbilling/models/coupon_payload.py +++ b/advancedbilling/models/coupon_payload.py @@ -15,8 +15,6 @@ class CouponPayload(object): """Implementation of the 'Coupon Payload' model. - TODO: type model description here. - Attributes: name (str): Required when creating a new coupon. This name is not displayed to customers and is limited to 255 characters. @@ -30,16 +28,16 @@ class CouponPayload(object): percentage (str | float | None): Required when creating a new percentage coupon. Can't be used together with amount_in_cents. Percentage discount - amount_in_cents (long|int): Required when creating a new flat amount + amount_in_cents (int): Required when creating a new flat amount coupon. Can't be used together with percentage. Flat USD discount allow_negative_balance (bool): If set to true, discount is not limited (credits will carry forward to next billing). Can't be used together with restrictions. - recurring (bool): TODO: type description here. + recurring (bool): The model property of type bool. end_date (date): After the end of the given day, this coupon code will be invalid for new signups. Recurring discounts started before this date will continue to recur even after this date. - product_family_id (str): TODO: type description here. + product_family_id (str): The model property of type str. stackable (bool): A stackable coupon can be combined with other coupons on a Subscription. compounding_strategy (CompoundingStrategy): Applicable only to @@ -48,9 +46,11 @@ class CouponPayload(object): have been calculated. For `full-price`, Percentage-based discounts will always be calculated against the original item price, before other discounts are applied. - exclude_mid_period_allocations (bool): TODO: type description here. - apply_on_cancel_at_end_of_period (bool): TODO: type description here. - apply_on_subscription_expiration (bool): TODO: type description here. + exclude_mid_period_allocations (bool): The model property of type bool. + apply_on_cancel_at_end_of_period (bool): The model property of type + bool. + apply_on_subscription_expiration (bool): The model property of type + bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -196,3 +196,39 @@ def from_dictionary(cls, apply_on_cancel_at_end_of_period, apply_on_subscription_expiration, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'code={self.code!r}, ' + f'description={self.description!r}, ' + f'percentage={self.percentage!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'allow_negative_balance={self.allow_negative_balance!r}, ' + f'recurring={self.recurring!r}, ' + f'end_date={self.end_date!r}, ' + f'product_family_id={self.product_family_id!r}, ' + f'stackable={self.stackable!r}, ' + f'compounding_strategy={self.compounding_strategy!r}, ' + f'exclude_mid_period_allocations={self.exclude_mid_period_allocations!r}, ' + f'apply_on_cancel_at_end_of_period={self.apply_on_cancel_at_end_of_period!r}, ' + f'apply_on_subscription_expiration={self.apply_on_subscription_expiration!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'code={self.code!s}, ' + f'description={self.description!s}, ' + f'percentage={self.percentage!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'allow_negative_balance={self.allow_negative_balance!s}, ' + f'recurring={self.recurring!s}, ' + f'end_date={self.end_date!s}, ' + f'product_family_id={self.product_family_id!s}, ' + f'stackable={self.stackable!s}, ' + f'compounding_strategy={self.compounding_strategy!s}, ' + f'exclude_mid_period_allocations={self.exclude_mid_period_allocations!s}, ' + f'apply_on_cancel_at_end_of_period={self.apply_on_cancel_at_end_of_period!s}, ' + f'apply_on_subscription_expiration={self.apply_on_subscription_expiration!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon_request.py b/advancedbilling/models/coupon_request.py index ce4b3fc4..bf514d10 100644 --- a/advancedbilling/models/coupon_request.py +++ b/advancedbilling/models/coupon_request.py @@ -14,10 +14,8 @@ class CouponRequest(object): """Implementation of the 'Coupon Request' model. - TODO: type model description here. - Attributes: - coupon (CouponPayload): TODO: type description here. + coupon (CouponPayload): The model property of type CouponPayload. restricted_products (Dict[str, bool]): An object where the keys are product_ids and the values are booleans indicating if the coupon should be applicable to the product @@ -91,3 +89,17 @@ def from_dictionary(cls, restricted_products, restricted_components, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'coupon={self.coupon!r}, ' + f'restricted_products={self.restricted_products!r}, ' + f'restricted_components={self.restricted_components!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'coupon={self.coupon!s}, ' + f'restricted_products={self.restricted_products!s}, ' + f'restricted_components={self.restricted_components!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon_response.py b/advancedbilling/models/coupon_response.py index f5fea960..8800796b 100644 --- a/advancedbilling/models/coupon_response.py +++ b/advancedbilling/models/coupon_response.py @@ -14,10 +14,8 @@ class CouponResponse(object): """Implementation of the 'Coupon Response' model. - TODO: type model description here. - Attributes: - coupon (Coupon): TODO: type description here. + coupon (Coupon): The model property of type Coupon. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(coupon, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'coupon={self.coupon!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'coupon={self.coupon!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon_restriction.py b/advancedbilling/models/coupon_restriction.py index 7b23f7d6..3975c155 100644 --- a/advancedbilling/models/coupon_restriction.py +++ b/advancedbilling/models/coupon_restriction.py @@ -13,14 +13,13 @@ class CouponRestriction(object): """Implementation of the 'Coupon Restriction' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - item_type (RestrictionType): TODO: type description here. - item_id (int): TODO: type description here. - name (str): TODO: type description here. - handle (str): TODO: type description here. + id (int): The model property of type int. + item_type (RestrictionType): The model property of type + RestrictionType. + item_id (int): The model property of type int. + name (str): The model property of type str. + handle (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -106,3 +105,21 @@ def from_dictionary(cls, name, handle, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'item_type={self.item_type!r}, ' + f'item_id={self.item_id!r}, ' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'item_type={self.item_type!s}, ' + f'item_id={self.item_id!s}, ' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon_subcodes.py b/advancedbilling/models/coupon_subcodes.py index 34680081..ac572530 100644 --- a/advancedbilling/models/coupon_subcodes.py +++ b/advancedbilling/models/coupon_subcodes.py @@ -13,10 +13,8 @@ class CouponSubcodes(object): """Implementation of the 'Coupon Subcodes' model. - TODO: type model description here. - Attributes: - codes (List[str]): TODO: type description here. + codes (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(codes, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'codes={self.codes!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'codes={self.codes!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon_subcodes_response.py b/advancedbilling/models/coupon_subcodes_response.py index 7455b3ed..9eea8817 100644 --- a/advancedbilling/models/coupon_subcodes_response.py +++ b/advancedbilling/models/coupon_subcodes_response.py @@ -13,12 +13,10 @@ class CouponSubcodesResponse(object): """Implementation of the 'Coupon Subcodes Response' model. - TODO: type model description here. - Attributes: - created_codes (List[str]): TODO: type description here. - duplicate_codes (List[str]): TODO: type description here. - invalid_codes (List[str]): TODO: type description here. + created_codes (List[str]): The model property of type List[str]. + duplicate_codes (List[str]): The model property of type List[str]. + invalid_codes (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -86,3 +84,17 @@ def from_dictionary(cls, duplicate_codes, invalid_codes, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'created_codes={self.created_codes!r}, ' + f'duplicate_codes={self.duplicate_codes!r}, ' + f'invalid_codes={self.invalid_codes!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'created_codes={self.created_codes!s}, ' + f'duplicate_codes={self.duplicate_codes!s}, ' + f'invalid_codes={self.invalid_codes!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/coupon_usage.py b/advancedbilling/models/coupon_usage.py index 71c15dc2..5dfdb9b0 100644 --- a/advancedbilling/models/coupon_usage.py +++ b/advancedbilling/models/coupon_usage.py @@ -13,20 +13,18 @@ class CouponUsage(object): """Implementation of the 'Coupon Usage' model. - TODO: type model description here. - Attributes: id (int): The Chargify id of the product name (str): Name of the product signups (int): Number of times the coupon has been applied savings (int): Dollar amount of customer savings as a result of the coupon. - savings_in_cents (long|int): Dollar amount of customer savings as a - result of the coupon. + savings_in_cents (int): Dollar amount of customer savings as a result + of the coupon. revenue (int): Total revenue of the all subscriptions that have received a discount from this coupon. - revenue_in_cents (long|int): Total revenue of the all subscriptions - that have received a discount from this coupon. + revenue_in_cents (int): Total revenue of the all subscriptions that + have received a discount from this coupon. additional_properties (Dict[str, object]): The additional properties for the model. @@ -128,3 +126,25 @@ def from_dictionary(cls, revenue, revenue_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'name={self.name!r}, ' + f'signups={self.signups!r}, ' + f'savings={self.savings!r}, ' + f'savings_in_cents={self.savings_in_cents!r}, ' + f'revenue={self.revenue!r}, ' + f'revenue_in_cents={self.revenue_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'name={self.name!s}, ' + f'signups={self.signups!s}, ' + f'savings={self.savings!s}, ' + f'savings_in_cents={self.savings_in_cents!s}, ' + f'revenue={self.revenue!s}, ' + f'revenue_in_cents={self.revenue_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_allocation.py b/advancedbilling/models/create_allocation.py index 7343e745..d1c52a0b 100644 --- a/advancedbilling/models/create_allocation.py +++ b/advancedbilling/models/create_allocation.py @@ -14,8 +14,6 @@ class CreateAllocation(object): """Implementation of the 'Create Allocation' model. - TODO: type model description here. - Attributes: quantity (float): The allocated quantity to which to set the line-items allocated quantity. By default, this is an integer. If @@ -184,3 +182,33 @@ def from_dictionary(cls, price_point_id, billing_schedule, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'quantity={self.quantity!r}, ' + f'component_id={self.component_id!r}, ' + f'memo={self.memo!r}, ' + f'proration_downgrade_scheme={self.proration_downgrade_scheme!r}, ' + f'proration_upgrade_scheme={self.proration_upgrade_scheme!r}, ' + f'accrue_charge={self.accrue_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'initiate_dunning={self.initiate_dunning!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'billing_schedule={self.billing_schedule!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'quantity={self.quantity!s}, ' + f'component_id={self.component_id!s}, ' + f'memo={self.memo!s}, ' + f'proration_downgrade_scheme={self.proration_downgrade_scheme!s}, ' + f'proration_upgrade_scheme={self.proration_upgrade_scheme!s}, ' + f'accrue_charge={self.accrue_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'initiate_dunning={self.initiate_dunning!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'billing_schedule={self.billing_schedule!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_allocation_request.py b/advancedbilling/models/create_allocation_request.py index eea50d1a..64cadef4 100644 --- a/advancedbilling/models/create_allocation_request.py +++ b/advancedbilling/models/create_allocation_request.py @@ -13,10 +13,9 @@ class CreateAllocationRequest(object): """Implementation of the 'Create Allocation Request' model. - TODO: type model description here. - Attributes: - allocation (CreateAllocation): TODO: type description here. + allocation (CreateAllocation): The model property of type + CreateAllocation. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(allocation, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'allocation={self.allocation!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'allocation={self.allocation!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_component_price_point.py b/advancedbilling/models/create_component_price_point.py index 2f078fb8..234cbca5 100644 --- a/advancedbilling/models/create_component_price_point.py +++ b/advancedbilling/models/create_component_price_point.py @@ -15,16 +15,14 @@ class CreateComponentPricePoint(object): """Implementation of the 'Create Component Price Point' model. - TODO: type model description here. - Attributes: - name (str): TODO: type description here. - handle (str): TODO: type description here. + name (str): The model property of type str. + handle (str): The model property of type str. pricing_scheme (PricingScheme): The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.h tml) for an overview of pricing schemes. - prices (List[Price]): TODO: type description here. + prices (List[Price]): The model property of type List[Price]. use_site_exchange_rate (bool): Whether to use the site level exchange rate or define your own prices for each currency if you have multiple currencies defined on the site. Setting not supported @@ -175,3 +173,27 @@ def validate(cls, dictionary): type_callable=lambda value: Price.validate(value), is_model_dict=True, is_inner_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'tax_included={self.tax_included!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'tax_included={self.tax_included!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_component_price_point_request.py b/advancedbilling/models/create_component_price_point_request.py index 216e256c..700f3b65 100644 --- a/advancedbilling/models/create_component_price_point_request.py +++ b/advancedbilling/models/create_component_price_point_request.py @@ -13,12 +13,10 @@ class CreateComponentPricePointRequest(object): """Implementation of the 'Create Component Price Point Request' model. - TODO: type model description here. - Attributes: price_point (CreateComponentPricePoint | - CreatePrepaidUsageComponentPricePoint): TODO: type description - here. + CreatePrepaidUsageComponentPricePoint): The model property of type + CreateComponentPricePoint | CreatePrepaidUsageComponentPricePoint. additional_properties (Dict[str, object]): The additional properties for the model. @@ -91,3 +89,13 @@ def validate(cls, dictionary): return False return UnionTypeLookUp.get('CreateComponentPricePointRequestPricePoint').validate(dictionary.get('price_point')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_component_price_points_request.py b/advancedbilling/models/create_component_price_points_request.py index 61636cfe..fb10a69d 100644 --- a/advancedbilling/models/create_component_price_points_request.py +++ b/advancedbilling/models/create_component_price_points_request.py @@ -13,12 +13,11 @@ class CreateComponentPricePointsRequest(object): """Implementation of the 'Create Component Price Points Request' model. - TODO: type model description here. - Attributes: price_points (List[CreateComponentPricePoint | - CreatePrepaidUsageComponentPricePoint]): TODO: type description - here. + CreatePrepaidUsageComponentPricePoint]): The model property of + type List[CreateComponentPricePoint | + CreatePrepaidUsageComponentPricePoint]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -91,3 +90,13 @@ def validate(cls, dictionary): return False return UnionTypeLookUp.get('CreateComponentPricePointsRequestPricePoints').validate(dictionary.get('price_points')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_credit_note_event.py b/advancedbilling/models/create_credit_note_event.py index 28d372f1..679f2dfc 100644 --- a/advancedbilling/models/create_credit_note_event.py +++ b/advancedbilling/models/create_credit_note_event.py @@ -16,13 +16,12 @@ class CreateCreditNoteEvent(object): """Implementation of the 'Create Credit Note Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (CreditNote): Example schema for an `create_credit_note` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: CreditNote.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_currency_price.py b/advancedbilling/models/create_currency_price.py index 5233dc80..caf761ce 100644 --- a/advancedbilling/models/create_currency_price.py +++ b/advancedbilling/models/create_currency_price.py @@ -13,8 +13,6 @@ class CreateCurrencyPrice(object): """Implementation of the 'Create Currency Price' model. - TODO: type model description here. - Attributes: currency (str): ISO code for a currency defined on the site level price (float): Price for the price level in this currency @@ -86,3 +84,17 @@ def from_dictionary(cls, price, price_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currency={self.currency!r}, ' + f'price={self.price!r}, ' + f'price_id={self.price_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currency={self.currency!s}, ' + f'price={self.price!s}, ' + f'price_id={self.price_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_currency_prices_request.py b/advancedbilling/models/create_currency_prices_request.py index 499d4933..3c07d450 100644 --- a/advancedbilling/models/create_currency_prices_request.py +++ b/advancedbilling/models/create_currency_prices_request.py @@ -13,11 +13,9 @@ class CreateCurrencyPricesRequest(object): """Implementation of the 'Create Currency Prices Request' model. - TODO: type model description here. - Attributes: - currency_prices (List[CreateCurrencyPrice]): TODO: type description - here. + currency_prices (List[CreateCurrencyPrice]): The model property of + type List[CreateCurrencyPrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -68,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(currency_prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_customer.py b/advancedbilling/models/create_customer.py index b0314689..35097402 100644 --- a/advancedbilling/models/create_customer.py +++ b/advancedbilling/models/create_customer.py @@ -13,26 +13,24 @@ class CreateCustomer(object): """Implementation of the 'Create Customer' model. - TODO: type model description here. - Attributes: - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - email (str): TODO: type description here. - cc_emails (str): TODO: type description here. - organization (str): TODO: type description here. - reference (str): TODO: type description here. - address (str): TODO: type description here. - address_2 (str): TODO: type description here. - city (str): TODO: type description here. - state (str): TODO: type description here. - zip (str): TODO: type description here. - country (str): TODO: type description here. - phone (str): TODO: type description here. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + email (str): The model property of type str. + cc_emails (str): The model property of type str. + organization (str): The model property of type str. + reference (str): The model property of type str. + address (str): The model property of type str. + address_2 (str): The model property of type str. + city (str): The model property of type str. + state (str): The model property of type str. + zip (str): The model property of type str. + country (str): The model property of type str. + phone (str): The model property of type str. locale (str): Set a specific language on a customer record. - vat_number (str): TODO: type description here. - tax_exempt (bool): TODO: type description here. - tax_exempt_reason (str): TODO: type description here. + vat_number (str): The model property of type str. + tax_exempt (bool): The model property of type bool. + tax_exempt_reason (str): The model property of type str. parent_id (int): The parent ID in Chargify if applicable. Parent is another Customer object. salesforce_id (str): The Salesforce ID of the customer @@ -214,3 +212,49 @@ def from_dictionary(cls, parent_id, salesforce_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'email={self.email!r}, ' + f'cc_emails={self.cc_emails!r}, ' + f'organization={self.organization!r}, ' + f'reference={self.reference!r}, ' + f'address={self.address!r}, ' + f'address_2={self.address_2!r}, ' + f'city={self.city!r}, ' + f'state={self.state!r}, ' + f'zip={self.zip!r}, ' + f'country={self.country!r}, ' + f'phone={self.phone!r}, ' + f'locale={self.locale!r}, ' + f'vat_number={self.vat_number!r}, ' + f'tax_exempt={self.tax_exempt!r}, ' + f'tax_exempt_reason={self.tax_exempt_reason!r}, ' + f'parent_id={self.parent_id!r}, ' + f'salesforce_id={self.salesforce_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'email={self.email!s}, ' + f'cc_emails={self.cc_emails!s}, ' + f'organization={self.organization!s}, ' + f'reference={self.reference!s}, ' + f'address={self.address!s}, ' + f'address_2={self.address_2!s}, ' + f'city={self.city!s}, ' + f'state={self.state!s}, ' + f'zip={self.zip!s}, ' + f'country={self.country!s}, ' + f'phone={self.phone!s}, ' + f'locale={self.locale!s}, ' + f'vat_number={self.vat_number!s}, ' + f'tax_exempt={self.tax_exempt!s}, ' + f'tax_exempt_reason={self.tax_exempt_reason!s}, ' + f'parent_id={self.parent_id!s}, ' + f'salesforce_id={self.salesforce_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_customer_request.py b/advancedbilling/models/create_customer_request.py index 05e89158..4fa8d5c4 100644 --- a/advancedbilling/models/create_customer_request.py +++ b/advancedbilling/models/create_customer_request.py @@ -13,10 +13,8 @@ class CreateCustomerRequest(object): """Implementation of the 'Create Customer Request' model. - TODO: type model description here. - Attributes: - customer (CreateCustomer): TODO: type description here. + customer (CreateCustomer): The model property of type CreateCustomer. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(customer, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'customer={self.customer!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'customer={self.customer!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_debit_note_event.py b/advancedbilling/models/create_debit_note_event.py index a9991c63..4272c551 100644 --- a/advancedbilling/models/create_debit_note_event.py +++ b/advancedbilling/models/create_debit_note_event.py @@ -16,13 +16,12 @@ class CreateDebitNoteEvent(object): """Implementation of the 'Create Debit Note Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (DebitNote): Example schema for an `create_debit_note` event additional_properties (Dict[str, object]): The additional properties for the model. @@ -136,3 +135,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: DebitNote.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_ebb_component.py b/advancedbilling/models/create_ebb_component.py index ebeb3d54..a5a73b01 100644 --- a/advancedbilling/models/create_ebb_component.py +++ b/advancedbilling/models/create_ebb_component.py @@ -13,10 +13,9 @@ class CreateEBBComponent(object): """Implementation of the 'Create EBB Component' model. - TODO: type model description here. - Attributes: - event_based_component (EBBComponent): TODO: type description here. + event_based_component (EBBComponent): The model property of type + EBBComponent. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(event_based_component, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'event_based_component={self.event_based_component!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'event_based_component={self.event_based_component!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_invoice.py b/advancedbilling/models/create_invoice.py index 7deb59c9..db96ecc6 100644 --- a/advancedbilling/models/create_invoice.py +++ b/advancedbilling/models/create_invoice.py @@ -18,16 +18,15 @@ class CreateInvoice(object): """Implementation of the 'Create Invoice' model. - TODO: type model description here. - Attributes: - line_items (List[CreateInvoiceItem]): TODO: type description here. - issue_date (date): TODO: type description here. + line_items (List[CreateInvoiceItem]): The model property of type + List[CreateInvoiceItem]. + issue_date (date): The model property of type date. net_terms (int): By default, invoices will be created with a due date matching the date of invoice creation. If a different due date is desired, the net_terms parameter can be sent indicating the number of days in advance the due date should be. - payment_instructions (str): TODO: type description here. + payment_instructions (str): The model property of type str. memo (str): A custom memo can be sent to override the site's default. seller_address (CreateInvoiceAddress): Overrides the defaults for the site @@ -35,8 +34,10 @@ class CreateInvoice(object): customer shipping_address (CreateInvoiceAddress): Overrides the default for the customer - coupons (List[CreateInvoiceCoupon]): TODO: type description here. - status (CreateInvoiceStatus): TODO: type description here. + coupons (List[CreateInvoiceCoupon]): The model property of type + List[CreateInvoiceCoupon]. + status (CreateInvoiceStatus): The model property of type + CreateInvoiceStatus. additional_properties (Dict[str, object]): The additional properties for the model. @@ -160,3 +161,31 @@ def from_dictionary(cls, coupons, status, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'line_items={self.line_items!r}, ' + f'issue_date={self.issue_date!r}, ' + f'net_terms={self.net_terms!r}, ' + f'payment_instructions={self.payment_instructions!r}, ' + f'memo={self.memo!r}, ' + f'seller_address={self.seller_address!r}, ' + f'billing_address={self.billing_address!r}, ' + f'shipping_address={self.shipping_address!r}, ' + f'coupons={self.coupons!r}, ' + f'status={self.status!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'line_items={self.line_items!s}, ' + f'issue_date={self.issue_date!s}, ' + f'net_terms={self.net_terms!s}, ' + f'payment_instructions={self.payment_instructions!s}, ' + f'memo={self.memo!s}, ' + f'seller_address={self.seller_address!s}, ' + f'billing_address={self.billing_address!s}, ' + f'shipping_address={self.shipping_address!s}, ' + f'coupons={self.coupons!s}, ' + f'status={self.status!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_invoice_address.py b/advancedbilling/models/create_invoice_address.py index 27bbf67b..94896cba 100644 --- a/advancedbilling/models/create_invoice_address.py +++ b/advancedbilling/models/create_invoice_address.py @@ -16,15 +16,15 @@ class CreateInvoiceAddress(object): Overrides the default address. Attributes: - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - phone (str): TODO: type description here. - address (str): TODO: type description here. - address_2 (str): TODO: type description here. - city (str): TODO: type description here. - state (str): TODO: type description here. - zip (str): TODO: type description here. - country (str): TODO: type description here. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + phone (str): The model property of type str. + address (str): The model property of type str. + address_2 (str): The model property of type str. + city (str): The model property of type str. + state (str): The model property of type str. + zip (str): The model property of type str. + country (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -134,3 +134,29 @@ def from_dictionary(cls, zip, country, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'phone={self.phone!r}, ' + f'address={self.address!r}, ' + f'address_2={self.address_2!r}, ' + f'city={self.city!r}, ' + f'state={self.state!r}, ' + f'zip={self.zip!r}, ' + f'country={self.country!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'phone={self.phone!s}, ' + f'address={self.address!s}, ' + f'address_2={self.address_2!s}, ' + f'city={self.city!s}, ' + f'state={self.state!s}, ' + f'zip={self.zip!s}, ' + f'country={self.country!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_invoice_coupon.py b/advancedbilling/models/create_invoice_coupon.py index 2e7f475d..9e203cf8 100644 --- a/advancedbilling/models/create_invoice_coupon.py +++ b/advancedbilling/models/create_invoice_coupon.py @@ -13,14 +13,15 @@ class CreateInvoiceCoupon(object): """Implementation of the 'Create Invoice Coupon' model. - TODO: type model description here. - Attributes: - code (str): TODO: type description here. - percentage (str | float | None): TODO: type description here. - amount (str | float | None): TODO: type description here. - description (str): TODO: type description here. - product_family_id (str | int | None): TODO: type description here. + code (str): The model property of type str. + percentage (str | float | None): The model property of type str | + float | None. + amount (str | float | None): The model property of type str | float | + None. + description (str): The model property of type str. + product_family_id (str | int | None): The model property of type str | + int | None. compounding_strategy (CompoundingStrategy): Applicable only to stackable coupons. For `compound`, Percentage-based discounts will be calculated against the remaining price, after prior discounts @@ -116,3 +117,23 @@ def from_dictionary(cls, product_family_id, compounding_strategy, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'code={self.code!r}, ' + f'percentage={self.percentage!r}, ' + f'amount={self.amount!r}, ' + f'description={self.description!r}, ' + f'product_family_id={self.product_family_id!r}, ' + f'compounding_strategy={self.compounding_strategy!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'code={self.code!s}, ' + f'percentage={self.percentage!s}, ' + f'amount={self.amount!s}, ' + f'description={self.description!s}, ' + f'product_family_id={self.product_family_id!s}, ' + f'compounding_strategy={self.compounding_strategy!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_invoice_item.py b/advancedbilling/models/create_invoice_item.py index c251a8ef..bd4152fa 100644 --- a/advancedbilling/models/create_invoice_item.py +++ b/advancedbilling/models/create_invoice_item.py @@ -13,10 +13,8 @@ class CreateInvoiceItem(object): """Implementation of the 'Create Invoice Item' model. - TODO: type model description here. - Attributes: - title (str): TODO: type description here. + title (str): The model property of type str. quantity (float | str | None): The quantity can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or 0.00000065. If you submit a value with more than 8 decimal places, we will round it down to @@ -28,15 +26,16 @@ class CreateInvoiceItem(object): taxable (bool): Set to true to automatically calculate taxes. Site must be configured to use and calculate taxes. If using Avalara, a tax_code parameter must also be sent. - tax_code (str): TODO: type description here. + tax_code (str): The model property of type str. period_range_start (str): YYYY-MM-DD period_range_end (str): YYYY-MM-DD product_id (str | int | None): Product handle or product id. component_id (str | int | None): Component handle or component id. price_point_id (str | int | None): Price point handle or id. For component. - product_price_point_id (str | int | None): TODO: type description here. - description (str): TODO: type description here. + product_price_point_id (str | int | None): The model property of type + str | int | None. + description (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -168,3 +167,35 @@ def from_dictionary(cls, product_price_point_id, description, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'title={self.title!r}, ' + f'quantity={self.quantity!r}, ' + f'unit_price={self.unit_price!r}, ' + f'taxable={self.taxable!r}, ' + f'tax_code={self.tax_code!r}, ' + f'period_range_start={self.period_range_start!r}, ' + f'period_range_end={self.period_range_end!r}, ' + f'product_id={self.product_id!r}, ' + f'component_id={self.component_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'description={self.description!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'title={self.title!s}, ' + f'quantity={self.quantity!s}, ' + f'unit_price={self.unit_price!s}, ' + f'taxable={self.taxable!s}, ' + f'tax_code={self.tax_code!s}, ' + f'period_range_start={self.period_range_start!s}, ' + f'period_range_end={self.period_range_end!s}, ' + f'product_id={self.product_id!s}, ' + f'component_id={self.component_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'description={self.description!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_invoice_payment.py b/advancedbilling/models/create_invoice_payment.py index 0c7d473e..9f3943d4 100644 --- a/advancedbilling/models/create_invoice_payment.py +++ b/advancedbilling/models/create_invoice_payment.py @@ -15,8 +15,6 @@ class CreateInvoicePayment(object): """Implementation of the 'Create Invoice Payment' model. - TODO: type model description here. - Attributes: amount (str | float | None): A string of the dollar amount to be refunded (eg. "10.50" => $10.50) @@ -120,3 +118,23 @@ def from_dictionary(cls, payment_profile_id, received_on, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!r}, ' + f'memo={self.memo!r}, ' + f'method={self.method!r}, ' + f'details={self.details!r}, ' + f'payment_profile_id={self.payment_profile_id!r}, ' + f'received_on={self.received_on!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!s}, ' + f'memo={self.memo!s}, ' + f'method={self.method!s}, ' + f'details={self.details!s}, ' + f'payment_profile_id={self.payment_profile_id!s}, ' + f'received_on={self.received_on!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_invoice_payment_application.py b/advancedbilling/models/create_invoice_payment_application.py index f0d6f31e..1e767786 100644 --- a/advancedbilling/models/create_invoice_payment_application.py +++ b/advancedbilling/models/create_invoice_payment_application.py @@ -13,8 +13,6 @@ class CreateInvoicePaymentApplication(object): """Implementation of the 'Create Invoice Payment Application' model. - TODO: type model description here. - Attributes: invoice_uid (str): Unique identifier for the invoice. It has the prefix "inv_" followed by alphanumeric characters. @@ -101,3 +99,15 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('amount'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'invoice_uid={self.invoice_uid!r}, ' + f'amount={self.amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'invoice_uid={self.invoice_uid!s}, ' + f'amount={self.amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_invoice_payment_request.py b/advancedbilling/models/create_invoice_payment_request.py index e6d0b20f..3fc25c07 100644 --- a/advancedbilling/models/create_invoice_payment_request.py +++ b/advancedbilling/models/create_invoice_payment_request.py @@ -14,10 +14,9 @@ class CreateInvoicePaymentRequest(object): """Implementation of the 'Create Invoice Payment Request' model. - TODO: type model description here. - Attributes: - payment (CreateInvoicePayment): TODO: type description here. + payment (CreateInvoicePayment): The model property of type + CreateInvoicePayment. mtype (InvoicePaymentType): The type of payment to be applied to an Invoice. Defaults to external. additional_properties (Dict[str, object]): The additional properties @@ -78,3 +77,15 @@ def from_dictionary(cls, return cls(payment, mtype, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payment={self.payment!r}, ' + f'mtype={self.mtype!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payment={self.payment!s}, ' + f'mtype={self.mtype!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_invoice_request.py b/advancedbilling/models/create_invoice_request.py index 48156923..9ad0cb52 100644 --- a/advancedbilling/models/create_invoice_request.py +++ b/advancedbilling/models/create_invoice_request.py @@ -13,10 +13,8 @@ class CreateInvoiceRequest(object): """Implementation of the 'Create Invoice Request' model. - TODO: type model description here. - Attributes: - invoice (CreateInvoice): TODO: type description here. + invoice (CreateInvoice): The model property of type CreateInvoice. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(invoice, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'invoice={self.invoice!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'invoice={self.invoice!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_invoice_status.py b/advancedbilling/models/create_invoice_status.py index 2f643ce7..fde5ae49 100644 --- a/advancedbilling/models/create_invoice_status.py +++ b/advancedbilling/models/create_invoice_status.py @@ -12,11 +12,9 @@ class CreateInvoiceStatus(object): """Implementation of the 'Create Invoice Status' enum. - TODO: type enum description here. - Attributes: - DRAFT: TODO: type description here. - OPEN: TODO: type description here. + DRAFT: The enum member of type str. + OPEN: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/create_metadata.py b/advancedbilling/models/create_metadata.py index 019e9129..87e41385 100644 --- a/advancedbilling/models/create_metadata.py +++ b/advancedbilling/models/create_metadata.py @@ -13,11 +13,9 @@ class CreateMetadata(object): """Implementation of the 'Create Metadata' model. - TODO: type model description here. - Attributes: - name (str): TODO: type description here. - value (str): TODO: type description here. + name (str): The model property of type str. + value (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -78,3 +76,15 @@ def from_dictionary(cls, return cls(name, value, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'value={self.value!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'value={self.value!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_metadata_request.py b/advancedbilling/models/create_metadata_request.py index 8986e8d7..3f44f813 100644 --- a/advancedbilling/models/create_metadata_request.py +++ b/advancedbilling/models/create_metadata_request.py @@ -13,10 +13,9 @@ class CreateMetadataRequest(object): """Implementation of the 'Create Metadata Request' model. - TODO: type model description here. - Attributes: - metadata (List[CreateMetadata]): TODO: type description here. + metadata (List[CreateMetadata]): The model property of type + List[CreateMetadata]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -67,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(metadata, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'metadata={self.metadata!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'metadata={self.metadata!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_metafield.py b/advancedbilling/models/create_metafield.py index 76965265..6d859c8d 100644 --- a/advancedbilling/models/create_metafield.py +++ b/advancedbilling/models/create_metafield.py @@ -14,10 +14,8 @@ class CreateMetafield(object): """Implementation of the 'Create Metafield' model. - TODO: type model description here. - Attributes: - name (str): TODO: type description here. + name (str): The model property of type str. scope (MetafieldScope): Warning: When updating a metafield's scope attribute, all scope attributes must be passed. Partially complete scope attributes will override the existing settings. @@ -125,3 +123,19 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'scope={self.scope!r}, ' + f'input_type={self.input_type!r}, ' + f'enum={self.enum!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'scope={self.scope!s}, ' + f'input_type={self.input_type!s}, ' + f'enum={self.enum!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_metafields_request.py b/advancedbilling/models/create_metafields_request.py index 36c40407..dc05e305 100644 --- a/advancedbilling/models/create_metafields_request.py +++ b/advancedbilling/models/create_metafields_request.py @@ -13,11 +13,9 @@ class CreateMetafieldsRequest(object): """Implementation of the 'Create Metafields Request' model. - TODO: type model description here. - Attributes: - metafields (CreateMetafield | List[CreateMetafield]): TODO: type - description here. + metafields (CreateMetafield | List[CreateMetafield]): The model + property of type CreateMetafield | List[CreateMetafield]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -90,3 +88,13 @@ def validate(cls, dictionary): return False return UnionTypeLookUp.get('CreateMetafieldsRequestMetafields').validate(dictionary.get('metafields')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'metafields={self.metafields!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'metafields={self.metafields!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_metered_component.py b/advancedbilling/models/create_metered_component.py index 378bf205..fd98db43 100644 --- a/advancedbilling/models/create_metered_component.py +++ b/advancedbilling/models/create_metered_component.py @@ -13,10 +13,9 @@ class CreateMeteredComponent(object): """Implementation of the 'Create Metered Component' model. - TODO: type model description here. - Attributes: - metered_component (MeteredComponent): TODO: type description here. + metered_component (MeteredComponent): The model property of type + MeteredComponent. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(metered_component, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'metered_component={self.metered_component!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'metered_component={self.metered_component!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_multi_invoice_payment.py b/advancedbilling/models/create_multi_invoice_payment.py index de29a890..3e348f26 100644 --- a/advancedbilling/models/create_multi_invoice_payment.py +++ b/advancedbilling/models/create_multi_invoice_payment.py @@ -14,8 +14,6 @@ class CreateMultiInvoicePayment(object): """Implementation of the 'Create Multi Invoice Payment' model. - TODO: type model description here. - Attributes: memo (str): A description to be attached to the payment. details (str): Additional information related to the payment method @@ -26,8 +24,8 @@ class CreateMultiInvoicePayment(object): (eg. "10.50" => $10.50). received_on (str): Date reflecting when the payment was received from a customer. Must be in the past. - applications (List[CreateInvoicePaymentApplication]): TODO: type - description here. + applications (List[CreateInvoicePaymentApplication]): The model + property of type List[CreateInvoicePaymentApplication]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -146,3 +144,23 @@ def validate(cls, dictionary): type_callable=lambda value: CreateInvoicePaymentApplication.validate(value), is_model_dict=True, is_inner_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'memo={self.memo!r}, ' + f'details={self.details!r}, ' + f'method={self.method!r}, ' + f'amount={self.amount!r}, ' + f'received_on={self.received_on!r}, ' + f'applications={self.applications!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'memo={self.memo!s}, ' + f'details={self.details!s}, ' + f'method={self.method!s}, ' + f'amount={self.amount!s}, ' + f'received_on={self.received_on!s}, ' + f'applications={self.applications!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_multi_invoice_payment_request.py b/advancedbilling/models/create_multi_invoice_payment_request.py index 037a397c..b82adb29 100644 --- a/advancedbilling/models/create_multi_invoice_payment_request.py +++ b/advancedbilling/models/create_multi_invoice_payment_request.py @@ -13,10 +13,9 @@ class CreateMultiInvoicePaymentRequest(object): """Implementation of the 'Create Multi Invoice Payment Request' model. - TODO: type model description here. - Attributes: - payment (CreateMultiInvoicePayment): TODO: type description here. + payment (CreateMultiInvoicePayment): The model property of type + CreateMultiInvoicePayment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(payment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payment={self.payment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payment={self.payment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_offer.py b/advancedbilling/models/create_offer.py index ad34a9de..e349eaaf 100644 --- a/advancedbilling/models/create_offer.py +++ b/advancedbilling/models/create_offer.py @@ -14,16 +14,15 @@ class CreateOffer(object): """Implementation of the 'Create Offer' model. - TODO: type model description here. - Attributes: - name (str): TODO: type description here. - handle (str): TODO: type description here. - description (str): TODO: type description here. - product_id (int): TODO: type description here. - product_price_point_id (int): TODO: type description here. - components (List[CreateOfferComponent]): TODO: type description here. - coupons (List[str]): TODO: type description here. + name (str): The model property of type str. + handle (str): The model property of type str. + description (str): The model property of type str. + product_id (int): The model property of type int. + product_price_point_id (int): The model property of type int. + components (List[CreateOfferComponent]): The model property of type + List[CreateOfferComponent]. + coupons (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -117,3 +116,25 @@ def from_dictionary(cls, components, coupons, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'description={self.description!r}, ' + f'product_id={self.product_id!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'components={self.components!r}, ' + f'coupons={self.coupons!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'description={self.description!s}, ' + f'product_id={self.product_id!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'components={self.components!s}, ' + f'coupons={self.coupons!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_offer_component.py b/advancedbilling/models/create_offer_component.py index 329e38d5..ed64f3f1 100644 --- a/advancedbilling/models/create_offer_component.py +++ b/advancedbilling/models/create_offer_component.py @@ -13,12 +13,10 @@ class CreateOfferComponent(object): """Implementation of the 'Create Offer Component' model. - TODO: type model description here. - Attributes: - component_id (int): TODO: type description here. - price_point_id (int): TODO: type description here. - starting_quantity (int): TODO: type description here. + component_id (int): The model property of type int. + price_point_id (int): The model property of type int. + starting_quantity (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -86,3 +84,17 @@ def from_dictionary(cls, price_point_id, starting_quantity, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'starting_quantity={self.starting_quantity!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'starting_quantity={self.starting_quantity!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_offer_request.py b/advancedbilling/models/create_offer_request.py index 1f001c20..a87d1b6c 100644 --- a/advancedbilling/models/create_offer_request.py +++ b/advancedbilling/models/create_offer_request.py @@ -13,10 +13,8 @@ class CreateOfferRequest(object): """Implementation of the 'Create Offer Request' model. - TODO: type model description here. - Attributes: - offer (CreateOffer): TODO: type description here. + offer (CreateOffer): The model property of type CreateOffer. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(offer, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'offer={self.offer!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'offer={self.offer!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_on_off_component.py b/advancedbilling/models/create_on_off_component.py index 891488e6..cf7a4809 100644 --- a/advancedbilling/models/create_on_off_component.py +++ b/advancedbilling/models/create_on_off_component.py @@ -13,10 +13,9 @@ class CreateOnOffComponent(object): """Implementation of the 'Create On/Off Component' model. - TODO: type model description here. - Attributes: - on_off_component (OnOffComponent): TODO: type description here. + on_off_component (OnOffComponent): The model property of type + OnOffComponent. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(on_off_component, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'on_off_component={self.on_off_component!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'on_off_component={self.on_off_component!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_or_update_endpoint.py b/advancedbilling/models/create_or_update_endpoint.py index 3ebf0d6f..19d2facc 100644 --- a/advancedbilling/models/create_or_update_endpoint.py +++ b/advancedbilling/models/create_or_update_endpoint.py @@ -15,9 +15,9 @@ class CreateOrUpdateEndpoint(object): Used to Create or Update Endpoint Attributes: - url (str): TODO: type description here. - webhook_subscriptions (List[WebhookSubscription]): TODO: type - description here. + url (str): The model property of type str. + webhook_subscriptions (List[WebhookSubscription]): The model property + of type List[WebhookSubscription]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +71,15 @@ def from_dictionary(cls, return cls(url, webhook_subscriptions, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'url={self.url!r}, ' + f'webhook_subscriptions={self.webhook_subscriptions!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'url={self.url!s}, ' + f'webhook_subscriptions={self.webhook_subscriptions!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_or_update_endpoint_request.py b/advancedbilling/models/create_or_update_endpoint_request.py index e42e1979..d1c70b58 100644 --- a/advancedbilling/models/create_or_update_endpoint_request.py +++ b/advancedbilling/models/create_or_update_endpoint_request.py @@ -65,3 +65,13 @@ def from_dictionary(cls, # Return an object of this model return cls(endpoint, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'endpoint={self.endpoint!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'endpoint={self.endpoint!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_or_update_product.py b/advancedbilling/models/create_or_update_product.py index 7c3c4e39..b6f3b81f 100644 --- a/advancedbilling/models/create_or_update_product.py +++ b/advancedbilling/models/create_or_update_product.py @@ -13,8 +13,6 @@ class CreateOrUpdateProduct(object): """Implementation of the 'Create or Update Product' model. - TODO: type model description here. - Attributes: name (str): The product name handle (str): The product API handle @@ -23,20 +21,19 @@ class CreateOrUpdateProduct(object): require_credit_card (bool): Deprecated value that can be ignored unless you have legacy hosted pages. For Public Signup Page users, please read this attribute from under the signup page. - price_in_cents (long|int): The product price, in integer cents + price_in_cents (int): The product price, in integer cents interval (int): The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this product would renew every 30 days interval_unit (IntervalUnit): A string representing the interval unit for this product, either month or day - trial_price_in_cents (long|int): The product trial price, in integer - cents + trial_price_in_cents (int): The product trial price, in integer cents trial_interval (int): The numerical trial interval. i.e. an interval of ‘30’ coupled with a trial_interval_unit of day would mean this product trial would last 30 days. trial_interval_unit (IntervalUnit): A string representing the trial interval unit for this product, either month or day - trial_type (str): TODO: type description here. + trial_type (str): The model property of type str. expiration_interval (int): The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product would @@ -44,7 +41,7 @@ class CreateOrUpdateProduct(object): expiration_interval_unit (ExpirationIntervalUnit): A string representing the expiration interval unit for this product, either month, day or never - auto_create_signup_page (bool): TODO: type description here. + auto_create_signup_page (bool): The model property of type bool. tax_code (str): A string representing the tax code related to the product type. This is especially important when using the Avalara service to tax based on locale. This attribute has a max length of @@ -202,3 +199,43 @@ def from_dictionary(cls, auto_create_signup_page, tax_code, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'description={self.description!r}, ' + f'accounting_code={self.accounting_code!r}, ' + f'require_credit_card={self.require_credit_card!r}, ' + f'price_in_cents={self.price_in_cents!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'trial_price_in_cents={self.trial_price_in_cents!r}, ' + f'trial_interval={self.trial_interval!r}, ' + f'trial_interval_unit={self.trial_interval_unit!r}, ' + f'trial_type={self.trial_type!r}, ' + f'expiration_interval={self.expiration_interval!r}, ' + f'expiration_interval_unit={self.expiration_interval_unit!r}, ' + f'auto_create_signup_page={self.auto_create_signup_page!r}, ' + f'tax_code={self.tax_code!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'description={self.description!s}, ' + f'accounting_code={self.accounting_code!s}, ' + f'require_credit_card={self.require_credit_card!s}, ' + f'price_in_cents={self.price_in_cents!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'trial_price_in_cents={self.trial_price_in_cents!s}, ' + f'trial_interval={self.trial_interval!s}, ' + f'trial_interval_unit={self.trial_interval_unit!s}, ' + f'trial_type={self.trial_type!s}, ' + f'expiration_interval={self.expiration_interval!s}, ' + f'expiration_interval_unit={self.expiration_interval_unit!s}, ' + f'auto_create_signup_page={self.auto_create_signup_page!s}, ' + f'tax_code={self.tax_code!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_or_update_product_request.py b/advancedbilling/models/create_or_update_product_request.py index d7949b45..107f75b6 100644 --- a/advancedbilling/models/create_or_update_product_request.py +++ b/advancedbilling/models/create_or_update_product_request.py @@ -13,10 +13,9 @@ class CreateOrUpdateProductRequest(object): """Implementation of the 'Create or Update Product Request' model. - TODO: type model description here. - Attributes: - product (CreateOrUpdateProduct): TODO: type description here. + product (CreateOrUpdateProduct): The model property of type + CreateOrUpdateProduct. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(product, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product={self.product!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product={self.product!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_or_update_segment_price.py b/advancedbilling/models/create_or_update_segment_price.py index 44ba453d..1767bd99 100644 --- a/advancedbilling/models/create_or_update_segment_price.py +++ b/advancedbilling/models/create_or_update_segment_price.py @@ -13,11 +13,9 @@ class CreateOrUpdateSegmentPrice(object): """Implementation of the 'Create or Update Segment Price' model. - TODO: type model description here. - Attributes: - starting_quantity (int): TODO: type description here. - ending_quantity (int): TODO: type description here. + starting_quantity (int): The model property of type int. + ending_quantity (int): The model property of type int. unit_price (str | float): The price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or 0.00000065 additional_properties (Dict[str, object]): The additional properties @@ -109,3 +107,17 @@ def validate(cls, dictionary): return False return UnionTypeLookUp.get('CreateOrUpdateSegmentPriceUnitPrice').validate(dictionary.get('unit_price')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'starting_quantity={self.starting_quantity!r}, ' + f'ending_quantity={self.ending_quantity!r}, ' + f'unit_price={self.unit_price!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'starting_quantity={self.starting_quantity!s}, ' + f'ending_quantity={self.ending_quantity!s}, ' + f'unit_price={self.unit_price!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_payment.py b/advancedbilling/models/create_payment.py index 5ee23c6c..0b40f119 100644 --- a/advancedbilling/models/create_payment.py +++ b/advancedbilling/models/create_payment.py @@ -12,12 +12,10 @@ class CreatePayment(object): """Implementation of the 'Create Payment' model. - TODO: type model description here. - Attributes: - amount (str): TODO: type description here. - memo (str): TODO: type description here. - payment_details (str): TODO: type description here. + amount (str): The model property of type str. + memo (str): The model property of type str. + payment_details (str): The model property of type str. payment_method (InvoicePaymentMethodType): The type of payment method used. Defaults to other. additional_properties (Dict[str, object]): The additional properties @@ -83,3 +81,19 @@ def from_dictionary(cls, payment_details, payment_method, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!r}, ' + f'memo={self.memo!r}, ' + f'payment_details={self.payment_details!r}, ' + f'payment_method={self.payment_method!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!s}, ' + f'memo={self.memo!s}, ' + f'payment_details={self.payment_details!s}, ' + f'payment_method={self.payment_method!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_payment_profile.py b/advancedbilling/models/create_payment_profile.py index 67ac57c3..2fe5c722 100644 --- a/advancedbilling/models/create_payment_profile.py +++ b/advancedbilling/models/create_payment_profile.py @@ -13,18 +13,16 @@ class CreatePaymentProfile(object): """Implementation of the 'Create Payment Profile' model. - TODO: type model description here. - Attributes: chargify_token (str): Token received after sending billing informations using chargify.js. - id (int): TODO: type description here. - payment_type (PaymentType): TODO: type description here. + id (int): The model property of type int. + payment_type (PaymentType): The model property of type PaymentType. first_name (str): First name on card or bank account. If omitted, the first_name from customer attributes will be used. last_name (str): Last name on card or bank account. If omitted, the last_name from customer attributes will be used. - masked_card_number (str): TODO: type description here. + masked_card_number (str): The model property of type str. full_number (str): The full credit card number card_type (CardType): The type of card used. expiration_month (int | str | None): (Optional when performing an @@ -378,3 +376,75 @@ def from_dictionary(cls, bank_account_holder_type, last_four, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'chargify_token={self.chargify_token!r}, ' + f'id={self.id!r}, ' + f'payment_type={self.payment_type!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'masked_card_number={self.masked_card_number!r}, ' + f'full_number={self.full_number!r}, ' + f'card_type={self.card_type!r}, ' + f'expiration_month={self.expiration_month!r}, ' + f'expiration_year={self.expiration_year!r}, ' + f'billing_address={self.billing_address!r}, ' + f'billing_address_2={self.billing_address_2!r}, ' + f'billing_city={self.billing_city!r}, ' + f'billing_state={self.billing_state!r}, ' + f'billing_country={self.billing_country!r}, ' + f'billing_zip={self.billing_zip!r}, ' + f'current_vault={self.current_vault!r}, ' + f'vault_token={self.vault_token!r}, ' + f'customer_vault_token={self.customer_vault_token!r}, ' + f'customer_id={self.customer_id!r}, ' + f'paypal_email={self.paypal_email!r}, ' + f'payment_method_nonce={self.payment_method_nonce!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'cvv={self.cvv!r}, ' + f'bank_name={self.bank_name!r}, ' + f'bank_iban={self.bank_iban!r}, ' + f'bank_routing_number={self.bank_routing_number!r}, ' + f'bank_account_number={self.bank_account_number!r}, ' + f'bank_branch_code={self.bank_branch_code!r}, ' + f'bank_account_type={self.bank_account_type!r}, ' + f'bank_account_holder_type={self.bank_account_holder_type!r}, ' + f'last_four={self.last_four!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'chargify_token={self.chargify_token!s}, ' + f'id={self.id!s}, ' + f'payment_type={self.payment_type!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'masked_card_number={self.masked_card_number!s}, ' + f'full_number={self.full_number!s}, ' + f'card_type={self.card_type!s}, ' + f'expiration_month={self.expiration_month!s}, ' + f'expiration_year={self.expiration_year!s}, ' + f'billing_address={self.billing_address!s}, ' + f'billing_address_2={self.billing_address_2!s}, ' + f'billing_city={self.billing_city!s}, ' + f'billing_state={self.billing_state!s}, ' + f'billing_country={self.billing_country!s}, ' + f'billing_zip={self.billing_zip!s}, ' + f'current_vault={self.current_vault!s}, ' + f'vault_token={self.vault_token!s}, ' + f'customer_vault_token={self.customer_vault_token!s}, ' + f'customer_id={self.customer_id!s}, ' + f'paypal_email={self.paypal_email!s}, ' + f'payment_method_nonce={self.payment_method_nonce!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'cvv={self.cvv!s}, ' + f'bank_name={self.bank_name!s}, ' + f'bank_iban={self.bank_iban!s}, ' + f'bank_routing_number={self.bank_routing_number!s}, ' + f'bank_account_number={self.bank_account_number!s}, ' + f'bank_branch_code={self.bank_branch_code!s}, ' + f'bank_account_type={self.bank_account_type!s}, ' + f'bank_account_holder_type={self.bank_account_holder_type!s}, ' + f'last_four={self.last_four!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_payment_profile_request.py b/advancedbilling/models/create_payment_profile_request.py index 1544c0f7..49d207b7 100644 --- a/advancedbilling/models/create_payment_profile_request.py +++ b/advancedbilling/models/create_payment_profile_request.py @@ -13,10 +13,9 @@ class CreatePaymentProfileRequest(object): """Implementation of the 'Create Payment Profile Request' model. - TODO: type model description here. - Attributes: - payment_profile (CreatePaymentProfile): TODO: type description here. + payment_profile (CreatePaymentProfile): The model property of type + CreatePaymentProfile. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(payment_profile, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile={self.payment_profile!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile={self.payment_profile!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_prepaid_component.py b/advancedbilling/models/create_prepaid_component.py index 182f75a7..c94c2952 100644 --- a/advancedbilling/models/create_prepaid_component.py +++ b/advancedbilling/models/create_prepaid_component.py @@ -13,11 +13,9 @@ class CreatePrepaidComponent(object): """Implementation of the 'Create Prepaid Component' model. - TODO: type model description here. - Attributes: - prepaid_usage_component (PrepaidUsageComponent): TODO: type - description here. + prepaid_usage_component (PrepaidUsageComponent): The model property of + type PrepaidUsageComponent. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(prepaid_usage_component, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepaid_usage_component={self.prepaid_usage_component!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepaid_usage_component={self.prepaid_usage_component!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_prepaid_usage_component_price_point.py b/advancedbilling/models/create_prepaid_usage_component_price_point.py index cc3ecdc9..89c41af5 100644 --- a/advancedbilling/models/create_prepaid_usage_component_price_point.py +++ b/advancedbilling/models/create_prepaid_usage_component_price_point.py @@ -16,17 +16,16 @@ class CreatePrepaidUsageComponentPricePoint(object): """Implementation of the 'Create Prepaid Usage Component Price Point' model. - TODO: type model description here. - Attributes: - name (str): TODO: type description here. - handle (str): TODO: type description here. + name (str): The model property of type str. + handle (str): The model property of type str. pricing_scheme (PricingScheme): The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.h tml) for an overview of pricing schemes. - prices (List[Price]): TODO: type description here. - overage_pricing (OveragePricing): TODO: type description here. + prices (List[Price]): The model property of type List[Price]. + overage_pricing (OveragePricing): The model property of type + OveragePricing. use_site_exchange_rate (bool): Whether to use the site level exchange rate or define your own prices for each currency if you have multiple currencies defined on the site. @@ -199,3 +198,31 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('overage_pricing'), type_callable=lambda value: OveragePricing.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'overage_pricing={self.overage_pricing!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'rollover_prepaid_remainder={self.rollover_prepaid_remainder!r}, ' + f'renew_prepaid_allocation={self.renew_prepaid_allocation!r}, ' + f'expiration_interval={self.expiration_interval!r}, ' + f'expiration_interval_unit={self.expiration_interval_unit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'overage_pricing={self.overage_pricing!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'rollover_prepaid_remainder={self.rollover_prepaid_remainder!s}, ' + f'renew_prepaid_allocation={self.renew_prepaid_allocation!s}, ' + f'expiration_interval={self.expiration_interval!s}, ' + f'expiration_interval_unit={self.expiration_interval_unit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_prepayment.py b/advancedbilling/models/create_prepayment.py index 1000ac0d..9a5f6f29 100644 --- a/advancedbilling/models/create_prepayment.py +++ b/advancedbilling/models/create_prepayment.py @@ -13,18 +13,16 @@ class CreatePrepayment(object): """Implementation of the 'Create Prepayment' model. - TODO: type model description here. - Attributes: - amount (float): TODO: type description here. - details (str): TODO: type description here. - memo (str): TODO: type description here. + amount (float): The model property of type float. + details (str): The model property of type str. + memo (str): The model property of type str. method (CreatePrepaymentMethod): :- When the `method` specified is `"credit_card_on_file"`, the prepayment amount will be collected using the default credit card payment profile and applied to the prepayment account balance. This is especially useful for manual replenishment of prepaid subscriptions. - payment_profile_id (int): TODO: type description here. + payment_profile_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -98,3 +96,21 @@ def from_dictionary(cls, method, payment_profile_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!r}, ' + f'details={self.details!r}, ' + f'memo={self.memo!r}, ' + f'method={self.method!r}, ' + f'payment_profile_id={self.payment_profile_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!s}, ' + f'details={self.details!s}, ' + f'memo={self.memo!s}, ' + f'method={self.method!s}, ' + f'payment_profile_id={self.payment_profile_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_prepayment_method.py b/advancedbilling/models/create_prepayment_method.py index 1c440046..ae664168 100644 --- a/advancedbilling/models/create_prepayment_method.py +++ b/advancedbilling/models/create_prepayment_method.py @@ -18,14 +18,14 @@ class CreatePrepaymentMethod(object): manual replenishment of prepaid subscriptions. Attributes: - CHECK: TODO: type description here. - CASH: TODO: type description here. - MONEY_ORDER: TODO: type description here. - ACH: TODO: type description here. - PAYPAL_ACCOUNT: TODO: type description here. - CREDIT_CARD: TODO: type description here. - CREDIT_CARD_ON_FILE: TODO: type description here. - OTHER: TODO: type description here. + CHECK: The enum member of type str. + CASH: The enum member of type str. + MONEY_ORDER: The enum member of type str. + ACH: The enum member of type str. + PAYPAL_ACCOUNT: The enum member of type str. + CREDIT_CARD: The enum member of type str. + CREDIT_CARD_ON_FILE: The enum member of type str. + OTHER: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/create_prepayment_request.py b/advancedbilling/models/create_prepayment_request.py index be23c31d..fbcbc0c6 100644 --- a/advancedbilling/models/create_prepayment_request.py +++ b/advancedbilling/models/create_prepayment_request.py @@ -13,10 +13,9 @@ class CreatePrepaymentRequest(object): """Implementation of the 'Create Prepayment Request' model. - TODO: type model description here. - Attributes: - prepayment (CreatePrepayment): TODO: type description here. + prepayment (CreatePrepayment): The model property of type + CreatePrepayment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(prepayment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepayment={self.prepayment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepayment={self.prepayment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_prepayment_response.py b/advancedbilling/models/create_prepayment_response.py index 581450f4..4a9e686a 100644 --- a/advancedbilling/models/create_prepayment_response.py +++ b/advancedbilling/models/create_prepayment_response.py @@ -13,10 +13,9 @@ class CreatePrepaymentResponse(object): """Implementation of the 'Create Prepayment Response' model. - TODO: type model description here. - Attributes: - prepayment (CreatedPrepayment): TODO: type description here. + prepayment (CreatedPrepayment): The model property of type + CreatedPrepayment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(prepayment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepayment={self.prepayment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepayment={self.prepayment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_product_currency_price.py b/advancedbilling/models/create_product_currency_price.py index 095cd4ba..b0c8b328 100644 --- a/advancedbilling/models/create_product_currency_price.py +++ b/advancedbilling/models/create_product_currency_price.py @@ -12,8 +12,6 @@ class CreateProductCurrencyPrice(object): """Implementation of the 'Create Product Currency Price' model. - TODO: type model description here. - Attributes: currency (str): ISO code for one of the site level currencies. price (int): Price for the given role. @@ -76,3 +74,17 @@ def from_dictionary(cls, price, role, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currency={self.currency!r}, ' + f'price={self.price!r}, ' + f'role={self.role!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currency={self.currency!s}, ' + f'price={self.price!s}, ' + f'role={self.role!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_product_currency_prices_request.py b/advancedbilling/models/create_product_currency_prices_request.py index 9360ab13..7b8731b5 100644 --- a/advancedbilling/models/create_product_currency_prices_request.py +++ b/advancedbilling/models/create_product_currency_prices_request.py @@ -13,11 +13,9 @@ class CreateProductCurrencyPricesRequest(object): """Implementation of the 'Create Product Currency Prices Request' model. - TODO: type model description here. - Attributes: - currency_prices (List[CreateProductCurrencyPrice]): TODO: type - description here. + currency_prices (List[CreateProductCurrencyPrice]): The model property + of type List[CreateProductCurrencyPrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -68,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(currency_prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_product_family.py b/advancedbilling/models/create_product_family.py index 58a02742..a96be573 100644 --- a/advancedbilling/models/create_product_family.py +++ b/advancedbilling/models/create_product_family.py @@ -13,12 +13,10 @@ class CreateProductFamily(object): """Implementation of the 'Create Product Family' model. - TODO: type model description here. - Attributes: - name (str): TODO: type description here. - handle (str): TODO: type description here. - description (str): TODO: type description here. + name (str): The model property of type str. + handle (str): The model property of type str. + description (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -89,3 +87,17 @@ def from_dictionary(cls, handle, description, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'description={self.description!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'description={self.description!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_product_family_request.py b/advancedbilling/models/create_product_family_request.py index c2ccc32b..3ee74129 100644 --- a/advancedbilling/models/create_product_family_request.py +++ b/advancedbilling/models/create_product_family_request.py @@ -13,10 +13,9 @@ class CreateProductFamilyRequest(object): """Implementation of the 'Create Product Family Request' model. - TODO: type model description here. - Attributes: - product_family (CreateProductFamily): TODO: type description here. + product_family (CreateProductFamily): The model property of type + CreateProductFamily. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(product_family, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_family={self.product_family!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_family={self.product_family!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_product_price_point.py b/advancedbilling/models/create_product_price_point.py index 2062315a..43701936 100644 --- a/advancedbilling/models/create_product_price_point.py +++ b/advancedbilling/models/create_product_price_point.py @@ -13,29 +13,26 @@ class CreateProductPricePoint(object): """Implementation of the 'Create Product Price Point' model. - TODO: type model description here. - Attributes: name (str): The product price point name handle (str): The product price point API handle - price_in_cents (long|int): The product price point price, in integer - cents + price_in_cents (int): The product price point price, in integer cents interval (int): The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this product price point would renew every 30 days interval_unit (IntervalUnit): A string representing the interval unit for this product price point, either month or day - trial_price_in_cents (long|int): The product price point trial price, - in integer cents + trial_price_in_cents (int): The product price point trial price, in + integer cents trial_interval (int): The numerical trial interval. i.e. an interval of ‘30’ coupled with a trial_interval_unit of day would mean this product price point trial would last 30 days. trial_interval_unit (IntervalUnit): A string representing the trial interval unit for this product price point, either month or day - trial_type (str): TODO: type description here. - initial_charge_in_cents (long|int): The product price point initial - charge, in integer cents - initial_charge_after_trial (bool): TODO: type description here. + trial_type (str): The model property of type str. + initial_charge_in_cents (int): The product price point initial charge, + in integer cents + initial_charge_after_trial (bool): The model property of type bool. expiration_interval (int): The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product price @@ -185,3 +182,39 @@ def from_dictionary(cls, expiration_interval_unit, use_site_exchange_rate, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'price_in_cents={self.price_in_cents!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'trial_price_in_cents={self.trial_price_in_cents!r}, ' + f'trial_interval={self.trial_interval!r}, ' + f'trial_interval_unit={self.trial_interval_unit!r}, ' + f'trial_type={self.trial_type!r}, ' + f'initial_charge_in_cents={self.initial_charge_in_cents!r}, ' + f'initial_charge_after_trial={self.initial_charge_after_trial!r}, ' + f'expiration_interval={self.expiration_interval!r}, ' + f'expiration_interval_unit={self.expiration_interval_unit!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'price_in_cents={self.price_in_cents!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'trial_price_in_cents={self.trial_price_in_cents!s}, ' + f'trial_interval={self.trial_interval!s}, ' + f'trial_interval_unit={self.trial_interval_unit!s}, ' + f'trial_type={self.trial_type!s}, ' + f'initial_charge_in_cents={self.initial_charge_in_cents!s}, ' + f'initial_charge_after_trial={self.initial_charge_after_trial!s}, ' + f'expiration_interval={self.expiration_interval!s}, ' + f'expiration_interval_unit={self.expiration_interval_unit!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_product_price_point_request.py b/advancedbilling/models/create_product_price_point_request.py index 7b6cfd29..123f2965 100644 --- a/advancedbilling/models/create_product_price_point_request.py +++ b/advancedbilling/models/create_product_price_point_request.py @@ -13,10 +13,9 @@ class CreateProductPricePointRequest(object): """Implementation of the 'Create Product Price Point Request' model. - TODO: type model description here. - Attributes: - price_point (CreateProductPricePoint): TODO: type description here. + price_point (CreateProductPricePoint): The model property of type + CreateProductPricePoint. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(price_point, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_quantity_based_component.py b/advancedbilling/models/create_quantity_based_component.py index fb93395d..477cf07d 100644 --- a/advancedbilling/models/create_quantity_based_component.py +++ b/advancedbilling/models/create_quantity_based_component.py @@ -13,11 +13,9 @@ class CreateQuantityBasedComponent(object): """Implementation of the 'Create Quantity Based Component' model. - TODO: type model description here. - Attributes: - quantity_based_component (QuantityBasedComponent): TODO: type - description here. + quantity_based_component (QuantityBasedComponent): The model property + of type QuantityBasedComponent. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(quantity_based_component, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'quantity_based_component={self.quantity_based_component!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'quantity_based_component={self.quantity_based_component!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_reason_code.py b/advancedbilling/models/create_reason_code.py index 502ac1d1..d256cea3 100644 --- a/advancedbilling/models/create_reason_code.py +++ b/advancedbilling/models/create_reason_code.py @@ -13,8 +13,6 @@ class CreateReasonCode(object): """Implementation of the 'Create Reason Code' model. - TODO: type model description here. - Attributes: code (str): The unique identifier for the ReasonCode description (str): The friendly summary of what the code signifies @@ -82,3 +80,17 @@ def from_dictionary(cls, description, position, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'code={self.code!r}, ' + f'description={self.description!r}, ' + f'position={self.position!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'code={self.code!s}, ' + f'description={self.description!s}, ' + f'position={self.position!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_reason_code_request.py b/advancedbilling/models/create_reason_code_request.py index aa606589..c2f7cc19 100644 --- a/advancedbilling/models/create_reason_code_request.py +++ b/advancedbilling/models/create_reason_code_request.py @@ -13,10 +13,9 @@ class CreateReasonCodeRequest(object): """Implementation of the 'Create Reason Code Request' model. - TODO: type model description here. - Attributes: - reason_code (CreateReasonCode): TODO: type description here. + reason_code (CreateReasonCode): The model property of type + CreateReasonCode. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(reason_code, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'reason_code={self.reason_code!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'reason_code={self.reason_code!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_segment.py b/advancedbilling/models/create_segment.py index b2e69901..feab2c5e 100644 --- a/advancedbilling/models/create_segment.py +++ b/advancedbilling/models/create_segment.py @@ -14,8 +14,6 @@ class CreateSegment(object): """Implementation of the 'Create Segment' model. - TODO: type model description here. - Attributes: segment_property_1_value (str | float | int | bool | None): A value that will occur in your events that you want to bill upon. The @@ -37,7 +35,8 @@ class CreateSegment(object): See [Product Components](https://help.chargify.com/products/product-components.h tml) for an overview of pricing schemes. - prices (List[CreateOrUpdateSegmentPrice]): TODO: type description here. + prices (List[CreateOrUpdateSegmentPrice]): The model property of type + List[CreateOrUpdateSegmentPrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -129,3 +128,23 @@ def from_dictionary(cls, segment_property_4_value, prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'segment_property_1_value={self.segment_property_1_value!r}, ' + f'segment_property_2_value={self.segment_property_2_value!r}, ' + f'segment_property_3_value={self.segment_property_3_value!r}, ' + f'segment_property_4_value={self.segment_property_4_value!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'segment_property_1_value={self.segment_property_1_value!s}, ' + f'segment_property_2_value={self.segment_property_2_value!s}, ' + f'segment_property_3_value={self.segment_property_3_value!s}, ' + f'segment_property_4_value={self.segment_property_4_value!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_segment_request.py b/advancedbilling/models/create_segment_request.py index fc334c88..d44ff2b2 100644 --- a/advancedbilling/models/create_segment_request.py +++ b/advancedbilling/models/create_segment_request.py @@ -13,10 +13,8 @@ class CreateSegmentRequest(object): """Implementation of the 'Create Segment Request' model. - TODO: type model description here. - Attributes: - segment (CreateSegment): TODO: type description here. + segment (CreateSegment): The model property of type CreateSegment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(segment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'segment={self.segment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'segment={self.segment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_signup_proforma_preview_include.py b/advancedbilling/models/create_signup_proforma_preview_include.py index 08de6722..a6ec7961 100644 --- a/advancedbilling/models/create_signup_proforma_preview_include.py +++ b/advancedbilling/models/create_signup_proforma_preview_include.py @@ -12,10 +12,8 @@ class CreateSignupProformaPreviewInclude(object): """Implementation of the 'Create Signup Proforma Preview Include' enum. - TODO: type enum description here. - Attributes: - NEXT_PROFORMA_INVOICE: TODO: type description here. + NEXT_PROFORMA_INVOICE: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/create_subscription.py b/advancedbilling/models/create_subscription.py index b41cfcff..8c4560ba 100644 --- a/advancedbilling/models/create_subscription.py +++ b/advancedbilling/models/create_subscription.py @@ -23,8 +23,6 @@ class CreateSubscription(object): """Implementation of the 'Create Subscription' model. - TODO: type model description here. - Attributes: product_handle (str): The API Handle of the product for which you are creating a subscription. Required, unless a `product_id` is given @@ -94,7 +92,7 @@ class CreateSubscription(object): PSD2 and using 3D Secure, this can be used to reference a previous transaction for the customer. This will ensure the card will be charged successfully at renewal. - sales_rep_id (int): TODO: type description here. + sales_rep_id (int): The model property of type int. payment_profile_id (int): The Payment Profile ID of an existing card or bank account, which belongs to an existing customer to use for payment for this subscription. If the card, bank account, or @@ -106,14 +104,15 @@ class CreateSubscription(object): `bank_account` > id) reference (str): The reference value (provided by your app) for the subscription itelf. - customer_attributes (CustomerAttributes): TODO: type description here. + customer_attributes (CustomerAttributes): The model property of type + CustomerAttributes. payment_profile_attributes (PaymentProfileAttributes): alias to credit_card_attributes credit_card_attributes (PaymentProfileAttributes): Credit Card data to create a new Subscription. Interchangeable with `payment_profile_attributes` property. - bank_account_attributes (BankAccountAttributes): TODO: type - description here. + bank_account_attributes (BankAccountAttributes): The model property of + type BankAccountAttributes. components (List[CreateSubscriptionComponent]): (Optional) An array of component ids and quantities to be added to the subscription. See [Components](https://maxio.zendesk.com/hc/en-us/articles/2426114152 @@ -127,7 +126,7 @@ class CreateSubscription(object): customer_reference (str): The reference value (provided by your app) of an existing customer within Chargify. Required, unless a `customer_id` or a set of `customer_attributes` is given. - group (GroupSettings): TODO: type description here. + group (GroupSettings): The model property of type GroupSettings. ref (str): A valid referral code. (optional, see [Referrals](https://maxio.zendesk.com/hc/en-us/articles/24286981223 693-Referrals-Reference#how-to-obtain-referral-codes) for more @@ -174,8 +173,8 @@ class CreateSubscription(object): component information to set up the subscription with an existing offer. May be either the Chargify id of the offer or its handle prefixed with `handle:`.er - prepaid_configuration (UpsertPrepaidConfiguration): TODO: type - description here. + prepaid_configuration (UpsertPrepaidConfiguration): The model property + of type UpsertPrepaidConfiguration. previous_billing_at (datetime): Providing a previous_billing_at that is in the past will set the current_period_starts_at when the subscription is created. It will also set activated_at if not @@ -188,8 +187,8 @@ class CreateSubscription(object): For this value to be honored, a next_billing_at must be present and set to a future date. This key/value will not be returned in the subscription response body. - canceled_at (datetime): TODO: type description here. - activated_at (datetime): TODO: type description here. + canceled_at (datetime): The model property of type datetime. + activated_at (datetime): The model property of type datetime. agreement_acceptance (AgreementAcceptance): Required when creating a subscription with Maxio Payments. ach_agreement (ACHAgreement): (Optional) If passed, the proof of the @@ -599,3 +598,109 @@ def from_dictionary(cls, dunning_communication_delay_time_zone, skip_billing_manifest_taxes, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_handle={self.product_handle!r}, ' + f'product_id={self.product_id!r}, ' + f'product_price_point_handle={self.product_price_point_handle!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'custom_price={self.custom_price!r}, ' + f'coupon_code={self.coupon_code!r}, ' + f'coupon_codes={self.coupon_codes!r}, ' + f'payment_collection_method={self.payment_collection_method!r}, ' + f'receives_invoice_emails={self.receives_invoice_emails!r}, ' + f'net_terms={self.net_terms!r}, ' + f'customer_id={self.customer_id!r}, ' + f'next_billing_at={self.next_billing_at!r}, ' + f'initial_billing_at={self.initial_billing_at!r}, ' + f'stored_credential_transaction_id={self.stored_credential_transaction_id!r}, ' + f'sales_rep_id={self.sales_rep_id!r}, ' + f'payment_profile_id={self.payment_profile_id!r}, ' + f'reference={self.reference!r}, ' + f'customer_attributes={self.customer_attributes!r}, ' + f'payment_profile_attributes={self.payment_profile_attributes!r}, ' + f'credit_card_attributes={self.credit_card_attributes!r}, ' + f'bank_account_attributes={self.bank_account_attributes!r}, ' + f'components={self.components!r}, ' + f'calendar_billing={self.calendar_billing!r}, ' + f'metafields={self.metafields!r}, ' + f'customer_reference={self.customer_reference!r}, ' + f'group={self.group!r}, ' + f'ref={self.ref!r}, ' + f'cancellation_message={self.cancellation_message!r}, ' + f'cancellation_method={self.cancellation_method!r}, ' + f'currency={self.currency!r}, ' + f'expires_at={self.expires_at!r}, ' + f'expiration_tracks_next_billing_change={self.expiration_tracks_next_billing_change!r}, ' + f'agreement_terms={self.agreement_terms!r}, ' + f'authorizer_first_name={self.authorizer_first_name!r}, ' + f'authorizer_last_name={self.authorizer_last_name!r}, ' + f'calendar_billing_first_charge={self.calendar_billing_first_charge!r}, ' + f'reason_code={self.reason_code!r}, ' + f'product_change_delayed={self.product_change_delayed!r}, ' + f'offer_id={self.offer_id!r}, ' + f'prepaid_configuration={self.prepaid_configuration!r}, ' + f'previous_billing_at={self.previous_billing_at!r}, ' + f'import_mrr={self.import_mrr!r}, ' + f'canceled_at={self.canceled_at!r}, ' + f'activated_at={self.activated_at!r}, ' + f'agreement_acceptance={self.agreement_acceptance!r}, ' + f'ach_agreement={self.ach_agreement!r}, ' + f'dunning_communication_delay_enabled={self.dunning_communication_delay_enabled!r}, ' + f'dunning_communication_delay_time_zone={self.dunning_communication_delay_time_zone!r}, ' + f'skip_billing_manifest_taxes={self.skip_billing_manifest_taxes!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_handle={self.product_handle!s}, ' + f'product_id={self.product_id!s}, ' + f'product_price_point_handle={self.product_price_point_handle!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'custom_price={self.custom_price!s}, ' + f'coupon_code={self.coupon_code!s}, ' + f'coupon_codes={self.coupon_codes!s}, ' + f'payment_collection_method={self.payment_collection_method!s}, ' + f'receives_invoice_emails={self.receives_invoice_emails!s}, ' + f'net_terms={self.net_terms!s}, ' + f'customer_id={self.customer_id!s}, ' + f'next_billing_at={self.next_billing_at!s}, ' + f'initial_billing_at={self.initial_billing_at!s}, ' + f'stored_credential_transaction_id={self.stored_credential_transaction_id!s}, ' + f'sales_rep_id={self.sales_rep_id!s}, ' + f'payment_profile_id={self.payment_profile_id!s}, ' + f'reference={self.reference!s}, ' + f'customer_attributes={self.customer_attributes!s}, ' + f'payment_profile_attributes={self.payment_profile_attributes!s}, ' + f'credit_card_attributes={self.credit_card_attributes!s}, ' + f'bank_account_attributes={self.bank_account_attributes!s}, ' + f'components={self.components!s}, ' + f'calendar_billing={self.calendar_billing!s}, ' + f'metafields={self.metafields!s}, ' + f'customer_reference={self.customer_reference!s}, ' + f'group={self.group!s}, ' + f'ref={self.ref!s}, ' + f'cancellation_message={self.cancellation_message!s}, ' + f'cancellation_method={self.cancellation_method!s}, ' + f'currency={self.currency!s}, ' + f'expires_at={self.expires_at!s}, ' + f'expiration_tracks_next_billing_change={self.expiration_tracks_next_billing_change!s}, ' + f'agreement_terms={self.agreement_terms!s}, ' + f'authorizer_first_name={self.authorizer_first_name!s}, ' + f'authorizer_last_name={self.authorizer_last_name!s}, ' + f'calendar_billing_first_charge={self.calendar_billing_first_charge!s}, ' + f'reason_code={self.reason_code!s}, ' + f'product_change_delayed={self.product_change_delayed!s}, ' + f'offer_id={self.offer_id!s}, ' + f'prepaid_configuration={self.prepaid_configuration!s}, ' + f'previous_billing_at={self.previous_billing_at!s}, ' + f'import_mrr={self.import_mrr!s}, ' + f'canceled_at={self.canceled_at!s}, ' + f'activated_at={self.activated_at!s}, ' + f'agreement_acceptance={self.agreement_acceptance!s}, ' + f'ach_agreement={self.ach_agreement!s}, ' + f'dunning_communication_delay_enabled={self.dunning_communication_delay_enabled!s}, ' + f'dunning_communication_delay_time_zone={self.dunning_communication_delay_time_zone!s}, ' + f'skip_billing_manifest_taxes={self.skip_billing_manifest_taxes!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_subscription_component.py b/advancedbilling/models/create_subscription_component.py index 00d3b949..a9b548ee 100644 --- a/advancedbilling/models/create_subscription_component.py +++ b/advancedbilling/models/create_subscription_component.py @@ -14,16 +14,16 @@ class CreateSubscriptionComponent(object): """Implementation of the 'Create Subscription Component' model. - TODO: type model description here. - Attributes: - component_id (int | str | None): TODO: type description here. + component_id (int | str | None): The model property of type int | str + | None. enabled (bool): Used for on/off components only. unit_balance (int): Used for metered and events based components. allocated_quantity (int | str | None): Used for quantity based components. quantity (int): Deprecated. Use `allocated_quantity` instead. - price_point_id (int | str | None): TODO: type description here. + price_point_id (int | str | None): The model property of type int | + str | None. custom_price (ComponentCustomPrice): Create or update custom pricing unique to the subscription. Used in place of `price_point_id`. additional_properties (Dict[str, object]): The additional properties @@ -144,3 +144,25 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!r}, ' + f'enabled={self.enabled!r}, ' + f'unit_balance={self.unit_balance!r}, ' + f'allocated_quantity={self.allocated_quantity!r}, ' + f'quantity={self.quantity!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'custom_price={self.custom_price!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!s}, ' + f'enabled={self.enabled!s}, ' + f'unit_balance={self.unit_balance!s}, ' + f'allocated_quantity={self.allocated_quantity!s}, ' + f'quantity={self.quantity!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'custom_price={self.custom_price!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_subscription_group.py b/advancedbilling/models/create_subscription_group.py index 861a8aa8..b6ed2630 100644 --- a/advancedbilling/models/create_subscription_group.py +++ b/advancedbilling/models/create_subscription_group.py @@ -13,11 +13,9 @@ class CreateSubscriptionGroup(object): """Implementation of the 'Create Subscription Group' model. - TODO: type model description here. - Attributes: - subscription_id (int): TODO: type description here. - member_ids (List[int]): TODO: type description here. + subscription_id (int): The model property of type int. + member_ids (List[int]): The model property of type List[int]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -76,3 +74,15 @@ def from_dictionary(cls, return cls(subscription_id, member_ids, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_id={self.subscription_id!r}, ' + f'member_ids={self.member_ids!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_id={self.subscription_id!s}, ' + f'member_ids={self.member_ids!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_subscription_group_request.py b/advancedbilling/models/create_subscription_group_request.py index a1941516..d287e8df 100644 --- a/advancedbilling/models/create_subscription_group_request.py +++ b/advancedbilling/models/create_subscription_group_request.py @@ -13,11 +13,9 @@ class CreateSubscriptionGroupRequest(object): """Implementation of the 'Create Subscription Group Request' model. - TODO: type model description here. - Attributes: - subscription_group (CreateSubscriptionGroup): TODO: type description - here. + subscription_group (CreateSubscriptionGroup): The model property of + type CreateSubscriptionGroup. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription_group, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_subscription_request.py b/advancedbilling/models/create_subscription_request.py index e1838595..8c7a6fc2 100644 --- a/advancedbilling/models/create_subscription_request.py +++ b/advancedbilling/models/create_subscription_request.py @@ -13,10 +13,9 @@ class CreateSubscriptionRequest(object): """Implementation of the 'Create Subscription Request' model. - TODO: type model description here. - Attributes: - subscription (CreateSubscription): TODO: type description here. + subscription (CreateSubscription): The model property of type + CreateSubscription. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_usage.py b/advancedbilling/models/create_usage.py index 0692f20d..f3dd60d6 100644 --- a/advancedbilling/models/create_usage.py +++ b/advancedbilling/models/create_usage.py @@ -14,13 +14,11 @@ class CreateUsage(object): """Implementation of the 'Create Usage' model. - TODO: type model description here. - Attributes: quantity (float): integer by default or decimal number if fractional quantities are enabled for the component - price_point_id (str): TODO: type description here. - memo (str): TODO: type description here. + price_point_id (str): The model property of type str. + memo (str): The model property of type str. billing_schedule (BillingSchedule): This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. Please @@ -99,3 +97,19 @@ def from_dictionary(cls, memo, billing_schedule, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'quantity={self.quantity!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'memo={self.memo!r}, ' + f'billing_schedule={self.billing_schedule!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'quantity={self.quantity!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'memo={self.memo!s}, ' + f'billing_schedule={self.billing_schedule!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/create_usage_request.py b/advancedbilling/models/create_usage_request.py index e6f7f3e7..d7c45548 100644 --- a/advancedbilling/models/create_usage_request.py +++ b/advancedbilling/models/create_usage_request.py @@ -13,10 +13,8 @@ class CreateUsageRequest(object): """Implementation of the 'Create Usage Request' model. - TODO: type model description here. - Attributes: - usage (CreateUsage): TODO: type description here. + usage (CreateUsage): The model property of type CreateUsage. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(usage, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'usage={self.usage!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'usage={self.usage!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/created_prepayment.py b/advancedbilling/models/created_prepayment.py index d2e61287..b320ecd3 100644 --- a/advancedbilling/models/created_prepayment.py +++ b/advancedbilling/models/created_prepayment.py @@ -13,16 +13,14 @@ class CreatedPrepayment(object): """Implementation of the 'Created Prepayment' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - subscription_id (int): TODO: type description here. - amount_in_cents (long|int): TODO: type description here. - memo (str): TODO: type description here. - created_at (datetime): TODO: type description here. - starting_balance_in_cents (long|int): TODO: type description here. - ending_balance_in_cents (long|int): TODO: type description here. + id (int): The model property of type int. + subscription_id (int): The model property of type int. + amount_in_cents (int): The model property of type int. + memo (str): The model property of type str. + created_at (datetime): The model property of type datetime. + starting_balance_in_cents (int): The model property of type int. + ending_balance_in_cents (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -118,3 +116,25 @@ def from_dictionary(cls, starting_balance_in_cents, ending_balance_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'memo={self.memo!r}, ' + f'created_at={self.created_at!r}, ' + f'starting_balance_in_cents={self.starting_balance_in_cents!r}, ' + f'ending_balance_in_cents={self.ending_balance_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'memo={self.memo!s}, ' + f'created_at={self.created_at!s}, ' + f'starting_balance_in_cents={self.starting_balance_in_cents!s}, ' + f'ending_balance_in_cents={self.ending_balance_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/credit_account_balance_changed.py b/advancedbilling/models/credit_account_balance_changed.py index 827e7ae7..aa3aad40 100644 --- a/advancedbilling/models/credit_account_balance_changed.py +++ b/advancedbilling/models/credit_account_balance_changed.py @@ -13,16 +13,14 @@ class CreditAccountBalanceChanged(object): """Implementation of the 'Credit Account Balance Changed' model. - TODO: type model description here. - Attributes: - reason (str): TODO: type description here. - service_credit_account_balance_in_cents (long|int): TODO: type - description here. - service_credit_balance_change_in_cents (long|int): TODO: type - description here. - currency_code (str): TODO: type description here. - at_time (datetime): TODO: type description here. + reason (str): The model property of type str. + service_credit_account_balance_in_cents (int): The model property of + type int. + service_credit_balance_change_in_cents (int): The model property of + type int. + currency_code (str): The model property of type str. + at_time (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -131,3 +129,21 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('at_time'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'reason={self.reason!r}, ' + f'service_credit_account_balance_in_cents={self.service_credit_account_balance_in_cents!r}, ' + f'service_credit_balance_change_in_cents={self.service_credit_balance_change_in_cents!r}, ' + f'currency_code={self.currency_code!r}, ' + f'at_time={self.at_time!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'reason={self.reason!s}, ' + f'service_credit_account_balance_in_cents={self.service_credit_account_balance_in_cents!s}, ' + f'service_credit_balance_change_in_cents={self.service_credit_balance_change_in_cents!s}, ' + f'currency_code={self.currency_code!s}, ' + f'at_time={self.at_time!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/credit_card_attributes.py b/advancedbilling/models/credit_card_attributes.py index 36ed3482..8b524d71 100644 --- a/advancedbilling/models/credit_card_attributes.py +++ b/advancedbilling/models/credit_card_attributes.py @@ -13,12 +13,10 @@ class CreditCardAttributes(object): """Implementation of the 'Credit Card Attributes' model. - TODO: type model description here. - Attributes: - full_number (str): TODO: type description here. - expiration_month (str): TODO: type description here. - expiration_year (str): TODO: type description here. + full_number (str): The model property of type str. + expiration_month (str): The model property of type str. + expiration_year (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -108,3 +106,17 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'full_number={self.full_number!r}, ' + f'expiration_month={self.expiration_month!r}, ' + f'expiration_year={self.expiration_year!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'full_number={self.full_number!s}, ' + f'expiration_month={self.expiration_month!s}, ' + f'expiration_year={self.expiration_year!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/credit_card_payment_profile.py b/advancedbilling/models/credit_card_payment_profile.py index 84f134f5..097706ca 100644 --- a/advancedbilling/models/credit_card_payment_profile.py +++ b/advancedbilling/models/credit_card_payment_profile.py @@ -14,8 +14,6 @@ class CreditCardPaymentProfile(object): """Implementation of the 'Credit Card Payment Profile' model. - TODO: type model description here. - Attributes: id (int): The Chargify-assigned ID of the stored card. This value can be used as an input to payment_profile_id when creating a @@ -48,13 +46,13 @@ class CreditCardPaymentProfile(object): provided as the vault_token. billing_address_2 (str): The current billing street address, second line, for the card. - payment_type (PaymentType): TODO: type description here. - disabled (bool): TODO: type description here. + payment_type (PaymentType): The model property of type PaymentType. + disabled (bool): The model property of type bool. chargify_token (str): Token received after sending billing information using chargify.js. This token will only be received if passed as a sole attribute of credit_card_attributes (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) - site_gateway_setting_id (int): TODO: type description here. + site_gateway_setting_id (int): The model property of type int. gateway_handle (str): An identifier of connected gateway. additional_properties (Dict[str, object]): The additional properties for the model. @@ -291,3 +289,55 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('payment_type'), type_callable=lambda value: PaymentType.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'masked_card_number={self.masked_card_number!r}, ' + f'card_type={self.card_type!r}, ' + f'expiration_month={self.expiration_month!r}, ' + f'expiration_year={self.expiration_year!r}, ' + f'customer_id={self.customer_id!r}, ' + f'current_vault={self.current_vault!r}, ' + f'vault_token={self.vault_token!r}, ' + f'billing_address={self.billing_address!r}, ' + f'billing_city={self.billing_city!r}, ' + f'billing_state={self.billing_state!r}, ' + f'billing_zip={self.billing_zip!r}, ' + f'billing_country={self.billing_country!r}, ' + f'customer_vault_token={self.customer_vault_token!r}, ' + f'billing_address_2={self.billing_address_2!r}, ' + f'payment_type={self.payment_type!r}, ' + f'disabled={self.disabled!r}, ' + f'chargify_token={self.chargify_token!r}, ' + f'site_gateway_setting_id={self.site_gateway_setting_id!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'masked_card_number={self.masked_card_number!s}, ' + f'card_type={self.card_type!s}, ' + f'expiration_month={self.expiration_month!s}, ' + f'expiration_year={self.expiration_year!s}, ' + f'customer_id={self.customer_id!s}, ' + f'current_vault={self.current_vault!s}, ' + f'vault_token={self.vault_token!s}, ' + f'billing_address={self.billing_address!s}, ' + f'billing_city={self.billing_city!s}, ' + f'billing_state={self.billing_state!s}, ' + f'billing_zip={self.billing_zip!s}, ' + f'billing_country={self.billing_country!s}, ' + f'customer_vault_token={self.customer_vault_token!s}, ' + f'billing_address_2={self.billing_address_2!s}, ' + f'payment_type={self.payment_type!s}, ' + f'disabled={self.disabled!s}, ' + f'chargify_token={self.chargify_token!s}, ' + f'site_gateway_setting_id={self.site_gateway_setting_id!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/credit_card_vault.py b/advancedbilling/models/credit_card_vault.py index 38971d98..92e37209 100644 --- a/advancedbilling/models/credit_card_vault.py +++ b/advancedbilling/models/credit_card_vault.py @@ -16,39 +16,39 @@ class CreditCardVault(object): Use `bogus` for testing. Attributes: - ADYEN: TODO: type description here. - AUTHORIZENET: TODO: type description here. - BEANSTREAM: TODO: type description here. - BLUE_SNAP: TODO: type description here. - BOGUS: TODO: type description here. - BRAINTREE1: TODO: type description here. - BRAINTREE_BLUE: TODO: type description here. - CHECKOUT: TODO: type description here. - CYBERSOURCE: TODO: type description here. - ELAVON: TODO: type description here. - EWAY: TODO: type description here. - EWAY_RAPID: TODO: type description here. - EWAY_RAPID_STD: TODO: type description here. - FIRSTDATA: TODO: type description here. - FORTE: TODO: type description here. - LITLE: TODO: type description here. - MAXIO_PAYMENTS: TODO: type description here. - MAXP: TODO: type description here. - MODUSLINK: TODO: type description here. - MONERIS: TODO: type description here. - NMI: TODO: type description here. - ORBITAL: TODO: type description here. - PAYMENT_EXPRESS: TODO: type description here. - PAYMILL: TODO: type description here. - PAYPAL: TODO: type description here. - PAYPAL_COMPLETE: TODO: type description here. - PIN: TODO: type description here. - SQUARE: TODO: type description here. - STRIPE: TODO: type description here. - STRIPE_CONNECT: TODO: type description here. - TRUST_COMMERCE: TODO: type description here. - UNIPAAS: TODO: type description here. - WIRECARD: TODO: type description here. + ADYEN: The enum member of type str. + AUTHORIZENET: The enum member of type str. + BEANSTREAM: The enum member of type str. + BLUE_SNAP: The enum member of type str. + BOGUS: The enum member of type str. + BRAINTREE1: The enum member of type str. + BRAINTREE_BLUE: The enum member of type str. + CHECKOUT: The enum member of type str. + CYBERSOURCE: The enum member of type str. + ELAVON: The enum member of type str. + EWAY: The enum member of type str. + EWAY_RAPID: The enum member of type str. + EWAY_RAPID_STD: The enum member of type str. + FIRSTDATA: The enum member of type str. + FORTE: The enum member of type str. + LITLE: The enum member of type str. + MAXIO_PAYMENTS: The enum member of type str. + MAXP: The enum member of type str. + MODUSLINK: The enum member of type str. + MONERIS: The enum member of type str. + NMI: The enum member of type str. + ORBITAL: The enum member of type str. + PAYMENT_EXPRESS: The enum member of type str. + PAYMILL: The enum member of type str. + PAYPAL: The enum member of type str. + PAYPAL_COMPLETE: The enum member of type str. + PIN: The enum member of type str. + SQUARE: The enum member of type str. + STRIPE: The enum member of type str. + STRIPE_CONNECT: The enum member of type str. + TRUST_COMMERCE: The enum member of type str. + UNIPAAS: The enum member of type str. + WIRECARD: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/credit_note.py b/advancedbilling/models/credit_note.py index 2be6a500..9f74ce3b 100644 --- a/advancedbilling/models/credit_note.py +++ b/advancedbilling/models/credit_note.py @@ -24,8 +24,6 @@ class CreditNote(object): """Implementation of the 'Credit Note' model. - TODO: type model description here. - Attributes: uid (str): Unique identifier for the credit note. It is generated automatically by Chargify and has the prefix "cn_" followed by @@ -86,11 +84,13 @@ class CreditNote(object): remaining_amount (str): The amount of the credit note remaining to be applied to invoices, which is `total_amount - applied_amount`. line_items (List[CreditNoteLineItem]): Line items on the credit note. - discounts (List[InvoiceDiscount]): TODO: type description here. - taxes (List[InvoiceTax]): TODO: type description here. - applications (List[CreditNoteApplication]): TODO: type description - here. - refunds (List[InvoiceRefund]): TODO: type description here. + discounts (List[InvoiceDiscount]): The model property of type + List[InvoiceDiscount]. + taxes (List[InvoiceTax]): The model property of type List[InvoiceTax]. + applications (List[CreditNoteApplication]): The model property of type + List[CreditNoteApplication]. + refunds (List[InvoiceRefund]): The model property of type + List[InvoiceRefund]. origin_invoices (List[OriginInvoice]): An array of origin invoices for the credit note. Learn more about [Origin Invoice from our docs](https://maxio.zendesk.com/hc/en-us/articles/24252261284749-Cr @@ -376,3 +376,65 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'site_id={self.site_id!r}, ' + f'customer_id={self.customer_id!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'number={self.number!r}, ' + f'sequence_number={self.sequence_number!r}, ' + f'issue_date={self.issue_date!r}, ' + f'applied_date={self.applied_date!r}, ' + f'status={self.status!r}, ' + f'currency={self.currency!r}, ' + f'memo={self.memo!r}, ' + f'seller={self.seller!r}, ' + f'customer={self.customer!r}, ' + f'billing_address={self.billing_address!r}, ' + f'shipping_address={self.shipping_address!r}, ' + f'subtotal_amount={self.subtotal_amount!r}, ' + f'discount_amount={self.discount_amount!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'total_amount={self.total_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'remaining_amount={self.remaining_amount!r}, ' + f'line_items={self.line_items!r}, ' + f'discounts={self.discounts!r}, ' + f'taxes={self.taxes!r}, ' + f'applications={self.applications!r}, ' + f'refunds={self.refunds!r}, ' + f'origin_invoices={self.origin_invoices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'site_id={self.site_id!s}, ' + f'customer_id={self.customer_id!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'number={self.number!s}, ' + f'sequence_number={self.sequence_number!s}, ' + f'issue_date={self.issue_date!s}, ' + f'applied_date={self.applied_date!s}, ' + f'status={self.status!s}, ' + f'currency={self.currency!s}, ' + f'memo={self.memo!s}, ' + f'seller={self.seller!s}, ' + f'customer={self.customer!s}, ' + f'billing_address={self.billing_address!s}, ' + f'shipping_address={self.shipping_address!s}, ' + f'subtotal_amount={self.subtotal_amount!s}, ' + f'discount_amount={self.discount_amount!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'total_amount={self.total_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'remaining_amount={self.remaining_amount!s}, ' + f'line_items={self.line_items!s}, ' + f'discounts={self.discounts!s}, ' + f'taxes={self.taxes!s}, ' + f'applications={self.applications!s}, ' + f'refunds={self.refunds!s}, ' + f'origin_invoices={self.origin_invoices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/credit_note_application.py b/advancedbilling/models/credit_note_application.py index 2b8baf53..8e65933a 100644 --- a/advancedbilling/models/credit_note_application.py +++ b/advancedbilling/models/credit_note_application.py @@ -13,14 +13,12 @@ class CreditNoteApplication(object): """Implementation of the 'Credit Note Application' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - transaction_time (datetime): TODO: type description here. - invoice_uid (str): TODO: type description here. - memo (str): TODO: type description here. - applied_amount (str): TODO: type description here. + uid (str): The model property of type str. + transaction_time (datetime): The model property of type datetime. + invoice_uid (str): The model property of type str. + memo (str): The model property of type str. + applied_amount (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -124,3 +122,21 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'invoice_uid={self.invoice_uid!r}, ' + f'memo={self.memo!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'invoice_uid={self.invoice_uid!s}, ' + f'memo={self.memo!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/credit_note_line_item.py b/advancedbilling/models/credit_note_line_item.py index 49387519..5e02bdf6 100644 --- a/advancedbilling/models/credit_note_line_item.py +++ b/advancedbilling/models/credit_note_line_item.py @@ -15,8 +15,6 @@ class CreditNoteLineItem(object): """Implementation of the 'Credit Note Line Item' model. - TODO: type model description here. - Attributes: uid (str): Unique identifier for the line item. Useful when cross-referencing the line against individual discounts in the @@ -73,8 +71,8 @@ class CreditNoteLineItem(object): `nil` for non-component credits. price_point_id (int): The price point ID of the component being credited. Will be `nil` for non-component credits. - billing_schedule_item_id (int): TODO: type description here. - custom_item (bool): TODO: type description here. + billing_schedule_item_id (int): The model property of type int. + custom_item (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -275,3 +273,47 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'title={self.title!r}, ' + f'description={self.description!r}, ' + f'quantity={self.quantity!r}, ' + f'unit_price={self.unit_price!r}, ' + f'subtotal_amount={self.subtotal_amount!r}, ' + f'discount_amount={self.discount_amount!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'total_amount={self.total_amount!r}, ' + f'tiered_unit_price={self.tiered_unit_price!r}, ' + f'period_range_start={self.period_range_start!r}, ' + f'period_range_end={self.period_range_end!r}, ' + f'product_id={self.product_id!r}, ' + f'product_version={self.product_version!r}, ' + f'component_id={self.component_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'billing_schedule_item_id={self.billing_schedule_item_id!r}, ' + f'custom_item={self.custom_item!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'title={self.title!s}, ' + f'description={self.description!s}, ' + f'quantity={self.quantity!s}, ' + f'unit_price={self.unit_price!s}, ' + f'subtotal_amount={self.subtotal_amount!s}, ' + f'discount_amount={self.discount_amount!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'total_amount={self.total_amount!s}, ' + f'tiered_unit_price={self.tiered_unit_price!s}, ' + f'period_range_start={self.period_range_start!s}, ' + f'period_range_end={self.period_range_end!s}, ' + f'product_id={self.product_id!s}, ' + f'product_version={self.product_version!s}, ' + f'component_id={self.component_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'billing_schedule_item_id={self.billing_schedule_item_id!s}, ' + f'custom_item={self.custom_item!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/credit_note_status.py b/advancedbilling/models/credit_note_status.py index b368492f..0e1748cb 100644 --- a/advancedbilling/models/credit_note_status.py +++ b/advancedbilling/models/credit_note_status.py @@ -15,8 +15,8 @@ class CreditNoteStatus(object): Current status of the credit note. Attributes: - OPEN: TODO: type description here. - APPLIED: TODO: type description here. + OPEN: The enum member of type str. + APPLIED: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/credit_scheme.py b/advancedbilling/models/credit_scheme.py index dc54a176..00c716dc 100644 --- a/advancedbilling/models/credit_scheme.py +++ b/advancedbilling/models/credit_scheme.py @@ -12,12 +12,10 @@ class CreditScheme(object): """Implementation of the 'Credit Scheme' enum. - TODO: type enum description here. - Attributes: - NONE: TODO: type description here. - CREDIT: TODO: type description here. - REFUND: TODO: type description here. + NONE: The enum member of type str. + CREDIT: The enum member of type str. + REFUND: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/credit_scheme_request.py b/advancedbilling/models/credit_scheme_request.py index e5318e44..f8709095 100644 --- a/advancedbilling/models/credit_scheme_request.py +++ b/advancedbilling/models/credit_scheme_request.py @@ -12,10 +12,8 @@ class CreditSchemeRequest(object): """Implementation of the 'Credit Scheme Request' model. - TODO: type model description here. - Attributes: - credit_scheme (CreditScheme): TODO: type description here. + credit_scheme (CreditScheme): The model property of type CreditScheme. additional_properties (Dict[str, object]): The additional properties for the model. @@ -64,3 +62,13 @@ def from_dictionary(cls, # Return an object of this model return cls(credit_scheme, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'credit_scheme={self.credit_scheme!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'credit_scheme={self.credit_scheme!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/credit_type.py b/advancedbilling/models/credit_type.py index 33785497..e8d2d3d6 100644 --- a/advancedbilling/models/credit_type.py +++ b/advancedbilling/models/credit_type.py @@ -17,9 +17,9 @@ class CreditType(object): Available values: `full`, `prorated`, `none`. Attributes: - FULL: TODO: type description here. - PRORATED: TODO: type description here. - NONE: TODO: type description here. + FULL: The enum member of type str. + PRORATED: The enum member of type str. + NONE: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/currency_price.py b/advancedbilling/models/currency_price.py index a7f3315d..5c49ec33 100644 --- a/advancedbilling/models/currency_price.py +++ b/advancedbilling/models/currency_price.py @@ -13,16 +13,14 @@ class CurrencyPrice(object): """Implementation of the 'Currency Price' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - currency (str): TODO: type description here. - price (float): TODO: type description here. - formatted_price (str): TODO: type description here. - price_id (int): TODO: type description here. - price_point_id (int): TODO: type description here. - product_price_point_id (int): TODO: type description here. + id (int): The model property of type int. + currency (str): The model property of type str. + price (float): The model property of type float. + formatted_price (str): The model property of type str. + price_id (int): The model property of type int. + price_point_id (int): The model property of type int. + product_price_point_id (int): The model property of type int. role (CurrencyPriceRole): Role for the price. additional_properties (Dict[str, object]): The additional properties for the model. @@ -126,3 +124,27 @@ def from_dictionary(cls, product_price_point_id, role, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'currency={self.currency!r}, ' + f'price={self.price!r}, ' + f'formatted_price={self.formatted_price!r}, ' + f'price_id={self.price_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'role={self.role!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'currency={self.currency!s}, ' + f'price={self.price!s}, ' + f'formatted_price={self.formatted_price!s}, ' + f'price_id={self.price_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'role={self.role!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/currency_price_role.py b/advancedbilling/models/currency_price_role.py index 863f821b..2adf8d54 100644 --- a/advancedbilling/models/currency_price_role.py +++ b/advancedbilling/models/currency_price_role.py @@ -15,9 +15,9 @@ class CurrencyPriceRole(object): Role for the price. Attributes: - BASELINE: TODO: type description here. - TRIAL: TODO: type description here. - INITIAL: TODO: type description here. + BASELINE: The enum member of type str. + TRIAL: The enum member of type str. + INITIAL: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/currency_prices_response.py b/advancedbilling/models/currency_prices_response.py index 79af81be..c20eaa2c 100644 --- a/advancedbilling/models/currency_prices_response.py +++ b/advancedbilling/models/currency_prices_response.py @@ -13,10 +13,9 @@ class CurrencyPricesResponse(object): """Implementation of the 'Currency Prices Response' model. - TODO: type model description here. - Attributes: - currency_prices (List[CurrencyPrice]): TODO: type description here. + currency_prices (List[CurrencyPrice]): The model property of type + List[CurrencyPrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -67,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(currency_prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/custom_field_owner.py b/advancedbilling/models/custom_field_owner.py index 99f51512..ef8fd65c 100644 --- a/advancedbilling/models/custom_field_owner.py +++ b/advancedbilling/models/custom_field_owner.py @@ -12,11 +12,9 @@ class CustomFieldOwner(object): """Implementation of the 'Custom Field Owner' enum. - TODO: type enum description here. - Attributes: - CUSTOMER: TODO: type description here. - SUBSCRIPTION: TODO: type description here. + CUSTOMER: The enum member of type str. + SUBSCRIPTION: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/custom_field_value_change.py b/advancedbilling/models/custom_field_value_change.py index 1aa849c8..bbc55eec 100644 --- a/advancedbilling/models/custom_field_value_change.py +++ b/advancedbilling/models/custom_field_value_change.py @@ -13,16 +13,14 @@ class CustomFieldValueChange(object): """Implementation of the 'Custom Field Value Change' model. - TODO: type model description here. - Attributes: - event_type (str): TODO: type description here. - metafield_name (str): TODO: type description here. - metafield_id (int): TODO: type description here. - old_value (str): TODO: type description here. - new_value (str): TODO: type description here. - resource_type (str): TODO: type description here. - resource_id (int): TODO: type description here. + event_type (str): The model property of type str. + metafield_name (str): The model property of type str. + metafield_id (int): The model property of type int. + old_value (str): The model property of type str. + new_value (str): The model property of type str. + resource_type (str): The model property of type str. + resource_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -158,3 +156,25 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('resource_id'), type_callable=lambda value: isinstance(value, int)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'event_type={self.event_type!r}, ' + f'metafield_name={self.metafield_name!r}, ' + f'metafield_id={self.metafield_id!r}, ' + f'old_value={self.old_value!r}, ' + f'new_value={self.new_value!r}, ' + f'resource_type={self.resource_type!r}, ' + f'resource_id={self.resource_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'event_type={self.event_type!s}, ' + f'metafield_name={self.metafield_name!s}, ' + f'metafield_id={self.metafield_id!s}, ' + f'old_value={self.old_value!s}, ' + f'new_value={self.new_value!s}, ' + f'resource_type={self.resource_type!s}, ' + f'resource_id={self.resource_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/customer.py b/advancedbilling/models/customer.py index 62b031c3..0c3eb938 100644 --- a/advancedbilling/models/customer.py +++ b/advancedbilling/models/customer.py @@ -13,8 +13,6 @@ class Customer(object): """Implementation of the 'Customer' model. - TODO: type model description here. - Attributes: first_name (str): The first name of the customer last_name (str): The last name of the customer @@ -62,7 +60,7 @@ class Customer(object): parent_id (int): The parent ID in Chargify if applicable. Parent is another Customer object. locale (str): The locale for the customer to identify language-region - default_subscription_group_uid (str): TODO: type description here. + default_subscription_group_uid (str): The model property of type str. salesforce_id (str): The Salesforce ID for the customer tax_exempt_reason (str): The Tax Exemption Reason Code for the customer default_auto_renewal_profile_id (int): The default auto-renewal @@ -380,3 +378,71 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'email={self.email!r}, ' + f'cc_emails={self.cc_emails!r}, ' + f'organization={self.organization!r}, ' + f'reference={self.reference!r}, ' + f'id={self.id!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'address={self.address!r}, ' + f'address_2={self.address_2!r}, ' + f'city={self.city!r}, ' + f'state={self.state!r}, ' + f'state_name={self.state_name!r}, ' + f'zip={self.zip!r}, ' + f'country={self.country!r}, ' + f'country_name={self.country_name!r}, ' + f'phone={self.phone!r}, ' + f'verified={self.verified!r}, ' + f'portal_customer_created_at={self.portal_customer_created_at!r}, ' + f'portal_invite_last_sent_at={self.portal_invite_last_sent_at!r}, ' + f'portal_invite_last_accepted_at={self.portal_invite_last_accepted_at!r}, ' + f'tax_exempt={self.tax_exempt!r}, ' + f'vat_number={self.vat_number!r}, ' + f'parent_id={self.parent_id!r}, ' + f'locale={self.locale!r}, ' + f'default_subscription_group_uid={self.default_subscription_group_uid!r}, ' + f'salesforce_id={self.salesforce_id!r}, ' + f'tax_exempt_reason={self.tax_exempt_reason!r}, ' + f'default_auto_renewal_profile_id={self.default_auto_renewal_profile_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'email={self.email!s}, ' + f'cc_emails={self.cc_emails!s}, ' + f'organization={self.organization!s}, ' + f'reference={self.reference!s}, ' + f'id={self.id!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'address={self.address!s}, ' + f'address_2={self.address_2!s}, ' + f'city={self.city!s}, ' + f'state={self.state!s}, ' + f'state_name={self.state_name!s}, ' + f'zip={self.zip!s}, ' + f'country={self.country!s}, ' + f'country_name={self.country_name!s}, ' + f'phone={self.phone!s}, ' + f'verified={self.verified!s}, ' + f'portal_customer_created_at={self.portal_customer_created_at!s}, ' + f'portal_invite_last_sent_at={self.portal_invite_last_sent_at!s}, ' + f'portal_invite_last_accepted_at={self.portal_invite_last_accepted_at!s}, ' + f'tax_exempt={self.tax_exempt!s}, ' + f'vat_number={self.vat_number!s}, ' + f'parent_id={self.parent_id!s}, ' + f'locale={self.locale!s}, ' + f'default_subscription_group_uid={self.default_subscription_group_uid!s}, ' + f'salesforce_id={self.salesforce_id!s}, ' + f'tax_exempt_reason={self.tax_exempt_reason!s}, ' + f'default_auto_renewal_profile_id={self.default_auto_renewal_profile_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/customer_attributes.py b/advancedbilling/models/customer_attributes.py index 2e6ab43c..6778c1cc 100644 --- a/advancedbilling/models/customer_attributes.py +++ b/advancedbilling/models/customer_attributes.py @@ -13,8 +13,6 @@ class CustomerAttributes(object): """Implementation of the 'Customer Attributes' model. - TODO: type model description here. - Attributes: first_name (str): The first name of the customer. Required when creating a customer via attributes. @@ -46,7 +44,7 @@ class CustomerAttributes(object): alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format (i.e. “US”). phone (str): (Optional) The phone number of the customer. - verified (bool): TODO: type description here. + verified (bool): The model property of type bool. tax_exempt (bool): (Optional) The tax_exempt status of the customer. Acceptable values are true or 1 for true and false or 0 for false. vat_number (str): (Optional) Supplying the VAT number allows EU @@ -279,3 +277,51 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'email={self.email!r}, ' + f'cc_emails={self.cc_emails!r}, ' + f'organization={self.organization!r}, ' + f'reference={self.reference!r}, ' + f'address={self.address!r}, ' + f'address_2={self.address_2!r}, ' + f'city={self.city!r}, ' + f'state={self.state!r}, ' + f'zip={self.zip!r}, ' + f'country={self.country!r}, ' + f'phone={self.phone!r}, ' + f'verified={self.verified!r}, ' + f'tax_exempt={self.tax_exempt!r}, ' + f'vat_number={self.vat_number!r}, ' + f'metafields={self.metafields!r}, ' + f'parent_id={self.parent_id!r}, ' + f'salesforce_id={self.salesforce_id!r}, ' + f'default_auto_renewal_profile_id={self.default_auto_renewal_profile_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'email={self.email!s}, ' + f'cc_emails={self.cc_emails!s}, ' + f'organization={self.organization!s}, ' + f'reference={self.reference!s}, ' + f'address={self.address!s}, ' + f'address_2={self.address_2!s}, ' + f'city={self.city!s}, ' + f'state={self.state!s}, ' + f'zip={self.zip!s}, ' + f'country={self.country!s}, ' + f'phone={self.phone!s}, ' + f'verified={self.verified!s}, ' + f'tax_exempt={self.tax_exempt!s}, ' + f'vat_number={self.vat_number!s}, ' + f'metafields={self.metafields!s}, ' + f'parent_id={self.parent_id!s}, ' + f'salesforce_id={self.salesforce_id!s}, ' + f'default_auto_renewal_profile_id={self.default_auto_renewal_profile_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/customer_change.py b/advancedbilling/models/customer_change.py index c5e8655a..1ee8827a 100644 --- a/advancedbilling/models/customer_change.py +++ b/advancedbilling/models/customer_change.py @@ -16,14 +16,15 @@ class CustomerChange(object): """Implementation of the 'Customer Change' model. - TODO: type model description here. - Attributes: - payer (CustomerPayerChange): TODO: type description here. - shipping_address (AddressChange): TODO: type description here. - billing_address (AddressChange): TODO: type description here. - custom_fields (CustomerCustomFieldsChange): TODO: type description - here. + payer (CustomerPayerChange): The model property of type + CustomerPayerChange. + shipping_address (AddressChange): The model property of type + AddressChange. + billing_address (AddressChange): The model property of type + AddressChange. + custom_fields (CustomerCustomFieldsChange): The model property of type + CustomerCustomFieldsChange. additional_properties (Dict[str, object]): The additional properties for the model. @@ -117,3 +118,19 @@ def from_dictionary(cls, billing_address, custom_fields, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payer={self.payer!r}, ' + f'shipping_address={self.shipping_address!r}, ' + f'billing_address={self.billing_address!r}, ' + f'custom_fields={self.custom_fields!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payer={self.payer!s}, ' + f'shipping_address={self.shipping_address!s}, ' + f'billing_address={self.billing_address!s}, ' + f'custom_fields={self.custom_fields!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/customer_changes_preview_response.py b/advancedbilling/models/customer_changes_preview_response.py index 1746b798..597f2794 100644 --- a/advancedbilling/models/customer_changes_preview_response.py +++ b/advancedbilling/models/customer_changes_preview_response.py @@ -13,10 +13,8 @@ class CustomerChangesPreviewResponse(object): """Implementation of the 'Customer Changes Preview Response' model. - TODO: type model description here. - Attributes: - changes (CustomerChange): TODO: type description here. + changes (CustomerChange): The model property of type CustomerChange. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(changes, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'changes={self.changes!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'changes={self.changes!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/customer_custom_fields_change.py b/advancedbilling/models/customer_custom_fields_change.py index 307459b4..2ea18df9 100644 --- a/advancedbilling/models/customer_custom_fields_change.py +++ b/advancedbilling/models/customer_custom_fields_change.py @@ -13,11 +13,11 @@ class CustomerCustomFieldsChange(object): """Implementation of the 'Customer Custom Fields Change' model. - TODO: type model description here. - Attributes: - before (List[InvoiceCustomField]): TODO: type description here. - after (List[InvoiceCustomField]): TODO: type description here. + before (List[InvoiceCustomField]): The model property of type + List[InvoiceCustomField]. + after (List[InvoiceCustomField]): The model property of type + List[InvoiceCustomField]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -75,3 +75,15 @@ def from_dictionary(cls, return cls(before, after, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'before={self.before!r}, ' + f'after={self.after!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'before={self.before!s}, ' + f'after={self.after!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/customer_error.py b/advancedbilling/models/customer_error.py index 4374e0ab..b5d24e5f 100644 --- a/advancedbilling/models/customer_error.py +++ b/advancedbilling/models/customer_error.py @@ -13,10 +13,8 @@ class CustomerError(object): """Implementation of the 'Customer Error' model. - TODO: type model description here. - Attributes: - customer (str): TODO: type description here. + customer (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -92,3 +90,13 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'customer={self.customer!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'customer={self.customer!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/customer_payer_change.py b/advancedbilling/models/customer_payer_change.py index 073b83ea..ffe66e04 100644 --- a/advancedbilling/models/customer_payer_change.py +++ b/advancedbilling/models/customer_payer_change.py @@ -13,11 +13,11 @@ class CustomerPayerChange(object): """Implementation of the 'Customer Payer Change' model. - TODO: type model description here. - Attributes: - before (InvoicePayerChange): TODO: type description here. - after (InvoicePayerChange): TODO: type description here. + before (InvoicePayerChange): The model property of type + InvoicePayerChange. + after (InvoicePayerChange): The model property of type + InvoicePayerChange. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +71,15 @@ def from_dictionary(cls, return cls(before, after, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'before={self.before!r}, ' + f'after={self.after!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'before={self.before!s}, ' + f'after={self.after!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/customer_response.py b/advancedbilling/models/customer_response.py index 3a9bdd0f..15a73b8c 100644 --- a/advancedbilling/models/customer_response.py +++ b/advancedbilling/models/customer_response.py @@ -13,10 +13,8 @@ class CustomerResponse(object): """Implementation of the 'Customer Response' model. - TODO: type model description here. - Attributes: - customer (Customer): TODO: type description here. + customer (Customer): The model property of type Customer. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(customer, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'customer={self.customer!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'customer={self.customer!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/debit_note.py b/advancedbilling/models/debit_note.py index c18d084a..5676b4d2 100644 --- a/advancedbilling/models/debit_note.py +++ b/advancedbilling/models/debit_note.py @@ -22,8 +22,6 @@ class DebitNote(object): """Implementation of the 'Debit Note' model. - TODO: type model description here. - Attributes: uid (str): Unique identifier for the debit note. It is generated automatically by Chargify and has the prefix "db_" followed by @@ -68,9 +66,11 @@ class DebitNote(object): shipping_address (InvoiceAddress): The shipping address of the debited subscription. line_items (List[CreditNoteLineItem]): Line items on the debit note. - discounts (List[InvoiceDiscount]): TODO: type description here. - taxes (List[InvoiceTax]): TODO: type description here. - refunds (List[InvoiceRefund]): TODO: type description here. + discounts (List[InvoiceDiscount]): The model property of type + List[InvoiceDiscount]. + taxes (List[InvoiceTax]): The model property of type List[InvoiceTax]. + refunds (List[InvoiceRefund]): The model property of type + List[InvoiceRefund]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -316,3 +316,57 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'site_id={self.site_id!r}, ' + f'customer_id={self.customer_id!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'number={self.number!r}, ' + f'sequence_number={self.sequence_number!r}, ' + f'origin_credit_note_uid={self.origin_credit_note_uid!r}, ' + f'origin_credit_note_number={self.origin_credit_note_number!r}, ' + f'issue_date={self.issue_date!r}, ' + f'applied_date={self.applied_date!r}, ' + f'due_date={self.due_date!r}, ' + f'status={self.status!r}, ' + f'memo={self.memo!r}, ' + f'role={self.role!r}, ' + f'currency={self.currency!r}, ' + f'seller={self.seller!r}, ' + f'customer={self.customer!r}, ' + f'billing_address={self.billing_address!r}, ' + f'shipping_address={self.shipping_address!r}, ' + f'line_items={self.line_items!r}, ' + f'discounts={self.discounts!r}, ' + f'taxes={self.taxes!r}, ' + f'refunds={self.refunds!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'site_id={self.site_id!s}, ' + f'customer_id={self.customer_id!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'number={self.number!s}, ' + f'sequence_number={self.sequence_number!s}, ' + f'origin_credit_note_uid={self.origin_credit_note_uid!s}, ' + f'origin_credit_note_number={self.origin_credit_note_number!s}, ' + f'issue_date={self.issue_date!s}, ' + f'applied_date={self.applied_date!s}, ' + f'due_date={self.due_date!s}, ' + f'status={self.status!s}, ' + f'memo={self.memo!s}, ' + f'role={self.role!s}, ' + f'currency={self.currency!s}, ' + f'seller={self.seller!s}, ' + f'customer={self.customer!s}, ' + f'billing_address={self.billing_address!s}, ' + f'shipping_address={self.shipping_address!s}, ' + f'line_items={self.line_items!s}, ' + f'discounts={self.discounts!s}, ' + f'taxes={self.taxes!s}, ' + f'refunds={self.refunds!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/debit_note_role.py b/advancedbilling/models/debit_note_role.py index 45c85e22..28fbe5a9 100644 --- a/advancedbilling/models/debit_note_role.py +++ b/advancedbilling/models/debit_note_role.py @@ -15,8 +15,8 @@ class DebitNoteRole(object): The role of the debit note. Attributes: - CHARGEBACK: TODO: type description here. - REFUND: TODO: type description here. + CHARGEBACK: The enum member of type str. + REFUND: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/debit_note_status.py b/advancedbilling/models/debit_note_status.py index ec63cb97..0e4e033b 100644 --- a/advancedbilling/models/debit_note_status.py +++ b/advancedbilling/models/debit_note_status.py @@ -15,10 +15,10 @@ class DebitNoteStatus(object): Current status of the debit note. Attributes: - OPEN: TODO: type description here. - APPLIED: TODO: type description here. - BANISHED: TODO: type description here. - PAID: TODO: type description here. + OPEN: The enum member of type str. + APPLIED: The enum member of type str. + BANISHED: The enum member of type str. + PAID: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/deduct_service_credit.py b/advancedbilling/models/deduct_service_credit.py index c644eeb9..2220d877 100644 --- a/advancedbilling/models/deduct_service_credit.py +++ b/advancedbilling/models/deduct_service_credit.py @@ -13,11 +13,9 @@ class DeductServiceCredit(object): """Implementation of the 'Deduct Service Credit' model. - TODO: type model description here. - Attributes: - amount (str | float): TODO: type description here. - memo (str): TODO: type description here. + amount (str | float): The model property of type str | float. + memo (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -100,3 +98,15 @@ def validate(cls, dictionary): return False return UnionTypeLookUp.get('DeductServiceCreditAmount').validate(dictionary.get('amount')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!r}, ' + f'memo={self.memo!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!s}, ' + f'memo={self.memo!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/deduct_service_credit_request.py b/advancedbilling/models/deduct_service_credit_request.py index 008a2ec5..35b99803 100644 --- a/advancedbilling/models/deduct_service_credit_request.py +++ b/advancedbilling/models/deduct_service_credit_request.py @@ -13,10 +13,9 @@ class DeductServiceCreditRequest(object): """Implementation of the 'Deduct Service Credit Request' model. - TODO: type model description here. - Attributes: - deduction (DeductServiceCredit): TODO: type description here. + deduction (DeductServiceCredit): The model property of type + DeductServiceCredit. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(deduction, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'deduction={self.deduction!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'deduction={self.deduction!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/delayed_cancellation_response.py b/advancedbilling/models/delayed_cancellation_response.py index c0d6d6bd..5a22ed0a 100644 --- a/advancedbilling/models/delayed_cancellation_response.py +++ b/advancedbilling/models/delayed_cancellation_response.py @@ -13,10 +13,8 @@ class DelayedCancellationResponse(object): """Implementation of the 'Delayed Cancellation Response' model. - TODO: type model description here. - Attributes: - message (str): TODO: type description here. + message (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(message, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'message={self.message!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'message={self.message!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/delete_subscription_group_response.py b/advancedbilling/models/delete_subscription_group_response.py index d49e90cd..e6865db9 100644 --- a/advancedbilling/models/delete_subscription_group_response.py +++ b/advancedbilling/models/delete_subscription_group_response.py @@ -13,11 +13,9 @@ class DeleteSubscriptionGroupResponse(object): """Implementation of the 'Delete Subscription Group Response' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - deleted (bool): TODO: type description here. + uid (str): The model property of type str. + deleted (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -78,3 +76,15 @@ def from_dictionary(cls, return cls(uid, deleted, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'deleted={self.deleted!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'deleted={self.deleted!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/direction.py b/advancedbilling/models/direction.py index 8bd30e4b..89107e2f 100644 --- a/advancedbilling/models/direction.py +++ b/advancedbilling/models/direction.py @@ -12,11 +12,9 @@ class Direction(object): """Implementation of the 'direction' enum. - TODO: type enum description here. - Attributes: - ASC: TODO: type description here. - DESC: TODO: type description here. + ASC: The enum member of type str. + DESC: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/discount_type.py b/advancedbilling/models/discount_type.py index 1027b75f..49d8084a 100644 --- a/advancedbilling/models/discount_type.py +++ b/advancedbilling/models/discount_type.py @@ -12,11 +12,9 @@ class DiscountType(object): """Implementation of the 'Discount Type' enum. - TODO: type enum description here. - Attributes: - AMOUNT: TODO: type description here. - PERCENT: TODO: type description here. + AMOUNT: The enum member of type str. + PERCENT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/dunner_data.py b/advancedbilling/models/dunner_data.py index 318a9f43..8ca201b5 100644 --- a/advancedbilling/models/dunner_data.py +++ b/advancedbilling/models/dunner_data.py @@ -13,15 +13,13 @@ class DunnerData(object): """Implementation of the 'Dunner Data' model. - TODO: type model description here. - Attributes: - state (str): TODO: type description here. - subscription_id (int): TODO: type description here. - revenue_at_risk_in_cents (long|int): TODO: type description here. - created_at (datetime): TODO: type description here. - attempts (int): TODO: type description here. - last_attempted_at (datetime): TODO: type description here. + state (str): The model property of type str. + subscription_id (int): The model property of type int. + revenue_at_risk_in_cents (int): The model property of type int. + created_at (datetime): The model property of type datetime. + attempts (int): The model property of type int. + last_attempted_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -139,3 +137,23 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, int)) \ and APIHelper.is_valid_type(value=dictionary.get('last_attempted_at'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'state={self.state!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'revenue_at_risk_in_cents={self.revenue_at_risk_in_cents!r}, ' + f'created_at={self.created_at!r}, ' + f'attempts={self.attempts!r}, ' + f'last_attempted_at={self.last_attempted_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'state={self.state!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'revenue_at_risk_in_cents={self.revenue_at_risk_in_cents!s}, ' + f'created_at={self.created_at!s}, ' + f'attempts={self.attempts!s}, ' + f'last_attempted_at={self.last_attempted_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/dunning_step_data.py b/advancedbilling/models/dunning_step_data.py index 7000154d..361be180 100644 --- a/advancedbilling/models/dunning_step_data.py +++ b/advancedbilling/models/dunning_step_data.py @@ -13,17 +13,15 @@ class DunningStepData(object): """Implementation of the 'Dunning Step Data' model. - TODO: type model description here. - Attributes: - day_threshold (int): TODO: type description here. - action (str): TODO: type description here. - email_body (str): TODO: type description here. - email_subject (str): TODO: type description here. - send_email (bool): TODO: type description here. - send_bcc_email (bool): TODO: type description here. - send_sms (bool): TODO: type description here. - sms_body (str): TODO: type description here. + day_threshold (int): The model property of type int. + action (str): The model property of type str. + email_body (str): The model property of type str. + email_subject (str): The model property of type str. + send_email (bool): The model property of type bool. + send_bcc_email (bool): The model property of type bool. + send_sms (bool): The model property of type bool. + sms_body (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -162,3 +160,27 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, bool)) \ and APIHelper.is_valid_type(value=dictionary.get('send_sms'), type_callable=lambda value: isinstance(value, bool)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'day_threshold={self.day_threshold!r}, ' + f'action={self.action!r}, ' + f'email_body={self.email_body!r}, ' + f'email_subject={self.email_subject!r}, ' + f'send_email={self.send_email!r}, ' + f'send_bcc_email={self.send_bcc_email!r}, ' + f'send_sms={self.send_sms!r}, ' + f'sms_body={self.sms_body!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'day_threshold={self.day_threshold!s}, ' + f'action={self.action!s}, ' + f'email_body={self.email_body!s}, ' + f'email_subject={self.email_subject!s}, ' + f'send_email={self.send_email!s}, ' + f'send_bcc_email={self.send_bcc_email!s}, ' + f'send_sms={self.send_sms!s}, ' + f'sms_body={self.sms_body!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/dunning_step_reached.py b/advancedbilling/models/dunning_step_reached.py index 38222486..189cf76a 100644 --- a/advancedbilling/models/dunning_step_reached.py +++ b/advancedbilling/models/dunning_step_reached.py @@ -15,12 +15,12 @@ class DunningStepReached(object): """Implementation of the 'Dunning Step Reached' model. - TODO: type model description here. - Attributes: - dunner (DunnerData): TODO: type description here. - current_step (DunningStepData): TODO: type description here. - next_step (DunningStepData): TODO: type description here. + dunner (DunnerData): The model property of type DunnerData. + current_step (DunningStepData): The model property of type + DunningStepData. + next_step (DunningStepData): The model property of type + DunningStepData. additional_properties (Dict[str, object]): The additional properties for the model. @@ -117,3 +117,17 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('next_step'), type_callable=lambda value: DunningStepData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'dunner={self.dunner!r}, ' + f'current_step={self.current_step!r}, ' + f'next_step={self.next_step!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'dunner={self.dunner!s}, ' + f'current_step={self.current_step!s}, ' + f'next_step={self.next_step!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/ebb_component.py b/advancedbilling/models/ebb_component.py index 016d4d2f..7822d5eb 100644 --- a/advancedbilling/models/ebb_component.py +++ b/advancedbilling/models/ebb_component.py @@ -15,8 +15,6 @@ class EBBComponent(object): """Implementation of the 'EBB Component' model. - TODO: type model description here. - Attributes: name (str): A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes". @@ -41,8 +39,8 @@ class EBBComponent(object): Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-C omponent-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. - price_points (List[ComponentPricePointItem]): TODO: type description - here. + price_points (List[ComponentPricePointItem]): The model property of + type List[ComponentPricePointItem]. unit_price (str | float | None): The amount the customer will be charged per unit when the pricing scheme is “per_unit”. The price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or @@ -213,3 +211,39 @@ def from_dictionary(cls, interval, interval_unit, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'unit_name={self.unit_name!r}, ' + f'description={self.description!r}, ' + f'handle={self.handle!r}, ' + f'taxable={self.taxable!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'price_points={self.price_points!r}, ' + f'unit_price={self.unit_price!r}, ' + f'tax_code={self.tax_code!r}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!r}, ' + f'event_based_billing_metric_id={self.event_based_billing_metric_id!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'unit_name={self.unit_name!s}, ' + f'description={self.description!s}, ' + f'handle={self.handle!s}, ' + f'taxable={self.taxable!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'price_points={self.price_points!s}, ' + f'unit_price={self.unit_price!s}, ' + f'tax_code={self.tax_code!s}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!s}, ' + f'event_based_billing_metric_id={self.event_based_billing_metric_id!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/ebb_event.py b/advancedbilling/models/ebb_event.py index 172ded93..a7deb321 100644 --- a/advancedbilling/models/ebb_event.py +++ b/advancedbilling/models/ebb_event.py @@ -14,10 +14,8 @@ class EBBEvent(object): """Implementation of the 'EBB Event' model. - TODO: type model description here. - Attributes: - chargify (ChargifyEBB): TODO: type description here. + chargify (ChargifyEBB): The model property of type ChargifyEBB. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(chargify, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'chargify={self.chargify!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'chargify={self.chargify!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/enable_webhooks_request.py b/advancedbilling/models/enable_webhooks_request.py index 7c5dfce6..afcacbcb 100644 --- a/advancedbilling/models/enable_webhooks_request.py +++ b/advancedbilling/models/enable_webhooks_request.py @@ -12,10 +12,8 @@ class EnableWebhooksRequest(object): """Implementation of the 'Enable Webhooks Request' model. - TODO: type model description here. - Attributes: - webhooks_enabled (bool): TODO: type description here. + webhooks_enabled (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -64,3 +62,13 @@ def from_dictionary(cls, # Return an object of this model return cls(webhooks_enabled, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'webhooks_enabled={self.webhooks_enabled!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'webhooks_enabled={self.webhooks_enabled!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/enable_webhooks_response.py b/advancedbilling/models/enable_webhooks_response.py index d1b43e75..7242b1f7 100644 --- a/advancedbilling/models/enable_webhooks_response.py +++ b/advancedbilling/models/enable_webhooks_response.py @@ -13,10 +13,8 @@ class EnableWebhooksResponse(object): """Implementation of the 'Enable Webhooks Response' model. - TODO: type model description here. - Attributes: - webhooks_enabled (bool): TODO: type description here. + webhooks_enabled (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(webhooks_enabled, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'webhooks_enabled={self.webhooks_enabled!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'webhooks_enabled={self.webhooks_enabled!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/endpoint.py b/advancedbilling/models/endpoint.py index c2ff2ad9..109d3533 100644 --- a/advancedbilling/models/endpoint.py +++ b/advancedbilling/models/endpoint.py @@ -13,14 +13,13 @@ class Endpoint(object): """Implementation of the 'Endpoint' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - url (str): TODO: type description here. - site_id (int): TODO: type description here. - status (str): TODO: type description here. - webhook_subscriptions (List[str]): TODO: type description here. + id (int): The model property of type int. + url (str): The model property of type str. + site_id (int): The model property of type int. + status (str): The model property of type str. + webhook_subscriptions (List[str]): The model property of type + List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -102,3 +101,21 @@ def from_dictionary(cls, status, webhook_subscriptions, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'url={self.url!r}, ' + f'site_id={self.site_id!r}, ' + f'status={self.status!r}, ' + f'webhook_subscriptions={self.webhook_subscriptions!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'url={self.url!s}, ' + f'site_id={self.site_id!s}, ' + f'status={self.status!s}, ' + f'webhook_subscriptions={self.webhook_subscriptions!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/endpoint_response.py b/advancedbilling/models/endpoint_response.py index f0665e7a..b3a8de40 100644 --- a/advancedbilling/models/endpoint_response.py +++ b/advancedbilling/models/endpoint_response.py @@ -14,10 +14,8 @@ class EndpointResponse(object): """Implementation of the 'Endpoint Response' model. - TODO: type model description here. - Attributes: - endpoint (Endpoint): TODO: type description here. + endpoint (Endpoint): The model property of type Endpoint. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(endpoint, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'endpoint={self.endpoint!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'endpoint={self.endpoint!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/errors.py b/advancedbilling/models/errors.py index 2afc6947..449617e7 100644 --- a/advancedbilling/models/errors.py +++ b/advancedbilling/models/errors.py @@ -13,11 +13,9 @@ class Errors(object): """Implementation of the 'Errors' model. - TODO: type model description here. - Attributes: - per_page (List[str]): TODO: type description here. - price_point (List[str]): TODO: type description here. + per_page (List[str]): The model property of type List[str]. + price_point (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -78,3 +76,15 @@ def from_dictionary(cls, return cls(per_page, price_point, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'per_page={self.per_page!r}, ' + f'price_point={self.price_point!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'per_page={self.per_page!s}, ' + f'price_point={self.price_point!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/event.py b/advancedbilling/models/event.py index 302dea5d..ab6c1d1e 100644 --- a/advancedbilling/models/event.py +++ b/advancedbilling/models/event.py @@ -14,15 +14,13 @@ class Event(object): """Implementation of the 'Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - key (EventKey): TODO: type description here. - message (str): TODO: type description here. - subscription_id (int): TODO: type description here. - customer_id (int): TODO: type description here. - created_at (datetime): TODO: type description here. + id (int): The model property of type int. + key (EventKey): The model property of type EventKey. + message (str): The model property of type str. + subscription_id (int): The model property of type int. + customer_id (int): The model property of type int. + created_at (datetime): The model property of type datetime. event_specific_data (SubscriptionProductChange | SubscriptionStateChange | PaymentRelatedEvents | RefundSuccess | ComponentAllocationChange | MeteredUsage | PrepaidUsage | @@ -228,3 +226,25 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('created_at'), type_callable=lambda value: isinstance(value, str)) \ and UnionTypeLookUp.get('EventEventSpecificData').validate(dictionary.get('event_specific_data')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'key={self.key!r}, ' + f'message={self.message!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'customer_id={self.customer_id!r}, ' + f'created_at={self.created_at!r}, ' + f'event_specific_data={self.event_specific_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'key={self.key!s}, ' + f'message={self.message!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'customer_id={self.customer_id!s}, ' + f'created_at={self.created_at!s}, ' + f'event_specific_data={self.event_specific_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/event_based_billing_segment_error.py b/advancedbilling/models/event_based_billing_segment_error.py index 43425372..96135638 100644 --- a/advancedbilling/models/event_based_billing_segment_error.py +++ b/advancedbilling/models/event_based_billing_segment_error.py @@ -12,8 +12,6 @@ class EventBasedBillingSegmentError(object): """Implementation of the 'Event Based Billing Segment Error' model. - TODO: type model description here. - Attributes: segments (Dict[str, object]): The key of the object would be a number (an index in the request array) where the error occurred. In the @@ -68,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(segments, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'segments={self.segments!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'segments={self.segments!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/event_key.py b/advancedbilling/models/event_key.py index daff8643..50531755 100644 --- a/advancedbilling/models/event_key.py +++ b/advancedbilling/models/event_key.py @@ -12,94 +12,92 @@ class EventKey(object): """Implementation of the 'Event Key' enum. - TODO: type enum description here. - Attributes: - PAYMENT_SUCCESS: TODO: type description here. - PAYMENT_FAILURE: TODO: type description here. - SIGNUP_SUCCESS: TODO: type description here. - SIGNUP_FAILURE: TODO: type description here. - DELAYED_SIGNUP_CREATION_SUCCESS: TODO: type description here. - DELAYED_SIGNUP_CREATION_FAILURE: TODO: type description here. - BILLING_DATE_CHANGE: TODO: type description here. - EXPIRATION_DATE_CHANGE: TODO: type description here. - RENEWAL_SUCCESS: TODO: type description here. - RENEWAL_FAILURE: TODO: type description here. - SUBSCRIPTION_STATE_CHANGE: TODO: type description here. - SUBSCRIPTION_PRODUCT_CHANGE: TODO: type description here. - PENDING_CANCELLATION_CHANGE: TODO: type description here. - EXPIRING_CARD: TODO: type description here. - CUSTOMER_UPDATE: TODO: type description here. - CUSTOMER_CREATE: TODO: type description here. - CUSTOMER_DELETE: TODO: type description here. - COMPONENT_ALLOCATION_CHANGE: TODO: type description here. - METERED_USAGE: TODO: type description here. - PREPAID_USAGE: TODO: type description here. - UPGRADE_DOWNGRADE_SUCCESS: TODO: type description here. - UPGRADE_DOWNGRADE_FAILURE: TODO: type description here. - STATEMENT_CLOSED: TODO: type description here. - STATEMENT_SETTLED: TODO: type description here. - SUBSCRIPTION_CARD_UPDATE: TODO: type description here. - SUBSCRIPTION_GROUP_CARD_UPDATE: TODO: type description here. - SUBSCRIPTION_BANK_ACCOUNT_UPDATE: TODO: type description here. - REFUND_SUCCESS: TODO: type description here. - REFUND_FAILURE: TODO: type description here. - UPCOMING_RENEWAL_NOTICE: TODO: type description here. - TRIAL_END_NOTICE: TODO: type description here. - DUNNING_STEP_REACHED: TODO: type description here. - INVOICE_ISSUED: TODO: type description here. - PREPAID_SUBSCRIPTION_BALANCE_CHANGED: TODO: type description here. - SUBSCRIPTION_GROUP_SIGNUP_SUCCESS: TODO: type description here. - SUBSCRIPTION_GROUP_SIGNUP_FAILURE: TODO: type description here. - DIRECT_DEBIT_PAYMENT_PAID_OUT: TODO: type description here. - DIRECT_DEBIT_PAYMENT_REJECTED: TODO: type description here. - DIRECT_DEBIT_PAYMENT_PENDING: TODO: type description here. - PENDING_PAYMENT_CREATED: TODO: type description here. - PENDING_PAYMENT_FAILED: TODO: type description here. - PENDING_PAYMENT_COMPLETED: TODO: type description here. - PROFORMA_INVOICE_ISSUED: TODO: type description here. - SUBSCRIPTION_PREPAYMENT_ACCOUNT_BALANCE_CHANGED: TODO: type - description here. - SUBSCRIPTION_SERVICE_CREDIT_ACCOUNT_BALANCE_CHANGED: TODO: type - description here. - CUSTOM_FIELD_VALUE_CHANGE: TODO: type description here. - ITEM_PRICE_POINT_CHANGED: TODO: type description here. - RENEWAL_SUCCESS_RECREATED: TODO: type description here. - RENEWAL_FAILURE_RECREATED: TODO: type description here. - PAYMENT_SUCCESS_RECREATED: TODO: type description here. - PAYMENT_FAILURE_RECREATED: TODO: type description here. - SUBSCRIPTION_DELETION: TODO: type description here. - SUBSCRIPTION_GROUP_BANK_ACCOUNT_UPDATE: TODO: type description here. - SUBSCRIPTION_PAYPAL_ACCOUNT_UPDATE: TODO: type description here. - SUBSCRIPTION_GROUP_PAYPAL_ACCOUNT_UPDATE: TODO: type description here. - SUBSCRIPTION_CUSTOMER_CHANGE: TODO: type description here. - ACCOUNT_TRANSACTION_CHANGED: TODO: type description here. - GO_CARDLESS_PAYMENT_PAID_OUT: TODO: type description here. - GO_CARDLESS_PAYMENT_REJECTED: TODO: type description here. - GO_CARDLESS_PAYMENT_PENDING: TODO: type description here. - STRIPE_DIRECT_DEBIT_PAYMENT_PAID_OUT: TODO: type description here. - STRIPE_DIRECT_DEBIT_PAYMENT_REJECTED: TODO: type description here. - STRIPE_DIRECT_DEBIT_PAYMENT_PENDING: TODO: type description here. - MAXIO_PAYMENTS_DIRECT_DEBIT_PAYMENT_PAID_OUT: TODO: type description - here. - MAXIO_PAYMENTS_DIRECT_DEBIT_PAYMENT_REJECTED: TODO: type description - here. - MAXIO_PAYMENTS_DIRECT_DEBIT_PAYMENT_PENDING: TODO: type description - here. - INVOICE_IN_COLLECTIONS_CANCELED: TODO: type description here. - SUBSCRIPTION_ADDED_TO_GROUP: TODO: type description here. - SUBSCRIPTION_REMOVED_FROM_GROUP: TODO: type description here. - CHARGEBACK_OPENED: TODO: type description here. - CHARGEBACK_LOST: TODO: type description here. - CHARGEBACK_ACCEPTED: TODO: type description here. - CHARGEBACK_CLOSED: TODO: type description here. - CHARGEBACK_WON: TODO: type description here. - PAYMENT_COLLECTION_METHOD_CHANGED: TODO: type description here. - COMPONENT_BILLING_DATE_CHANGED: TODO: type description here. - SUBSCRIPTION_TERM_RENEWAL_SCHEDULED: TODO: type description here. - SUBSCRIPTION_TERM_RENEWAL_PENDING: TODO: type description here. - SUBSCRIPTION_TERM_RENEWAL_ACTIVATED: TODO: type description here. - SUBSCRIPTION_TERM_RENEWAL_REMOVED: TODO: type description here. + PAYMENT_SUCCESS: The enum member of type str. + PAYMENT_FAILURE: The enum member of type str. + SIGNUP_SUCCESS: The enum member of type str. + SIGNUP_FAILURE: The enum member of type str. + DELAYED_SIGNUP_CREATION_SUCCESS: The enum member of type str. + DELAYED_SIGNUP_CREATION_FAILURE: The enum member of type str. + BILLING_DATE_CHANGE: The enum member of type str. + EXPIRATION_DATE_CHANGE: The enum member of type str. + RENEWAL_SUCCESS: The enum member of type str. + RENEWAL_FAILURE: The enum member of type str. + SUBSCRIPTION_STATE_CHANGE: The enum member of type str. + SUBSCRIPTION_PRODUCT_CHANGE: The enum member of type str. + PENDING_CANCELLATION_CHANGE: The enum member of type str. + EXPIRING_CARD: The enum member of type str. + CUSTOMER_UPDATE: The enum member of type str. + CUSTOMER_CREATE: The enum member of type str. + CUSTOMER_DELETE: The enum member of type str. + COMPONENT_ALLOCATION_CHANGE: The enum member of type str. + METERED_USAGE: The enum member of type str. + PREPAID_USAGE: The enum member of type str. + UPGRADE_DOWNGRADE_SUCCESS: The enum member of type str. + UPGRADE_DOWNGRADE_FAILURE: The enum member of type str. + STATEMENT_CLOSED: The enum member of type str. + STATEMENT_SETTLED: The enum member of type str. + SUBSCRIPTION_CARD_UPDATE: The enum member of type str. + SUBSCRIPTION_GROUP_CARD_UPDATE: The enum member of type str. + SUBSCRIPTION_BANK_ACCOUNT_UPDATE: The enum member of type str. + REFUND_SUCCESS: The enum member of type str. + REFUND_FAILURE: The enum member of type str. + UPCOMING_RENEWAL_NOTICE: The enum member of type str. + TRIAL_END_NOTICE: The enum member of type str. + DUNNING_STEP_REACHED: The enum member of type str. + INVOICE_ISSUED: The enum member of type str. + PREPAID_SUBSCRIPTION_BALANCE_CHANGED: The enum member of type str. + SUBSCRIPTION_GROUP_SIGNUP_SUCCESS: The enum member of type str. + SUBSCRIPTION_GROUP_SIGNUP_FAILURE: The enum member of type str. + DIRECT_DEBIT_PAYMENT_PAID_OUT: The enum member of type str. + DIRECT_DEBIT_PAYMENT_REJECTED: The enum member of type str. + DIRECT_DEBIT_PAYMENT_PENDING: The enum member of type str. + PENDING_PAYMENT_CREATED: The enum member of type str. + PENDING_PAYMENT_FAILED: The enum member of type str. + PENDING_PAYMENT_COMPLETED: The enum member of type str. + PROFORMA_INVOICE_ISSUED: The enum member of type str. + SUBSCRIPTION_PREPAYMENT_ACCOUNT_BALANCE_CHANGED: The enum member of + type str. + SUBSCRIPTION_SERVICE_CREDIT_ACCOUNT_BALANCE_CHANGED: The enum member + of type str. + CUSTOM_FIELD_VALUE_CHANGE: The enum member of type str. + ITEM_PRICE_POINT_CHANGED: The enum member of type str. + RENEWAL_SUCCESS_RECREATED: The enum member of type str. + RENEWAL_FAILURE_RECREATED: The enum member of type str. + PAYMENT_SUCCESS_RECREATED: The enum member of type str. + PAYMENT_FAILURE_RECREATED: The enum member of type str. + SUBSCRIPTION_DELETION: The enum member of type str. + SUBSCRIPTION_GROUP_BANK_ACCOUNT_UPDATE: The enum member of type str. + SUBSCRIPTION_PAYPAL_ACCOUNT_UPDATE: The enum member of type str. + SUBSCRIPTION_GROUP_PAYPAL_ACCOUNT_UPDATE: The enum member of type str. + SUBSCRIPTION_CUSTOMER_CHANGE: The enum member of type str. + ACCOUNT_TRANSACTION_CHANGED: The enum member of type str. + GO_CARDLESS_PAYMENT_PAID_OUT: The enum member of type str. + GO_CARDLESS_PAYMENT_REJECTED: The enum member of type str. + GO_CARDLESS_PAYMENT_PENDING: The enum member of type str. + STRIPE_DIRECT_DEBIT_PAYMENT_PAID_OUT: The enum member of type str. + STRIPE_DIRECT_DEBIT_PAYMENT_REJECTED: The enum member of type str. + STRIPE_DIRECT_DEBIT_PAYMENT_PENDING: The enum member of type str. + MAXIO_PAYMENTS_DIRECT_DEBIT_PAYMENT_PAID_OUT: The enum member of type + str. + MAXIO_PAYMENTS_DIRECT_DEBIT_PAYMENT_REJECTED: The enum member of type + str. + MAXIO_PAYMENTS_DIRECT_DEBIT_PAYMENT_PENDING: The enum member of type + str. + INVOICE_IN_COLLECTIONS_CANCELED: The enum member of type str. + SUBSCRIPTION_ADDED_TO_GROUP: The enum member of type str. + SUBSCRIPTION_REMOVED_FROM_GROUP: The enum member of type str. + CHARGEBACK_OPENED: The enum member of type str. + CHARGEBACK_LOST: The enum member of type str. + CHARGEBACK_ACCEPTED: The enum member of type str. + CHARGEBACK_CLOSED: The enum member of type str. + CHARGEBACK_WON: The enum member of type str. + PAYMENT_COLLECTION_METHOD_CHANGED: The enum member of type str. + COMPONENT_BILLING_DATE_CHANGED: The enum member of type str. + SUBSCRIPTION_TERM_RENEWAL_SCHEDULED: The enum member of type str. + SUBSCRIPTION_TERM_RENEWAL_PENDING: The enum member of type str. + SUBSCRIPTION_TERM_RENEWAL_ACTIVATED: The enum member of type str. + SUBSCRIPTION_TERM_RENEWAL_REMOVED: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/event_response.py b/advancedbilling/models/event_response.py index 7b216503..647d5950 100644 --- a/advancedbilling/models/event_response.py +++ b/advancedbilling/models/event_response.py @@ -13,10 +13,8 @@ class EventResponse(object): """Implementation of the 'Event Response' model. - TODO: type model description here. - Attributes: - event (Event): TODO: type description here. + event (Event): The model property of type Event. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(event, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'event={self.event!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'event={self.event!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/expiration_interval_unit.py b/advancedbilling/models/expiration_interval_unit.py index cfd80cec..8dd4d06a 100644 --- a/advancedbilling/models/expiration_interval_unit.py +++ b/advancedbilling/models/expiration_interval_unit.py @@ -12,12 +12,10 @@ class ExpirationIntervalUnit(object): """Implementation of the 'Expiration Interval Unit' enum. - TODO: type enum description here. - Attributes: - DAY: TODO: type description here. - MONTH: TODO: type description here. - NEVER: TODO: type description here. + DAY: The enum member of type str. + MONTH: The enum member of type str. + NEVER: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/failed_payment_action.py b/advancedbilling/models/failed_payment_action.py index 0a03e158..010ba9c7 100644 --- a/advancedbilling/models/failed_payment_action.py +++ b/advancedbilling/models/failed_payment_action.py @@ -27,9 +27,9 @@ class FailedPaymentAction(object): state (depending upon net terms and dunning settings). Attributes: - LEAVE_OPEN_INVOICE: TODO: type description here. - ROLLBACK_TO_PENDING: TODO: type description here. - INITIATE_DUNNING: TODO: type description here. + LEAVE_OPEN_INVOICE: The enum member of type str. + ROLLBACK_TO_PENDING: The enum member of type str. + INITIATE_DUNNING: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/failed_payment_event.py b/advancedbilling/models/failed_payment_event.py index e6f48841..a3791400 100644 --- a/advancedbilling/models/failed_payment_event.py +++ b/advancedbilling/models/failed_payment_event.py @@ -16,13 +16,12 @@ class FailedPaymentEvent(object): """Implementation of the 'Failed Payment Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (FailedPaymentEventData): Example schema for an `failed_payment` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: FailedPaymentEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/failed_payment_event_data.py b/advancedbilling/models/failed_payment_event_data.py index 3caeeba2..2139434f 100644 --- a/advancedbilling/models/failed_payment_event_data.py +++ b/advancedbilling/models/failed_payment_event_data.py @@ -22,7 +22,8 @@ class FailedPaymentEventData(object): applied_amount (int): The monetary value of the payment, expressed in dollars. memo (str): The memo passed when the payment was created. - payment_method (InvoicePaymentMethodType): TODO: type description here. + payment_method (InvoicePaymentMethodType): The model property of type + InvoicePaymentMethodType. transaction_id (int): The transaction ID of the failed payment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -137,3 +138,21 @@ def validate(cls, dictionary): type_callable=lambda value: InvoicePaymentMethodType.validate(value)) \ and APIHelper.is_valid_type(value=dictionary.get('transaction_id'), type_callable=lambda value: isinstance(value, int)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'memo={self.memo!r}, ' + f'payment_method={self.payment_method!r}, ' + f'transaction_id={self.transaction_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'memo={self.memo!s}, ' + f'payment_method={self.payment_method!s}, ' + f'transaction_id={self.transaction_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/first_charge_type.py b/advancedbilling/models/first_charge_type.py index 4d2679fc..eb0135e6 100644 --- a/advancedbilling/models/first_charge_type.py +++ b/advancedbilling/models/first_charge_type.py @@ -12,12 +12,10 @@ class FirstChargeType(object): """Implementation of the 'First Charge Type' enum. - TODO: type enum description here. - Attributes: - PRORATED: TODO: type description here. - IMMEDIATE: TODO: type description here. - DELAYED: TODO: type description here. + PRORATED: The enum member of type str. + IMMEDIATE: The enum member of type str. + DELAYED: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/full_subscription_group_response.py b/advancedbilling/models/full_subscription_group_response.py index 68c4c0a4..3d73586c 100644 --- a/advancedbilling/models/full_subscription_group_response.py +++ b/advancedbilling/models/full_subscription_group_response.py @@ -15,16 +15,14 @@ class FullSubscriptionGroupResponse(object): """Implementation of the 'Full Subscription Group Response' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - scheme (int): TODO: type description here. - customer_id (int): TODO: type description here. - payment_profile_id (int): TODO: type description here. - subscription_ids (List[int]): TODO: type description here. - primary_subscription_id (int): TODO: type description here. - next_assessment_at (datetime): TODO: type description here. + uid (str): The model property of type str. + scheme (int): The model property of type int. + customer_id (int): The model property of type int. + payment_profile_id (int): The model property of type int. + subscription_ids (List[int]): The model property of type List[int]. + primary_subscription_id (int): The model property of type int. + next_assessment_at (datetime): The model property of type datetime. state (SubscriptionState): The state of a subscription. * **Live States** * `active` - A normal, active subscription. It is not in a trial and is paid and up to date. * `assessing` - An @@ -90,12 +88,12 @@ class FullSubscriptionGroupResponse(object): States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853- Subscription-States) for more info about subscription states and state transitions. - cancel_at_end_of_period (bool): TODO: type description here. - current_billing_amount_in_cents (long|int): TODO: type description - here. - customer (SubscriptionGroupCustomer): TODO: type description here. - account_balances (SubscriptionGroupBalances): TODO: type description - here. + cancel_at_end_of_period (bool): The model property of type bool. + current_billing_amount_in_cents (int): The model property of type int. + customer (SubscriptionGroupCustomer): The model property of type + SubscriptionGroupCustomer. + account_balances (SubscriptionGroupBalances): The model property of + type SubscriptionGroupBalances. additional_properties (Dict[str, object]): The additional properties for the model. @@ -226,3 +224,35 @@ def from_dictionary(cls, customer, account_balances, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'scheme={self.scheme!r}, ' + f'customer_id={self.customer_id!r}, ' + f'payment_profile_id={self.payment_profile_id!r}, ' + f'subscription_ids={self.subscription_ids!r}, ' + f'primary_subscription_id={self.primary_subscription_id!r}, ' + f'next_assessment_at={self.next_assessment_at!r}, ' + f'state={self.state!r}, ' + f'cancel_at_end_of_period={self.cancel_at_end_of_period!r}, ' + f'current_billing_amount_in_cents={self.current_billing_amount_in_cents!r}, ' + f'customer={self.customer!r}, ' + f'account_balances={self.account_balances!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'scheme={self.scheme!s}, ' + f'customer_id={self.customer_id!s}, ' + f'payment_profile_id={self.payment_profile_id!s}, ' + f'subscription_ids={self.subscription_ids!s}, ' + f'primary_subscription_id={self.primary_subscription_id!s}, ' + f'next_assessment_at={self.next_assessment_at!s}, ' + f'state={self.state!s}, ' + f'cancel_at_end_of_period={self.cancel_at_end_of_period!s}, ' + f'current_billing_amount_in_cents={self.current_billing_amount_in_cents!s}, ' + f'customer={self.customer!s}, ' + f'account_balances={self.account_balances!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/get_one_time_token_payment_profile.py b/advancedbilling/models/get_one_time_token_payment_profile.py index 04f6479f..9839c986 100644 --- a/advancedbilling/models/get_one_time_token_payment_profile.py +++ b/advancedbilling/models/get_one_time_token_payment_profile.py @@ -13,31 +13,29 @@ class GetOneTimeTokenPaymentProfile(object): """Implementation of the 'Get One Time Token Payment Profile' model. - TODO: type model description here. - Attributes: - id (str): TODO: type description here. - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - masked_card_number (str): TODO: type description here. + id (str): The model property of type str. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + masked_card_number (str): The model property of type str. card_type (CardType): The type of card used. - expiration_month (float): TODO: type description here. - expiration_year (float): TODO: type description here. - customer_id (str): TODO: type description here. + expiration_month (float): The model property of type float. + expiration_year (float): The model property of type float. + customer_id (str): The model property of type str. current_vault (CreditCardVault): The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. - vault_token (str): TODO: type description here. - billing_address (str): TODO: type description here. - billing_address_2 (str): TODO: type description here. - billing_city (str): TODO: type description here. - billing_country (str): TODO: type description here. - billing_state (str): TODO: type description here. - billing_zip (str): TODO: type description here. - payment_type (str): TODO: type description here. - disabled (bool): TODO: type description here. - site_gateway_setting_id (int): TODO: type description here. - customer_vault_token (str): TODO: type description here. - gateway_handle (str): TODO: type description here. + vault_token (str): The model property of type str. + billing_address (str): The model property of type str. + billing_address_2 (str): The model property of type str. + billing_city (str): The model property of type str. + billing_country (str): The model property of type str. + billing_state (str): The model property of type str. + billing_zip (str): The model property of type str. + payment_type (str): The model property of type str. + disabled (bool): The model property of type bool. + site_gateway_setting_id (int): The model property of type int. + customer_vault_token (str): The model property of type str. + gateway_handle (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -206,3 +204,53 @@ def from_dictionary(cls, customer_vault_token, gateway_handle, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'masked_card_number={self.masked_card_number!r}, ' + f'card_type={self.card_type!r}, ' + f'expiration_month={self.expiration_month!r}, ' + f'expiration_year={self.expiration_year!r}, ' + f'customer_id={self.customer_id!r}, ' + f'current_vault={self.current_vault!r}, ' + f'vault_token={self.vault_token!r}, ' + f'billing_address={self.billing_address!r}, ' + f'billing_address_2={self.billing_address_2!r}, ' + f'billing_city={self.billing_city!r}, ' + f'billing_country={self.billing_country!r}, ' + f'billing_state={self.billing_state!r}, ' + f'billing_zip={self.billing_zip!r}, ' + f'payment_type={self.payment_type!r}, ' + f'disabled={self.disabled!r}, ' + f'site_gateway_setting_id={self.site_gateway_setting_id!r}, ' + f'customer_vault_token={self.customer_vault_token!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'masked_card_number={self.masked_card_number!s}, ' + f'card_type={self.card_type!s}, ' + f'expiration_month={self.expiration_month!s}, ' + f'expiration_year={self.expiration_year!s}, ' + f'customer_id={self.customer_id!s}, ' + f'current_vault={self.current_vault!s}, ' + f'vault_token={self.vault_token!s}, ' + f'billing_address={self.billing_address!s}, ' + f'billing_address_2={self.billing_address_2!s}, ' + f'billing_city={self.billing_city!s}, ' + f'billing_country={self.billing_country!s}, ' + f'billing_state={self.billing_state!s}, ' + f'billing_zip={self.billing_zip!s}, ' + f'payment_type={self.payment_type!s}, ' + f'disabled={self.disabled!s}, ' + f'site_gateway_setting_id={self.site_gateway_setting_id!s}, ' + f'customer_vault_token={self.customer_vault_token!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/get_one_time_token_request.py b/advancedbilling/models/get_one_time_token_request.py index 03c1faaf..f6fd07d5 100644 --- a/advancedbilling/models/get_one_time_token_request.py +++ b/advancedbilling/models/get_one_time_token_request.py @@ -13,11 +13,9 @@ class GetOneTimeTokenRequest(object): """Implementation of the 'Get One Time Token Request' model. - TODO: type model description here. - Attributes: - payment_profile (GetOneTimeTokenPaymentProfile): TODO: type - description here. + payment_profile (GetOneTimeTokenPaymentProfile): The model property of + type GetOneTimeTokenPaymentProfile. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(payment_profile, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile={self.payment_profile!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile={self.payment_profile!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/group_billing.py b/advancedbilling/models/group_billing.py index 526ef1c0..983762b1 100644 --- a/advancedbilling/models/group_billing.py +++ b/advancedbilling/models/group_billing.py @@ -112,3 +112,17 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'accrue={self.accrue!r}, ' + f'align_date={self.align_date!r}, ' + f'prorate={self.prorate!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'accrue={self.accrue!s}, ' + f'align_date={self.align_date!s}, ' + f'prorate={self.prorate!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/group_settings.py b/advancedbilling/models/group_settings.py index 523ea1b2..a0734fea 100644 --- a/advancedbilling/models/group_settings.py +++ b/advancedbilling/models/group_settings.py @@ -15,8 +15,6 @@ class GroupSettings(object): """Implementation of the 'Group Settings' model. - TODO: type model description here. - Attributes: target (GroupTarget): Attributes of the target customer who will be the responsible payer of the created subscription. Required. @@ -106,3 +104,15 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('target'), type_callable=lambda value: GroupTarget.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'target={self.target!r}, ' + f'billing={self.billing!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'target={self.target!s}, ' + f'billing={self.billing!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/group_target.py b/advancedbilling/models/group_target.py index 1975093f..cea8e268 100644 --- a/advancedbilling/models/group_target.py +++ b/advancedbilling/models/group_target.py @@ -105,3 +105,15 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('type'), type_callable=lambda value: GroupTargetType.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'mtype={self.mtype!r}, ' + f'id={self.id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'mtype={self.mtype!s}, ' + f'id={self.id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/group_target_type.py b/advancedbilling/models/group_target_type.py index 85579142..ef56f371 100644 --- a/advancedbilling/models/group_target_type.py +++ b/advancedbilling/models/group_target_type.py @@ -15,11 +15,11 @@ class GroupTargetType(object): The type of object indicated by the id attribute. Attributes: - CUSTOMER: TODO: type description here. - SUBSCRIPTION: TODO: type description here. - SELF: TODO: type description here. - PARENT: TODO: type description here. - ELDEST: TODO: type description here. + CUSTOMER: The enum member of type str. + SUBSCRIPTION: The enum member of type str. + SELF: The enum member of type str. + PARENT: The enum member of type str. + ELDEST: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/group_type.py b/advancedbilling/models/group_type.py index 47843057..f8dde8fe 100644 --- a/advancedbilling/models/group_type.py +++ b/advancedbilling/models/group_type.py @@ -12,11 +12,9 @@ class GroupType(object): """Implementation of the 'Group Type' enum. - TODO: type enum description here. - Attributes: - SINGLE_CUSTOMER: TODO: type description here. - MULTIPLE_CUSTOMERS: TODO: type description here. + SINGLE_CUSTOMER: The enum member of type str. + MULTIPLE_CUSTOMERS: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/historic_usage.py b/advancedbilling/models/historic_usage.py index 5bec64c1..779802dd 100644 --- a/advancedbilling/models/historic_usage.py +++ b/advancedbilling/models/historic_usage.py @@ -110,3 +110,17 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'total_usage_quantity={self.total_usage_quantity!r}, ' + f'billing_period_starts_at={self.billing_period_starts_at!r}, ' + f'billing_period_ends_at={self.billing_period_ends_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'total_usage_quantity={self.total_usage_quantity!s}, ' + f'billing_period_starts_at={self.billing_period_starts_at!s}, ' + f'billing_period_ends_at={self.billing_period_ends_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/include_not_null.py b/advancedbilling/models/include_not_null.py index 5b4ee925..1b38859c 100644 --- a/advancedbilling/models/include_not_null.py +++ b/advancedbilling/models/include_not_null.py @@ -15,7 +15,7 @@ class IncludeNotNull(object): Passed as a parameter to list methods to return only non null values. Attributes: - NOT_NULL: TODO: type description here. + NOT_NULL: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/include_null_or_not_null.py b/advancedbilling/models/include_null_or_not_null.py index 50c83123..29e8e3a6 100644 --- a/advancedbilling/models/include_null_or_not_null.py +++ b/advancedbilling/models/include_null_or_not_null.py @@ -15,8 +15,8 @@ class IncludeNullOrNotNull(object): Allows to filter by `not_null` or `null`. Attributes: - NOT_NULL: TODO: type description here. - NULL: TODO: type description here. + NOT_NULL: The enum member of type str. + NULL: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/include_option.py b/advancedbilling/models/include_option.py index 9b32cce0..5560c31d 100644 --- a/advancedbilling/models/include_option.py +++ b/advancedbilling/models/include_option.py @@ -12,11 +12,9 @@ class IncludeOption(object): """Implementation of the 'Include Option' enum. - TODO: type enum description here. - Attributes: - EXCLUDE: TODO: type description here. - INCLUDE: TODO: type description here. + EXCLUDE: The enum member of type str. + INCLUDE: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/interval_unit.py b/advancedbilling/models/interval_unit.py index f7b2df02..0ae2f2cd 100644 --- a/advancedbilling/models/interval_unit.py +++ b/advancedbilling/models/interval_unit.py @@ -12,11 +12,9 @@ class IntervalUnit(object): """Implementation of the 'Interval Unit' enum. - TODO: type enum description here. - Attributes: - DAY: TODO: type description here. - MONTH: TODO: type description here. + DAY: The enum member of type str. + MONTH: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice.py b/advancedbilling/models/invoice.py index e09bd7a2..365350ab 100644 --- a/advancedbilling/models/invoice.py +++ b/advancedbilling/models/invoice.py @@ -30,10 +30,8 @@ class Invoice(object): """Implementation of the 'Invoice' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. + id (int): The model property of type int. uid (str): Unique identifier for the invoice. It is generated automatically by Chargify and has the prefix "inv_" followed by alphanumeric characters. @@ -48,9 +46,9 @@ class Invoice(object): sequence_number (int): A monotonically increasing number assigned to invoices as they are created. This number is unique within a site and can be used to sort and order invoices. - transaction_time (datetime): TODO: type description here. - created_at (datetime): TODO: type description here. - updated_at (datetime): TODO: type description here. + transaction_time (datetime): The model property of type datetime. + created_at (datetime): The model property of type datetime. + updated_at (datetime): The model property of type datetime. issue_date (date): Date the invoice was issued to the customer. This is the date that the invoice was made available for payment. The format is `"YYYY-MM-DD"`. @@ -63,8 +61,8 @@ class Invoice(object): [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/2425228782964 5-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. - role (InvoiceRole): TODO: type description here. - parent_invoice_id (int): TODO: type description here. + role (InvoiceRole): The model property of type InvoiceRole. + parent_invoice_id (int): The model property of type int. collection_method (CollectionMethod): The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For current @@ -90,7 +88,7 @@ class Invoice(object): parent_invoice_uid (str): For invoices with `consolidation_level` of `child`, this specifies the UID of the parent (consolidated) invoice. - subscription_group_id (int): TODO: type description here. + subscription_group_id (int): The model property of type int. parent_invoice_number (int): For invoices with `consolidation_level` of `child`, this specifies the number of the parent (consolidated) invoice. @@ -106,9 +104,9 @@ class Invoice(object): on the masthead of the invoice. customer (InvoiceCustomer): Information about the customer who is owner or recipient the invoiced subscription. - payer (InvoicePayer): TODO: type description here. - recipient_emails (List[str]): TODO: type description here. - net_terms (int): TODO: type description here. + payer (InvoicePayer): The model property of type InvoicePayer. + recipient_emails (List[str]): The model property of type List[str]. + net_terms (int): The model property of type int. memo (str): The memo printed on invoices of any collection type. This message is in control of the merchant. billing_address (InvoiceAddress): The invoice billing address. @@ -121,24 +119,32 @@ class Invoice(object): discount_amount + tax_amount`.' credit_amount (str): The amount of credit (from credit notes) applied to this invoice. Credits offset the amount due from the customer. - debit_amount (str): TODO: type description here. - refund_amount (str): TODO: type description here. + debit_amount (str): The model property of type str. + refund_amount (str): The model property of type str. paid_amount (str): The amount paid on the invoice by the customer. due_amount (str): Amount due on the invoice, which is `total_amount - credit_amount - paid_amount`. line_items (List[InvoiceLineItem]): Line items on the invoice. - discounts (List[InvoiceDiscount]): TODO: type description here. - taxes (List[InvoiceTax]): TODO: type description here. - credits (List[InvoiceCredit]): TODO: type description here. - debits (List[InvoiceDebit]): TODO: type description here. - refunds (List[InvoiceRefund]): TODO: type description here. - payments (List[InvoicePayment]): TODO: type description here. - custom_fields (List[InvoiceCustomField]): TODO: type description here. - display_settings (InvoiceDisplaySettings): TODO: type description here. - avatax_details (InvoiceAvataxDetails): TODO: type description here. + discounts (List[InvoiceDiscount]): The model property of type + List[InvoiceDiscount]. + taxes (List[InvoiceTax]): The model property of type List[InvoiceTax]. + credits (List[InvoiceCredit]): The model property of type + List[InvoiceCredit]. + debits (List[InvoiceDebit]): The model property of type + List[InvoiceDebit]. + refunds (List[InvoiceRefund]): The model property of type + List[InvoiceRefund]. + payments (List[InvoicePayment]): The model property of type + List[InvoicePayment]. + custom_fields (List[InvoiceCustomField]): The model property of type + List[InvoiceCustomField]. + display_settings (InvoiceDisplaySettings): The model property of type + InvoiceDisplaySettings. + avatax_details (InvoiceAvataxDetails): The model property of type + InvoiceAvataxDetails. public_url (str): The public URL of the invoice - previous_balance_data (InvoicePreviousBalance): TODO: type description - here. + previous_balance_data (InvoicePreviousBalance): The model property of + type InvoicePreviousBalance. public_url_expires_on (date): The format is `"YYYY-MM-DD"`. additional_properties (Dict[str, object]): The additional properties for the model. @@ -644,3 +650,123 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'uid={self.uid!r}, ' + f'site_id={self.site_id!r}, ' + f'customer_id={self.customer_id!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'number={self.number!r}, ' + f'sequence_number={self.sequence_number!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'issue_date={self.issue_date!r}, ' + f'due_date={self.due_date!r}, ' + f'paid_date={self.paid_date!r}, ' + f'status={self.status!r}, ' + f'role={self.role!r}, ' + f'parent_invoice_id={self.parent_invoice_id!r}, ' + f'collection_method={self.collection_method!r}, ' + f'payment_instructions={self.payment_instructions!r}, ' + f'currency={self.currency!r}, ' + f'consolidation_level={self.consolidation_level!r}, ' + f'parent_invoice_uid={self.parent_invoice_uid!r}, ' + f'subscription_group_id={self.subscription_group_id!r}, ' + f'parent_invoice_number={self.parent_invoice_number!r}, ' + f'group_primary_subscription_id={self.group_primary_subscription_id!r}, ' + f'product_name={self.product_name!r}, ' + f'product_family_name={self.product_family_name!r}, ' + f'seller={self.seller!r}, ' + f'customer={self.customer!r}, ' + f'payer={self.payer!r}, ' + f'recipient_emails={self.recipient_emails!r}, ' + f'net_terms={self.net_terms!r}, ' + f'memo={self.memo!r}, ' + f'billing_address={self.billing_address!r}, ' + f'shipping_address={self.shipping_address!r}, ' + f'subtotal_amount={self.subtotal_amount!r}, ' + f'discount_amount={self.discount_amount!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'total_amount={self.total_amount!r}, ' + f'credit_amount={self.credit_amount!r}, ' + f'debit_amount={self.debit_amount!r}, ' + f'refund_amount={self.refund_amount!r}, ' + f'paid_amount={self.paid_amount!r}, ' + f'due_amount={self.due_amount!r}, ' + f'line_items={self.line_items!r}, ' + f'discounts={self.discounts!r}, ' + f'taxes={self.taxes!r}, ' + f'credits={self.credits!r}, ' + f'debits={self.debits!r}, ' + f'refunds={self.refunds!r}, ' + f'payments={self.payments!r}, ' + f'custom_fields={self.custom_fields!r}, ' + f'display_settings={self.display_settings!r}, ' + f'avatax_details={self.avatax_details!r}, ' + f'public_url={self.public_url!r}, ' + f'previous_balance_data={self.previous_balance_data!r}, ' + f'public_url_expires_on={self.public_url_expires_on!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'uid={self.uid!s}, ' + f'site_id={self.site_id!s}, ' + f'customer_id={self.customer_id!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'number={self.number!s}, ' + f'sequence_number={self.sequence_number!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'issue_date={self.issue_date!s}, ' + f'due_date={self.due_date!s}, ' + f'paid_date={self.paid_date!s}, ' + f'status={self.status!s}, ' + f'role={self.role!s}, ' + f'parent_invoice_id={self.parent_invoice_id!s}, ' + f'collection_method={self.collection_method!s}, ' + f'payment_instructions={self.payment_instructions!s}, ' + f'currency={self.currency!s}, ' + f'consolidation_level={self.consolidation_level!s}, ' + f'parent_invoice_uid={self.parent_invoice_uid!s}, ' + f'subscription_group_id={self.subscription_group_id!s}, ' + f'parent_invoice_number={self.parent_invoice_number!s}, ' + f'group_primary_subscription_id={self.group_primary_subscription_id!s}, ' + f'product_name={self.product_name!s}, ' + f'product_family_name={self.product_family_name!s}, ' + f'seller={self.seller!s}, ' + f'customer={self.customer!s}, ' + f'payer={self.payer!s}, ' + f'recipient_emails={self.recipient_emails!s}, ' + f'net_terms={self.net_terms!s}, ' + f'memo={self.memo!s}, ' + f'billing_address={self.billing_address!s}, ' + f'shipping_address={self.shipping_address!s}, ' + f'subtotal_amount={self.subtotal_amount!s}, ' + f'discount_amount={self.discount_amount!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'total_amount={self.total_amount!s}, ' + f'credit_amount={self.credit_amount!s}, ' + f'debit_amount={self.debit_amount!s}, ' + f'refund_amount={self.refund_amount!s}, ' + f'paid_amount={self.paid_amount!s}, ' + f'due_amount={self.due_amount!s}, ' + f'line_items={self.line_items!s}, ' + f'discounts={self.discounts!s}, ' + f'taxes={self.taxes!s}, ' + f'credits={self.credits!s}, ' + f'debits={self.debits!s}, ' + f'refunds={self.refunds!s}, ' + f'payments={self.payments!s}, ' + f'custom_fields={self.custom_fields!s}, ' + f'display_settings={self.display_settings!s}, ' + f'avatax_details={self.avatax_details!s}, ' + f'public_url={self.public_url!s}, ' + f'previous_balance_data={self.previous_balance_data!s}, ' + f'public_url_expires_on={self.public_url_expires_on!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_address.py b/advancedbilling/models/invoice_address.py index 265ef531..1d8e1366 100644 --- a/advancedbilling/models/invoice_address.py +++ b/advancedbilling/models/invoice_address.py @@ -13,15 +13,13 @@ class InvoiceAddress(object): """Implementation of the 'Invoice Address' model. - TODO: type model description here. - Attributes: - street (str): TODO: type description here. - line_2 (str): TODO: type description here. - city (str): TODO: type description here. - state (str): TODO: type description here. - zip (str): TODO: type description here. - country (str): TODO: type description here. + street (str): The model property of type str. + line_2 (str): The model property of type str. + city (str): The model property of type str. + state (str): The model property of type str. + zip (str): The model property of type str. + country (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -141,3 +139,23 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'street={self.street!r}, ' + f'line_2={self.line_2!r}, ' + f'city={self.city!r}, ' + f'state={self.state!r}, ' + f'zip={self.zip!r}, ' + f'country={self.country!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'street={self.street!s}, ' + f'line_2={self.line_2!s}, ' + f'city={self.city!s}, ' + f'state={self.state!s}, ' + f'zip={self.zip!s}, ' + f'country={self.country!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_avatax_details.py b/advancedbilling/models/invoice_avatax_details.py index 76a8ed89..8f5880dd 100644 --- a/advancedbilling/models/invoice_avatax_details.py +++ b/advancedbilling/models/invoice_avatax_details.py @@ -13,14 +13,12 @@ class InvoiceAvataxDetails(object): """Implementation of the 'Invoice Avatax Details' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - status (str): TODO: type description here. - document_code (str): TODO: type description here. - commit_date (datetime): TODO: type description here. - modify_date (datetime): TODO: type description here. + id (int): The model property of type int. + status (str): The model property of type str. + document_code (str): The model property of type str. + commit_date (datetime): The model property of type datetime. + modify_date (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -138,3 +136,21 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'status={self.status!r}, ' + f'document_code={self.document_code!r}, ' + f'commit_date={self.commit_date!r}, ' + f'modify_date={self.modify_date!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'status={self.status!s}, ' + f'document_code={self.document_code!s}, ' + f'commit_date={self.commit_date!s}, ' + f'modify_date={self.modify_date!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_balance_item.py b/advancedbilling/models/invoice_balance_item.py index 8a2bfeb4..86f34505 100644 --- a/advancedbilling/models/invoice_balance_item.py +++ b/advancedbilling/models/invoice_balance_item.py @@ -13,12 +13,10 @@ class InvoiceBalanceItem(object): """Implementation of the 'Invoice Balance Item' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - number (str): TODO: type description here. - outstanding_amount (str): TODO: type description here. + uid (str): The model property of type str. + number (str): The model property of type str. + outstanding_amount (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -108,3 +106,17 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'number={self.number!r}, ' + f'outstanding_amount={self.outstanding_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'number={self.number!s}, ' + f'outstanding_amount={self.outstanding_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_consolidation_level.py b/advancedbilling/models/invoice_consolidation_level.py index 5046b742..bdc6299e 100644 --- a/advancedbilling/models/invoice_consolidation_level.py +++ b/advancedbilling/models/invoice_consolidation_level.py @@ -26,9 +26,9 @@ class InvoiceConsolidationLevel(object): nvoice-Consolidation). Attributes: - NONE: TODO: type description here. - CHILD: TODO: type description here. - PARENT: TODO: type description here. + NONE: The enum member of type str. + CHILD: The enum member of type str. + PARENT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_credit.py b/advancedbilling/models/invoice_credit.py index d2e4fba6..e53f7721 100644 --- a/advancedbilling/models/invoice_credit.py +++ b/advancedbilling/models/invoice_credit.py @@ -13,16 +13,14 @@ class InvoiceCredit(object): """Implementation of the 'Invoice Credit' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - credit_note_number (str): TODO: type description here. - credit_note_uid (str): TODO: type description here. - transaction_time (datetime): TODO: type description here. - memo (str): TODO: type description here. - original_amount (str): TODO: type description here. - applied_amount (str): TODO: type description here. + uid (str): The model property of type str. + credit_note_number (str): The model property of type str. + credit_note_uid (str): The model property of type str. + transaction_time (datetime): The model property of type datetime. + memo (str): The model property of type str. + original_amount (str): The model property of type str. + applied_amount (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -140,3 +138,25 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'credit_note_number={self.credit_note_number!r}, ' + f'credit_note_uid={self.credit_note_uid!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'memo={self.memo!r}, ' + f'original_amount={self.original_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'credit_note_number={self.credit_note_number!s}, ' + f'credit_note_uid={self.credit_note_uid!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'memo={self.memo!s}, ' + f'original_amount={self.original_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_custom_field.py b/advancedbilling/models/invoice_custom_field.py index aad67991..08c6e039 100644 --- a/advancedbilling/models/invoice_custom_field.py +++ b/advancedbilling/models/invoice_custom_field.py @@ -13,14 +13,13 @@ class InvoiceCustomField(object): """Implementation of the 'Invoice Custom Field' model. - TODO: type model description here. - Attributes: - owner_id (int): TODO: type description here. - owner_type (CustomFieldOwner): TODO: type description here. - name (str): TODO: type description here. - value (str): TODO: type description here. - metadatum_id (int): TODO: type description here. + owner_id (int): The model property of type int. + owner_type (CustomFieldOwner): The model property of type + CustomFieldOwner. + name (str): The model property of type str. + value (str): The model property of type str. + metadatum_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -124,3 +123,21 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'owner_id={self.owner_id!r}, ' + f'owner_type={self.owner_type!r}, ' + f'name={self.name!r}, ' + f'value={self.value!r}, ' + f'metadatum_id={self.metadatum_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'owner_id={self.owner_id!s}, ' + f'owner_type={self.owner_type!s}, ' + f'name={self.name!s}, ' + f'value={self.value!s}, ' + f'metadatum_id={self.metadatum_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_customer.py b/advancedbilling/models/invoice_customer.py index 571d5f16..5b0a4036 100644 --- a/advancedbilling/models/invoice_customer.py +++ b/advancedbilling/models/invoice_customer.py @@ -17,13 +17,13 @@ class InvoiceCustomer(object): subscription. Attributes: - chargify_id (int): TODO: type description here. - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - organization (str): TODO: type description here. - email (str): TODO: type description here. - vat_number (str): TODO: type description here. - reference (str): TODO: type description here. + chargify_id (int): The model property of type int. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + organization (str): The model property of type str. + email (str): The model property of type str. + vat_number (str): The model property of type str. + reference (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -148,3 +148,25 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'chargify_id={self.chargify_id!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'organization={self.organization!r}, ' + f'email={self.email!r}, ' + f'vat_number={self.vat_number!r}, ' + f'reference={self.reference!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'chargify_id={self.chargify_id!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'organization={self.organization!s}, ' + f'email={self.email!s}, ' + f'vat_number={self.vat_number!s}, ' + f'reference={self.reference!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_date_field.py b/advancedbilling/models/invoice_date_field.py index 940c6c00..52364f34 100644 --- a/advancedbilling/models/invoice_date_field.py +++ b/advancedbilling/models/invoice_date_field.py @@ -12,14 +12,12 @@ class InvoiceDateField(object): """Implementation of the 'Invoice Date Field' enum. - TODO: type enum description here. - Attributes: - CREATED_AT: TODO: type description here. - DUE_DATE: TODO: type description here. - ISSUE_DATE: TODO: type description here. - UPDATED_AT: TODO: type description here. - PAID_DATE: TODO: type description here. + CREATED_AT: The enum member of type str. + DUE_DATE: The enum member of type str. + ISSUE_DATE: The enum member of type str. + UPDATED_AT: The enum member of type str. + PAID_DATE: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_debit.py b/advancedbilling/models/invoice_debit.py index dc0ed7d2..b1fd9b63 100644 --- a/advancedbilling/models/invoice_debit.py +++ b/advancedbilling/models/invoice_debit.py @@ -13,17 +13,15 @@ class InvoiceDebit(object): """Implementation of the 'Invoice Debit' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - debit_note_number (str): TODO: type description here. - debit_note_uid (str): TODO: type description here. + uid (str): The model property of type str. + debit_note_number (str): The model property of type str. + debit_note_uid (str): The model property of type str. role (DebitNoteRole): The role of the debit note. - transaction_time (datetime): TODO: type description here. - memo (str): TODO: type description here. - original_amount (str): TODO: type description here. - applied_amount (str): TODO: type description here. + transaction_time (datetime): The model property of type datetime. + memo (str): The model property of type str. + original_amount (str): The model property of type str. + applied_amount (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -148,3 +146,27 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'debit_note_number={self.debit_note_number!r}, ' + f'debit_note_uid={self.debit_note_uid!r}, ' + f'role={self.role!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'memo={self.memo!r}, ' + f'original_amount={self.original_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'debit_note_number={self.debit_note_number!s}, ' + f'debit_note_uid={self.debit_note_uid!s}, ' + f'role={self.role!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'memo={self.memo!s}, ' + f'original_amount={self.original_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_discount.py b/advancedbilling/models/invoice_discount.py index 98a5a152..387c3c55 100644 --- a/advancedbilling/models/invoice_discount.py +++ b/advancedbilling/models/invoice_discount.py @@ -14,22 +14,22 @@ class InvoiceDiscount(object): """Implementation of the 'Invoice Discount' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - title (str): TODO: type description here. - description (str): TODO: type description here. - code (str): TODO: type description here. - source_type (InvoiceDiscountSourceType): TODO: type description here. - source_id (int): TODO: type description here. - discount_type (InvoiceDiscountType): TODO: type description here. - percentage (str): TODO: type description here. - eligible_amount (str): TODO: type description here. - discount_amount (str): TODO: type description here. - transaction_id (int): TODO: type description here. - line_item_breakouts (List[InvoiceDiscountBreakout]): TODO: type - description here. + uid (str): The model property of type str. + title (str): The model property of type str. + description (str): The model property of type str. + code (str): The model property of type str. + source_type (InvoiceDiscountSourceType): The model property of type + InvoiceDiscountSourceType. + source_id (int): The model property of type int. + discount_type (InvoiceDiscountType): The model property of type + InvoiceDiscountType. + percentage (str): The model property of type str. + eligible_amount (str): The model property of type str. + discount_amount (str): The model property of type str. + transaction_id (int): The model property of type int. + line_item_breakouts (List[InvoiceDiscountBreakout]): The model + property of type List[InvoiceDiscountBreakout]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -190,3 +190,35 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'title={self.title!r}, ' + f'description={self.description!r}, ' + f'code={self.code!r}, ' + f'source_type={self.source_type!r}, ' + f'source_id={self.source_id!r}, ' + f'discount_type={self.discount_type!r}, ' + f'percentage={self.percentage!r}, ' + f'eligible_amount={self.eligible_amount!r}, ' + f'discount_amount={self.discount_amount!r}, ' + f'transaction_id={self.transaction_id!r}, ' + f'line_item_breakouts={self.line_item_breakouts!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'title={self.title!s}, ' + f'description={self.description!s}, ' + f'code={self.code!s}, ' + f'source_type={self.source_type!s}, ' + f'source_id={self.source_id!s}, ' + f'discount_type={self.discount_type!s}, ' + f'percentage={self.percentage!s}, ' + f'eligible_amount={self.eligible_amount!s}, ' + f'discount_amount={self.discount_amount!s}, ' + f'transaction_id={self.transaction_id!s}, ' + f'line_item_breakouts={self.line_item_breakouts!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_discount_breakout.py b/advancedbilling/models/invoice_discount_breakout.py index e52f3dac..d0ad175e 100644 --- a/advancedbilling/models/invoice_discount_breakout.py +++ b/advancedbilling/models/invoice_discount_breakout.py @@ -13,12 +13,10 @@ class InvoiceDiscountBreakout(object): """Implementation of the 'Invoice Discount Breakout' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - eligible_amount (str): TODO: type description here. - discount_amount (str): TODO: type description here. + uid (str): The model property of type str. + eligible_amount (str): The model property of type str. + discount_amount (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -108,3 +106,17 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'eligible_amount={self.eligible_amount!r}, ' + f'discount_amount={self.discount_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'eligible_amount={self.eligible_amount!s}, ' + f'discount_amount={self.discount_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_discount_source_type.py b/advancedbilling/models/invoice_discount_source_type.py index 2dc1d22c..9e2c854a 100644 --- a/advancedbilling/models/invoice_discount_source_type.py +++ b/advancedbilling/models/invoice_discount_source_type.py @@ -12,12 +12,10 @@ class InvoiceDiscountSourceType(object): """Implementation of the 'Invoice Discount Source Type' enum. - TODO: type enum description here. - Attributes: - COUPON: TODO: type description here. - REFERRAL: TODO: type description here. - ENUM_AD HOC COUPON: TODO: type description here. + COUPON: The enum member of type str. + REFERRAL: The enum member of type str. + ENUM_AD HOC COUPON: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_discount_type.py b/advancedbilling/models/invoice_discount_type.py index 46eb6ff0..88b6f0d8 100644 --- a/advancedbilling/models/invoice_discount_type.py +++ b/advancedbilling/models/invoice_discount_type.py @@ -12,12 +12,10 @@ class InvoiceDiscountType(object): """Implementation of the 'Invoice Discount Type' enum. - TODO: type enum description here. - Attributes: - PERCENTAGE: TODO: type description here. - FLAT_AMOUNT: TODO: type description here. - ROLLOVER: TODO: type description here. + PERCENTAGE: The enum member of type str. + FLAT_AMOUNT: The enum member of type str. + ROLLOVER: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_display_settings.py b/advancedbilling/models/invoice_display_settings.py index 15a53149..33cce68f 100644 --- a/advancedbilling/models/invoice_display_settings.py +++ b/advancedbilling/models/invoice_display_settings.py @@ -13,11 +13,9 @@ class InvoiceDisplaySettings(object): """Implementation of the 'Invoice Display Settings' model. - TODO: type model description here. - Attributes: - hide_zero_subtotal_lines (bool): TODO: type description here. - include_discounts_on_lines (bool): TODO: type description here. + hide_zero_subtotal_lines (bool): The model property of type bool. + include_discounts_on_lines (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -100,3 +98,15 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'hide_zero_subtotal_lines={self.hide_zero_subtotal_lines!r}, ' + f'include_discounts_on_lines={self.include_discounts_on_lines!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'hide_zero_subtotal_lines={self.hide_zero_subtotal_lines!s}, ' + f'include_discounts_on_lines={self.include_discounts_on_lines!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_event_payment_method.py b/advancedbilling/models/invoice_event_payment_method.py index 45763aa8..b964a9c6 100644 --- a/advancedbilling/models/invoice_event_payment_method.py +++ b/advancedbilling/models/invoice_event_payment_method.py @@ -12,14 +12,12 @@ class InvoiceEventPaymentMethod(object): """Implementation of the 'Invoice Event Payment Method' enum. - TODO: type enum description here. - Attributes: - APPLE_PAY: TODO: type description here. - BANK_ACCOUNT: TODO: type description here. - CREDIT_CARD: TODO: type description here. - EXTERNAL: TODO: type description here. - PAYPAL_ACCOUNT: TODO: type description here. + APPLE_PAY: The enum member of type str. + BANK_ACCOUNT: The enum member of type str. + CREDIT_CARD: The enum member of type str. + EXTERNAL: The enum member of type str. + PAYPAL_ACCOUNT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_event_type.py b/advancedbilling/models/invoice_event_type.py index fafe12db..152aa492 100644 --- a/advancedbilling/models/invoice_event_type.py +++ b/advancedbilling/models/invoice_event_type.py @@ -15,21 +15,21 @@ class InvoiceEventType(object): Invoice Event Type Attributes: - ISSUE_INVOICE: TODO: type description here. - APPLY_CREDIT_NOTE: TODO: type description here. - CREATE_CREDIT_NOTE: TODO: type description here. - APPLY_PAYMENT: TODO: type description here. - APPLY_DEBIT_NOTE: TODO: type description here. - CREATE_DEBIT_NOTE: TODO: type description here. - REFUND_INVOICE: TODO: type description here. - VOID_INVOICE: TODO: type description here. - VOID_REMAINDER: TODO: type description here. - BACKPORT_INVOICE: TODO: type description here. - CHANGE_INVOICE_STATUS: TODO: type description here. - CHANGE_INVOICE_COLLECTION_METHOD: TODO: type description here. - REMOVE_PAYMENT: TODO: type description here. - FAILED_PAYMENT: TODO: type description here. - CHANGE_CHARGEBACK_STATUS: TODO: type description here. + ISSUE_INVOICE: The enum member of type str. + APPLY_CREDIT_NOTE: The enum member of type str. + CREATE_CREDIT_NOTE: The enum member of type str. + APPLY_PAYMENT: The enum member of type str. + APPLY_DEBIT_NOTE: The enum member of type str. + CREATE_DEBIT_NOTE: The enum member of type str. + REFUND_INVOICE: The enum member of type str. + VOID_INVOICE: The enum member of type str. + VOID_REMAINDER: The enum member of type str. + BACKPORT_INVOICE: The enum member of type str. + CHANGE_INVOICE_STATUS: The enum member of type str. + CHANGE_INVOICE_COLLECTION_METHOD: The enum member of type str. + REMOVE_PAYMENT: The enum member of type str. + FAILED_PAYMENT: The enum member of type str. + CHANGE_CHARGEBACK_STATUS: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_issued.py b/advancedbilling/models/invoice_issued.py index ba3d526a..67718b99 100644 --- a/advancedbilling/models/invoice_issued.py +++ b/advancedbilling/models/invoice_issued.py @@ -17,26 +17,24 @@ class InvoiceIssued(object): """Implementation of the 'Invoice Issued' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - number (str): TODO: type description here. - role (str): TODO: type description here. - due_date (date): TODO: type description here. + uid (str): The model property of type str. + number (str): The model property of type str. + role (str): The model property of type str. + due_date (date): The model property of type date. issue_date (str): Invoice issue date. Can be an empty string if value is missing. paid_date (str): Paid date. Can be an empty string if value is missing. - due_amount (str): TODO: type description here. - paid_amount (str): TODO: type description here. - tax_amount (str): TODO: type description here. - refund_amount (str): TODO: type description here. - total_amount (str): TODO: type description here. - status_amount (str): TODO: type description here. - product_name (str): TODO: type description here. - consolidation_level (str): TODO: type description here. - line_items (List[InvoiceLineItemEventData]): TODO: type description - here. + due_amount (str): The model property of type str. + paid_amount (str): The model property of type str. + tax_amount (str): The model property of type str. + refund_amount (str): The model property of type str. + total_amount (str): The model property of type str. + status_amount (str): The model property of type str. + product_name (str): The model property of type str. + consolidation_level (str): The model property of type str. + line_items (List[InvoiceLineItemEventData]): The model property of + type List[InvoiceLineItemEventData]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -247,3 +245,41 @@ def validate(cls, dictionary): type_callable=lambda value: InvoiceLineItemEventData.validate(value), is_model_dict=True, is_inner_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'number={self.number!r}, ' + f'role={self.role!r}, ' + f'due_date={self.due_date!r}, ' + f'issue_date={self.issue_date!r}, ' + f'paid_date={self.paid_date!r}, ' + f'due_amount={self.due_amount!r}, ' + f'paid_amount={self.paid_amount!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'refund_amount={self.refund_amount!r}, ' + f'total_amount={self.total_amount!r}, ' + f'status_amount={self.status_amount!r}, ' + f'product_name={self.product_name!r}, ' + f'consolidation_level={self.consolidation_level!r}, ' + f'line_items={self.line_items!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'number={self.number!s}, ' + f'role={self.role!s}, ' + f'due_date={self.due_date!s}, ' + f'issue_date={self.issue_date!s}, ' + f'paid_date={self.paid_date!s}, ' + f'due_amount={self.due_amount!s}, ' + f'paid_amount={self.paid_amount!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'refund_amount={self.refund_amount!s}, ' + f'total_amount={self.total_amount!s}, ' + f'status_amount={self.status_amount!s}, ' + f'product_name={self.product_name!s}, ' + f'consolidation_level={self.consolidation_level!s}, ' + f'line_items={self.line_items!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_line_item.py b/advancedbilling/models/invoice_line_item.py index 6c42dc46..14800946 100644 --- a/advancedbilling/models/invoice_line_item.py +++ b/advancedbilling/models/invoice_line_item.py @@ -16,8 +16,6 @@ class InvoiceLineItem(object): """Implementation of the 'Invoice Line Item' model. - TODO: type model description here. - Attributes: uid (str): Unique identifier for the line item. Useful when cross-referencing the line against individual discounts in the @@ -77,7 +75,7 @@ class InvoiceLineItem(object): For periodic charges paid in arrears (e.g. metered charges), this date will be the date of the current billing date. * For non-periodic charges, this date and the start date will match. - transaction_id (int): TODO: type description here. + transaction_id (int): The model property of type int. product_id (int): The ID of the product subscribed when the charge was made. This may be set even for component charges, so true product-only (non-component) charges will also have a nil @@ -88,14 +86,14 @@ class InvoiceLineItem(object): `nil` for non-component charges. price_point_id (int): The price point ID of the component being billed. Will be `nil` for non-component charges. - billing_schedule_item_id (int): TODO: type description here. - hide (bool): TODO: type description here. - component_cost_data (InvoiceLineItemComponentCostData): TODO: type - description here. + billing_schedule_item_id (int): The model property of type int. + hide (bool): The model property of type bool. + component_cost_data (InvoiceLineItemComponentCostData): The model + property of type InvoiceLineItemComponentCostData. product_price_point_id (int): The price point ID of the line item's product - custom_item (bool): TODO: type description here. - kind (str): TODO: type description here. + custom_item (bool): The model property of type bool. + kind (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -338,3 +336,57 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'title={self.title!r}, ' + f'description={self.description!r}, ' + f'quantity={self.quantity!r}, ' + f'unit_price={self.unit_price!r}, ' + f'subtotal_amount={self.subtotal_amount!r}, ' + f'discount_amount={self.discount_amount!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'total_amount={self.total_amount!r}, ' + f'tiered_unit_price={self.tiered_unit_price!r}, ' + f'period_range_start={self.period_range_start!r}, ' + f'period_range_end={self.period_range_end!r}, ' + f'transaction_id={self.transaction_id!r}, ' + f'product_id={self.product_id!r}, ' + f'product_version={self.product_version!r}, ' + f'component_id={self.component_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'billing_schedule_item_id={self.billing_schedule_item_id!r}, ' + f'hide={self.hide!r}, ' + f'component_cost_data={self.component_cost_data!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'custom_item={self.custom_item!r}, ' + f'kind={self.kind!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'title={self.title!s}, ' + f'description={self.description!s}, ' + f'quantity={self.quantity!s}, ' + f'unit_price={self.unit_price!s}, ' + f'subtotal_amount={self.subtotal_amount!s}, ' + f'discount_amount={self.discount_amount!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'total_amount={self.total_amount!s}, ' + f'tiered_unit_price={self.tiered_unit_price!s}, ' + f'period_range_start={self.period_range_start!s}, ' + f'period_range_end={self.period_range_end!s}, ' + f'transaction_id={self.transaction_id!s}, ' + f'product_id={self.product_id!s}, ' + f'product_version={self.product_version!s}, ' + f'component_id={self.component_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'billing_schedule_item_id={self.billing_schedule_item_id!s}, ' + f'hide={self.hide!s}, ' + f'component_cost_data={self.component_cost_data!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'custom_item={self.custom_item!s}, ' + f'kind={self.kind!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_line_item_component_cost_data.py b/advancedbilling/models/invoice_line_item_component_cost_data.py index fba4f251..b2b01d68 100644 --- a/advancedbilling/models/invoice_line_item_component_cost_data.py +++ b/advancedbilling/models/invoice_line_item_component_cost_data.py @@ -14,10 +14,9 @@ class InvoiceLineItemComponentCostData(object): """Implementation of the 'Invoice Line Item Component Cost Data' model. - TODO: type model description here. - Attributes: - rates (List[ComponentCostData]): TODO: type description here. + rates (List[ComponentCostData]): The model property of type + List[ComponentCostData]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -97,3 +96,13 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'rates={self.rates!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'rates={self.rates!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_line_item_event_data.py b/advancedbilling/models/invoice_line_item_event_data.py index 2720ca1b..68595a88 100644 --- a/advancedbilling/models/invoice_line_item_event_data.py +++ b/advancedbilling/models/invoice_line_item_event_data.py @@ -14,30 +14,28 @@ class InvoiceLineItemEventData(object): """Implementation of the 'Invoice Line Item Event Data' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - title (str): TODO: type description here. - description (str): TODO: type description here. - quantity (int): TODO: type description here. - quantity_delta (int): TODO: type description here. - unit_price (str): TODO: type description here. - period_range_start (str): TODO: type description here. - period_range_end (str): TODO: type description here. - amount (str): TODO: type description here. - line_references (str): TODO: type description here. - pricing_details_index (int): TODO: type description here. - pricing_details (List[InvoiceLineItemPricingDetail]): TODO: type - description here. - tax_code (str): TODO: type description here. - tax_amount (str): TODO: type description here. - product_id (int): TODO: type description here. - product_price_point_id (int): TODO: type description here. - price_point_id (int): TODO: type description here. - component_id (int): TODO: type description here. - billing_schedule_item_id (int): TODO: type description here. - custom_item (bool): TODO: type description here. + uid (str): The model property of type str. + title (str): The model property of type str. + description (str): The model property of type str. + quantity (int): The model property of type int. + quantity_delta (int): The model property of type int. + unit_price (str): The model property of type str. + period_range_start (str): The model property of type str. + period_range_end (str): The model property of type str. + amount (str): The model property of type str. + line_references (str): The model property of type str. + pricing_details_index (int): The model property of type int. + pricing_details (List[InvoiceLineItemPricingDetail]): The model + property of type List[InvoiceLineItemPricingDetail]. + tax_code (str): The model property of type str. + tax_amount (str): The model property of type str. + product_id (int): The model property of type int. + product_price_point_id (int): The model property of type int. + price_point_id (int): The model property of type int. + component_id (int): The model property of type int. + billing_schedule_item_id (int): The model property of type int. + custom_item (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -261,3 +259,51 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'title={self.title!r}, ' + f'description={self.description!r}, ' + f'quantity={self.quantity!r}, ' + f'quantity_delta={self.quantity_delta!r}, ' + f'unit_price={self.unit_price!r}, ' + f'period_range_start={self.period_range_start!r}, ' + f'period_range_end={self.period_range_end!r}, ' + f'amount={self.amount!r}, ' + f'line_references={self.line_references!r}, ' + f'pricing_details_index={self.pricing_details_index!r}, ' + f'pricing_details={self.pricing_details!r}, ' + f'tax_code={self.tax_code!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'product_id={self.product_id!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'component_id={self.component_id!r}, ' + f'billing_schedule_item_id={self.billing_schedule_item_id!r}, ' + f'custom_item={self.custom_item!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'title={self.title!s}, ' + f'description={self.description!s}, ' + f'quantity={self.quantity!s}, ' + f'quantity_delta={self.quantity_delta!s}, ' + f'unit_price={self.unit_price!s}, ' + f'period_range_start={self.period_range_start!s}, ' + f'period_range_end={self.period_range_end!s}, ' + f'amount={self.amount!s}, ' + f'line_references={self.line_references!s}, ' + f'pricing_details_index={self.pricing_details_index!s}, ' + f'pricing_details={self.pricing_details!s}, ' + f'tax_code={self.tax_code!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'product_id={self.product_id!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'component_id={self.component_id!s}, ' + f'billing_schedule_item_id={self.billing_schedule_item_id!s}, ' + f'custom_item={self.custom_item!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_line_item_pricing_detail.py b/advancedbilling/models/invoice_line_item_pricing_detail.py index 4c74c456..bd29e855 100644 --- a/advancedbilling/models/invoice_line_item_pricing_detail.py +++ b/advancedbilling/models/invoice_line_item_pricing_detail.py @@ -13,11 +13,9 @@ class InvoiceLineItemPricingDetail(object): """Implementation of the 'Invoice Line Item Pricing Detail' model. - TODO: type model description here. - Attributes: - label (str): TODO: type description here. - amount (str): TODO: type description here. + label (str): The model property of type str. + amount (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -100,3 +98,15 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'label={self.label!r}, ' + f'amount={self.amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'label={self.label!s}, ' + f'amount={self.amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_payer.py b/advancedbilling/models/invoice_payer.py index 916c1857..6a6b36c6 100644 --- a/advancedbilling/models/invoice_payer.py +++ b/advancedbilling/models/invoice_payer.py @@ -13,15 +13,13 @@ class InvoicePayer(object): """Implementation of the 'Invoice Payer' model. - TODO: type model description here. - Attributes: - chargify_id (int): TODO: type description here. - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - organization (str): TODO: type description here. - email (str): TODO: type description here. - vat_number (str): TODO: type description here. + chargify_id (int): The model property of type int. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + organization (str): The model property of type str. + email (str): The model property of type str. + vat_number (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -137,3 +135,23 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'chargify_id={self.chargify_id!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'organization={self.organization!r}, ' + f'email={self.email!r}, ' + f'vat_number={self.vat_number!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'chargify_id={self.chargify_id!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'organization={self.organization!s}, ' + f'email={self.email!s}, ' + f'vat_number={self.vat_number!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_payer_change.py b/advancedbilling/models/invoice_payer_change.py index ae980ffe..d05fc5e7 100644 --- a/advancedbilling/models/invoice_payer_change.py +++ b/advancedbilling/models/invoice_payer_change.py @@ -13,13 +13,11 @@ class InvoicePayerChange(object): """Implementation of the 'Invoice Payer Change' model. - TODO: type model description here. - Attributes: - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - organization (str): TODO: type description here. - email (str): TODO: type description here. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + organization (str): The model property of type str. + email (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -94,3 +92,19 @@ def from_dictionary(cls, organization, email, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'organization={self.organization!r}, ' + f'email={self.email!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'organization={self.organization!s}, ' + f'email={self.email!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_payment.py b/advancedbilling/models/invoice_payment.py index e99fe865..d98b91bc 100644 --- a/advancedbilling/models/invoice_payment.py +++ b/advancedbilling/models/invoice_payment.py @@ -16,24 +16,23 @@ class InvoicePayment(object): """Implementation of the 'Invoice Payment' model. - TODO: type model description here. - Attributes: - transaction_time (datetime): TODO: type description here. - memo (str): TODO: type description here. - original_amount (str): TODO: type description here. - applied_amount (str): TODO: type description here. - payment_method (InvoicePaymentMethod): TODO: type description here. - transaction_id (int): TODO: type description here. - prepayment (bool): TODO: type description here. - gateway_handle (str): TODO: type description here. - gateway_used (str): TODO: type description here. + transaction_time (datetime): The model property of type datetime. + memo (str): The model property of type str. + original_amount (str): The model property of type str. + applied_amount (str): The model property of type str. + payment_method (InvoicePaymentMethod): The model property of type + InvoicePaymentMethod. + transaction_id (int): The model property of type int. + prepayment (bool): The model property of type bool. + gateway_handle (str): The model property of type str. + gateway_used (str): The model property of type str. gateway_transaction_id (str): The transaction ID for the payment as returned from the payment gateway received_on (date): Date reflecting when the payment was received from a customer. Must be in the past. Applicable only to `external` payments. - uid (str): TODO: type description here. + uid (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -195,3 +194,35 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'transaction_time={self.transaction_time!r}, ' + f'memo={self.memo!r}, ' + f'original_amount={self.original_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'payment_method={self.payment_method!r}, ' + f'transaction_id={self.transaction_id!r}, ' + f'prepayment={self.prepayment!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'gateway_used={self.gateway_used!r}, ' + f'gateway_transaction_id={self.gateway_transaction_id!r}, ' + f'received_on={self.received_on!r}, ' + f'uid={self.uid!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'transaction_time={self.transaction_time!s}, ' + f'memo={self.memo!s}, ' + f'original_amount={self.original_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'payment_method={self.payment_method!s}, ' + f'transaction_id={self.transaction_id!s}, ' + f'prepayment={self.prepayment!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'gateway_used={self.gateway_used!s}, ' + f'gateway_transaction_id={self.gateway_transaction_id!s}, ' + f'received_on={self.received_on!s}, ' + f'uid={self.uid!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_payment_application.py b/advancedbilling/models/invoice_payment_application.py index 3769fd92..cf5c4cd6 100644 --- a/advancedbilling/models/invoice_payment_application.py +++ b/advancedbilling/models/invoice_payment_application.py @@ -13,8 +13,6 @@ class InvoicePaymentApplication(object): """Implementation of the 'Invoice Payment Application' model. - TODO: type model description here. - Attributes: invoice_uid (str): Unique identifier for the paid invoice. It has the prefix "inv_" followed by alphanumeric characters. @@ -88,3 +86,17 @@ def from_dictionary(cls, application_uid, applied_amount, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'invoice_uid={self.invoice_uid!r}, ' + f'application_uid={self.application_uid!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'invoice_uid={self.invoice_uid!s}, ' + f'application_uid={self.application_uid!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_payment_method.py b/advancedbilling/models/invoice_payment_method.py index 58144ad7..2708d3de 100644 --- a/advancedbilling/models/invoice_payment_method.py +++ b/advancedbilling/models/invoice_payment_method.py @@ -13,17 +13,15 @@ class InvoicePaymentMethod(object): """Implementation of the 'Invoice Payment Method' model. - TODO: type model description here. - Attributes: - details (str): TODO: type description here. - kind (str): TODO: type description here. - memo (str): TODO: type description here. - mtype (str): TODO: type description here. - card_brand (str): TODO: type description here. - card_expiration (str): TODO: type description here. - last_four (str): TODO: type description here. - masked_card_number (str): TODO: type description here. + details (str): The model property of type str. + kind (str): The model property of type str. + memo (str): The model property of type str. + mtype (str): The model property of type str. + card_brand (str): The model property of type str. + card_expiration (str): The model property of type str. + last_four (str): The model property of type str. + masked_card_number (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -152,3 +150,27 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'details={self.details!r}, ' + f'kind={self.kind!r}, ' + f'memo={self.memo!r}, ' + f'mtype={self.mtype!r}, ' + f'card_brand={self.card_brand!r}, ' + f'card_expiration={self.card_expiration!r}, ' + f'last_four={self.last_four!r}, ' + f'masked_card_number={self.masked_card_number!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'details={self.details!s}, ' + f'kind={self.kind!s}, ' + f'memo={self.memo!s}, ' + f'mtype={self.mtype!s}, ' + f'card_brand={self.card_brand!s}, ' + f'card_expiration={self.card_expiration!s}, ' + f'last_four={self.last_four!s}, ' + f'masked_card_number={self.masked_card_number!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_payment_method_type.py b/advancedbilling/models/invoice_payment_method_type.py index 68c81fc6..5d9e3821 100644 --- a/advancedbilling/models/invoice_payment_method_type.py +++ b/advancedbilling/models/invoice_payment_method_type.py @@ -15,12 +15,12 @@ class InvoicePaymentMethodType(object): The type of payment method used. Defaults to other. Attributes: - CREDIT_CARD: TODO: type description here. - CHECK: TODO: type description here. - CASH: TODO: type description here. - MONEY_ORDER: TODO: type description here. - ACH: TODO: type description here. - OTHER: TODO: type description here. + CREDIT_CARD: The enum member of type str. + CHECK: The enum member of type str. + CASH: The enum member of type str. + MONEY_ORDER: The enum member of type str. + ACH: The enum member of type str. + OTHER: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_payment_type.py b/advancedbilling/models/invoice_payment_type.py index 8fc13c87..93ec0214 100644 --- a/advancedbilling/models/invoice_payment_type.py +++ b/advancedbilling/models/invoice_payment_type.py @@ -15,10 +15,10 @@ class InvoicePaymentType(object): The type of payment to be applied to an Invoice. Defaults to external. Attributes: - EXTERNAL: TODO: type description here. - PREPAYMENT: TODO: type description here. - SERVICE_CREDIT: TODO: type description here. - PAYMENT: TODO: type description here. + EXTERNAL: The enum member of type str. + PREPAYMENT: The enum member of type str. + SERVICE_CREDIT: The enum member of type str. + PAYMENT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_pre_payment.py b/advancedbilling/models/invoice_pre_payment.py index 4cabb04d..d6349cd7 100644 --- a/advancedbilling/models/invoice_pre_payment.py +++ b/advancedbilling/models/invoice_pre_payment.py @@ -13,15 +13,12 @@ class InvoicePrePayment(object): """Implementation of the 'Invoice PrePayment' model. - TODO: type model description here. - Attributes: subscription_id (int): The subscription id for the prepayment account - amount_in_cents (long|int): The amount in cents of the prepayment that - was created as a result of this payment. - ending_balance_in_cents (long|int): The total balance of the - prepayment account for this subscription including any prior - prepayments + amount_in_cents (int): The amount in cents of the prepayment that was + created as a result of this payment. + ending_balance_in_cents (int): The total balance of the prepayment + account for this subscription including any prior prepayments additional_properties (Dict[str, object]): The additional properties for the model. @@ -89,3 +86,17 @@ def from_dictionary(cls, amount_in_cents, ending_balance_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_id={self.subscription_id!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'ending_balance_in_cents={self.ending_balance_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_id={self.subscription_id!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'ending_balance_in_cents={self.ending_balance_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_previous_balance.py b/advancedbilling/models/invoice_previous_balance.py index 546a28a6..e894e769 100644 --- a/advancedbilling/models/invoice_previous_balance.py +++ b/advancedbilling/models/invoice_previous_balance.py @@ -14,11 +14,10 @@ class InvoicePreviousBalance(object): """Implementation of the 'Invoice Previous Balance' model. - TODO: type model description here. - Attributes: - captured_at (datetime): TODO: type description here. - invoices (List[InvoiceBalanceItem]): TODO: type description here. + captured_at (datetime): The model property of type datetime. + invoices (List[InvoiceBalanceItem]): The model property of type + List[InvoiceBalanceItem]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -105,3 +104,15 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'captured_at={self.captured_at!r}, ' + f'invoices={self.invoices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'captured_at={self.captured_at!s}, ' + f'invoices={self.invoices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_refund.py b/advancedbilling/models/invoice_refund.py index 561840bd..7fca4cc3 100644 --- a/advancedbilling/models/invoice_refund.py +++ b/advancedbilling/models/invoice_refund.py @@ -13,19 +13,17 @@ class InvoiceRefund(object): """Implementation of the 'Invoice Refund' model. - TODO: type model description here. - Attributes: - transaction_id (int): TODO: type description here. - payment_id (int): TODO: type description here. - memo (str): TODO: type description here. - original_amount (str): TODO: type description here. - applied_amount (str): TODO: type description here. + transaction_id (int): The model property of type int. + payment_id (int): The model property of type int. + memo (str): The model property of type str. + original_amount (str): The model property of type str. + applied_amount (str): The model property of type str. gateway_transaction_id (str): The transaction ID for the refund as returned from the payment gateway - gateway_used (str): TODO: type description here. - gateway_handle (str): TODO: type description here. - ach_late_reject (bool): TODO: type description here. + gateway_used (str): The model property of type str. + gateway_handle (str): The model property of type str. + ach_late_reject (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -163,3 +161,29 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'transaction_id={self.transaction_id!r}, ' + f'payment_id={self.payment_id!r}, ' + f'memo={self.memo!r}, ' + f'original_amount={self.original_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'gateway_transaction_id={self.gateway_transaction_id!r}, ' + f'gateway_used={self.gateway_used!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'ach_late_reject={self.ach_late_reject!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'transaction_id={self.transaction_id!s}, ' + f'payment_id={self.payment_id!s}, ' + f'memo={self.memo!s}, ' + f'original_amount={self.original_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'gateway_transaction_id={self.gateway_transaction_id!s}, ' + f'gateway_used={self.gateway_used!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'ach_late_reject={self.ach_late_reject!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_response.py b/advancedbilling/models/invoice_response.py index fe846bc9..640cd4b1 100644 --- a/advancedbilling/models/invoice_response.py +++ b/advancedbilling/models/invoice_response.py @@ -13,10 +13,8 @@ class InvoiceResponse(object): """Implementation of the 'Invoice Response' model. - TODO: type model description here. - Attributes: - invoice (Invoice): TODO: type description here. + invoice (Invoice): The model property of type Invoice. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(invoice, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'invoice={self.invoice!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'invoice={self.invoice!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_role.py b/advancedbilling/models/invoice_role.py index 9f33278d..49389aaf 100644 --- a/advancedbilling/models/invoice_role.py +++ b/advancedbilling/models/invoice_role.py @@ -12,19 +12,17 @@ class InvoiceRole(object): """Implementation of the 'Invoice Role' enum. - TODO: type enum description here. - Attributes: - UNSET: TODO: type description here. - SIGNUP: TODO: type description here. - RENEWAL: TODO: type description here. - USAGE: TODO: type description here. - REACTIVATION: TODO: type description here. - PRORATION: TODO: type description here. - MIGRATION: TODO: type description here. - ADHOC: TODO: type description here. - BACKPORT: TODO: type description here. - BACKPORTBALANCERECONCILIATION: TODO: type description here. + UNSET: The enum member of type str. + SIGNUP: The enum member of type str. + RENEWAL: The enum member of type str. + USAGE: The enum member of type str. + REACTIVATION: The enum member of type str. + PRORATION: The enum member of type str. + MIGRATION: The enum member of type str. + ADHOC: The enum member of type str. + BACKPORT: The enum member of type str. + BACKPORTBALANCERECONCILIATION: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_seller.py b/advancedbilling/models/invoice_seller.py index ee931a15..7a64d883 100644 --- a/advancedbilling/models/invoice_seller.py +++ b/advancedbilling/models/invoice_seller.py @@ -18,10 +18,10 @@ class InvoiceSeller(object): invoice. Attributes: - name (str): TODO: type description here. - address (InvoiceAddress): TODO: type description here. - phone (str): TODO: type description here. - logo_url (str): TODO: type description here. + name (str): The model property of type str. + address (InvoiceAddress): The model property of type InvoiceAddress. + phone (str): The model property of type str. + logo_url (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -122,3 +122,19 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'address={self.address!r}, ' + f'phone={self.phone!r}, ' + f'logo_url={self.logo_url!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'address={self.address!s}, ' + f'phone={self.phone!s}, ' + f'logo_url={self.logo_url!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_sort_field.py b/advancedbilling/models/invoice_sort_field.py index aab82e18..1c05f3f1 100644 --- a/advancedbilling/models/invoice_sort_field.py +++ b/advancedbilling/models/invoice_sort_field.py @@ -12,17 +12,15 @@ class InvoiceSortField(object): """Implementation of the 'Invoice Sort Field' enum. - TODO: type enum description here. - Attributes: - STATUS: TODO: type description here. - TOTAL_AMOUNT: TODO: type description here. - DUE_AMOUNT: TODO: type description here. - CREATED_AT: TODO: type description here. - UPDATED_AT: TODO: type description here. - ISSUE_DATE: TODO: type description here. - DUE_DATE: TODO: type description here. - NUMBER: TODO: type description here. + STATUS: The enum member of type str. + TOTAL_AMOUNT: The enum member of type str. + DUE_AMOUNT: The enum member of type str. + CREATED_AT: The enum member of type str. + UPDATED_AT: The enum member of type str. + ISSUE_DATE: The enum member of type str. + DUE_DATE: The enum member of type str. + NUMBER: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_status.py b/advancedbilling/models/invoice_status.py index 656c3ad7..65e23a93 100644 --- a/advancedbilling/models/invoice_status.py +++ b/advancedbilling/models/invoice_status.py @@ -17,13 +17,13 @@ class InvoiceStatus(object): ed-Billing-Invoices-Overview#invoice-statuses) for more. Attributes: - DRAFT: TODO: type description here. - OPEN: TODO: type description here. - PAID: TODO: type description here. - PENDING: TODO: type description here. - VOIDED: TODO: type description here. - CANCELED: TODO: type description here. - PROCESSING: TODO: type description here. + DRAFT: The enum member of type str. + OPEN: The enum member of type str. + PAID: The enum member of type str. + PENDING: The enum member of type str. + VOIDED: The enum member of type str. + CANCELED: The enum member of type str. + PROCESSING: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/invoice_tax.py b/advancedbilling/models/invoice_tax.py index fae04a49..e0f4b3df 100644 --- a/advancedbilling/models/invoice_tax.py +++ b/advancedbilling/models/invoice_tax.py @@ -15,26 +15,24 @@ class InvoiceTax(object): """Implementation of the 'Invoice Tax' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - title (str): TODO: type description here. - description (str): TODO: type description here. - source_type (ProformaInvoiceTaxSourceType): TODO: type description - here. - source_id (int): TODO: type description here. - percentage (str): TODO: type description here. - taxable_amount (str): TODO: type description here. - tax_amount (str): TODO: type description here. - transaction_id (int): TODO: type description here. - line_item_breakouts (List[InvoiceTaxBreakout]): TODO: type description - here. - tax_component_breakouts (List[InvoiceTaxComponentBreakout]): TODO: - type description here. - eu_vat (bool): TODO: type description here. - mtype (str): TODO: type description here. - tax_exempt_amount (str): TODO: type description here. + uid (str): The model property of type str. + title (str): The model property of type str. + description (str): The model property of type str. + source_type (ProformaInvoiceTaxSourceType): The model property of type + ProformaInvoiceTaxSourceType. + source_id (int): The model property of type int. + percentage (str): The model property of type str. + taxable_amount (str): The model property of type str. + tax_amount (str): The model property of type str. + transaction_id (int): The model property of type int. + line_item_breakouts (List[InvoiceTaxBreakout]): The model property of + type List[InvoiceTaxBreakout]. + tax_component_breakouts (List[InvoiceTaxComponentBreakout]): The model + property of type List[InvoiceTaxComponentBreakout]. + eu_vat (bool): The model property of type bool. + mtype (str): The model property of type str. + tax_exempt_amount (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -213,3 +211,39 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'title={self.title!r}, ' + f'description={self.description!r}, ' + f'source_type={self.source_type!r}, ' + f'source_id={self.source_id!r}, ' + f'percentage={self.percentage!r}, ' + f'taxable_amount={self.taxable_amount!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'transaction_id={self.transaction_id!r}, ' + f'line_item_breakouts={self.line_item_breakouts!r}, ' + f'tax_component_breakouts={self.tax_component_breakouts!r}, ' + f'eu_vat={self.eu_vat!r}, ' + f'mtype={self.mtype!r}, ' + f'tax_exempt_amount={self.tax_exempt_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'title={self.title!s}, ' + f'description={self.description!s}, ' + f'source_type={self.source_type!s}, ' + f'source_id={self.source_id!s}, ' + f'percentage={self.percentage!s}, ' + f'taxable_amount={self.taxable_amount!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'transaction_id={self.transaction_id!s}, ' + f'line_item_breakouts={self.line_item_breakouts!s}, ' + f'tax_component_breakouts={self.tax_component_breakouts!s}, ' + f'eu_vat={self.eu_vat!s}, ' + f'mtype={self.mtype!s}, ' + f'tax_exempt_amount={self.tax_exempt_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_tax_breakout.py b/advancedbilling/models/invoice_tax_breakout.py index 90d3ea05..45b66103 100644 --- a/advancedbilling/models/invoice_tax_breakout.py +++ b/advancedbilling/models/invoice_tax_breakout.py @@ -13,13 +13,11 @@ class InvoiceTaxBreakout(object): """Implementation of the 'Invoice Tax Breakout' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - taxable_amount (str): TODO: type description here. - tax_amount (str): TODO: type description here. - tax_exempt_amount (str): TODO: type description here. + uid (str): The model property of type str. + taxable_amount (str): The model property of type str. + tax_amount (str): The model property of type str. + tax_exempt_amount (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -116,3 +114,19 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'taxable_amount={self.taxable_amount!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'tax_exempt_amount={self.tax_exempt_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'taxable_amount={self.taxable_amount!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'tax_exempt_amount={self.tax_exempt_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/invoice_tax_component_breakout.py b/advancedbilling/models/invoice_tax_component_breakout.py index 04143819..6686b0e2 100644 --- a/advancedbilling/models/invoice_tax_component_breakout.py +++ b/advancedbilling/models/invoice_tax_component_breakout.py @@ -13,23 +13,21 @@ class InvoiceTaxComponentBreakout(object): """Implementation of the 'Invoice Tax Component Breakout' model. - TODO: type model description here. - Attributes: - tax_rule_id (int): TODO: type description here. - percentage (str): TODO: type description here. - country_code (str): TODO: type description here. - subdivision_code (str): TODO: type description here. - tax_amount (str): TODO: type description here. - taxable_amount (str): TODO: type description here. - tax_exempt_amount (str): TODO: type description here. - non_taxable_amount (str): TODO: type description here. - tax_name (str): TODO: type description here. - tax_type (str): TODO: type description here. - rate_type (str): TODO: type description here. - tax_authority_type (int): TODO: type description here. - state_assigned_no (str): TODO: type description here. - tax_sub_type (str): TODO: type description here. + tax_rule_id (int): The model property of type int. + percentage (str): The model property of type str. + country_code (str): The model property of type str. + subdivision_code (str): The model property of type str. + tax_amount (str): The model property of type str. + taxable_amount (str): The model property of type str. + tax_exempt_amount (str): The model property of type str. + non_taxable_amount (str): The model property of type str. + tax_name (str): The model property of type str. + tax_type (str): The model property of type str. + rate_type (str): The model property of type str. + tax_authority_type (int): The model property of type int. + state_assigned_no (str): The model property of type str. + tax_sub_type (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -196,3 +194,39 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'tax_rule_id={self.tax_rule_id!r}, ' + f'percentage={self.percentage!r}, ' + f'country_code={self.country_code!r}, ' + f'subdivision_code={self.subdivision_code!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'taxable_amount={self.taxable_amount!r}, ' + f'tax_exempt_amount={self.tax_exempt_amount!r}, ' + f'non_taxable_amount={self.non_taxable_amount!r}, ' + f'tax_name={self.tax_name!r}, ' + f'tax_type={self.tax_type!r}, ' + f'rate_type={self.rate_type!r}, ' + f'tax_authority_type={self.tax_authority_type!r}, ' + f'state_assigned_no={self.state_assigned_no!r}, ' + f'tax_sub_type={self.tax_sub_type!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'tax_rule_id={self.tax_rule_id!s}, ' + f'percentage={self.percentage!s}, ' + f'country_code={self.country_code!s}, ' + f'subdivision_code={self.subdivision_code!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'taxable_amount={self.taxable_amount!s}, ' + f'tax_exempt_amount={self.tax_exempt_amount!s}, ' + f'non_taxable_amount={self.non_taxable_amount!s}, ' + f'tax_name={self.tax_name!s}, ' + f'tax_type={self.tax_type!s}, ' + f'rate_type={self.rate_type!s}, ' + f'tax_authority_type={self.tax_authority_type!s}, ' + f'state_assigned_no={self.state_assigned_no!s}, ' + f'tax_sub_type={self.tax_sub_type!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/issue_advance_invoice_request.py b/advancedbilling/models/issue_advance_invoice_request.py index 197492b9..a5a94137 100644 --- a/advancedbilling/models/issue_advance_invoice_request.py +++ b/advancedbilling/models/issue_advance_invoice_request.py @@ -13,10 +13,8 @@ class IssueAdvanceInvoiceRequest(object): """Implementation of the 'Issue Advance Invoice Request' model. - TODO: type model description here. - Attributes: - force (bool): TODO: type description here. + force (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(force, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'force={self.force!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'force={self.force!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/issue_invoice_event.py b/advancedbilling/models/issue_invoice_event.py index d5643f56..6ac5a121 100644 --- a/advancedbilling/models/issue_invoice_event.py +++ b/advancedbilling/models/issue_invoice_event.py @@ -16,13 +16,12 @@ class IssueInvoiceEvent(object): """Implementation of the 'Issue Invoice Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (IssueInvoiceEventData): Example schema for an `issue_invoice` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: IssueInvoiceEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/issue_invoice_event_data.py b/advancedbilling/models/issue_invoice_event_data.py index 3966e08e..afd35a2d 100644 --- a/advancedbilling/models/issue_invoice_event_data.py +++ b/advancedbilling/models/issue_invoice_event_data.py @@ -149,3 +149,21 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('total_amount'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'consolidation_level={self.consolidation_level!r}, ' + f'from_status={self.from_status!r}, ' + f'to_status={self.to_status!r}, ' + f'due_amount={self.due_amount!r}, ' + f'total_amount={self.total_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'consolidation_level={self.consolidation_level!s}, ' + f'from_status={self.from_status!s}, ' + f'to_status={self.to_status!s}, ' + f'due_amount={self.due_amount!s}, ' + f'total_amount={self.total_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/issue_invoice_request.py b/advancedbilling/models/issue_invoice_request.py index aef238aa..f9d7d9ae 100644 --- a/advancedbilling/models/issue_invoice_request.py +++ b/advancedbilling/models/issue_invoice_request.py @@ -13,8 +13,6 @@ class IssueInvoiceRequest(object): """Implementation of the 'Issue Invoice Request' model. - TODO: type model description here. - Attributes: on_failed_payment (FailedPaymentAction): Action taken when payment for an invoice fails: - `leave_open_invoice` - prepayments and credits @@ -82,3 +80,13 @@ def from_dictionary(cls, # Return an object of this model return cls(on_failed_payment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'on_failed_payment={self.on_failed_payment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'on_failed_payment={self.on_failed_payment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/issue_service_credit.py b/advancedbilling/models/issue_service_credit.py index 5224c16e..85251f15 100644 --- a/advancedbilling/models/issue_service_credit.py +++ b/advancedbilling/models/issue_service_credit.py @@ -13,11 +13,9 @@ class IssueServiceCredit(object): """Implementation of the 'Issue Service Credit' model. - TODO: type model description here. - Attributes: - amount (float | str): TODO: type description here. - memo (str): TODO: type description here. + amount (float | str): The model property of type float | str. + memo (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -100,3 +98,15 @@ def validate(cls, dictionary): return False return UnionTypeLookUp.get('IssueServiceCreditAmount').validate(dictionary.get('amount')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!r}, ' + f'memo={self.memo!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!s}, ' + f'memo={self.memo!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/issue_service_credit_request.py b/advancedbilling/models/issue_service_credit_request.py index 0fbb5179..5b11032b 100644 --- a/advancedbilling/models/issue_service_credit_request.py +++ b/advancedbilling/models/issue_service_credit_request.py @@ -13,10 +13,9 @@ class IssueServiceCreditRequest(object): """Implementation of the 'Issue Service Credit Request' model. - TODO: type model description here. - Attributes: - service_credit (IssueServiceCredit): TODO: type description here. + service_credit (IssueServiceCredit): The model property of type + IssueServiceCredit. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(service_credit, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'service_credit={self.service_credit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'service_credit={self.service_credit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/item_category.py b/advancedbilling/models/item_category.py index d28844fc..204c6fa5 100644 --- a/advancedbilling/models/item_category.py +++ b/advancedbilling/models/item_category.py @@ -16,11 +16,11 @@ class ItemCategory(object): Services, Physical Goods, Other Attributes: - ENUM_BUSINESS SOFTWARE: TODO: type description here. - ENUM_CONSUMER SOFTWARE: TODO: type description here. - ENUM_DIGITAL SERVICES: TODO: type description here. - ENUM_PHYSICAL GOODS: TODO: type description here. - OTHER: TODO: type description here. + ENUM_BUSINESS SOFTWARE: The enum member of type str. + ENUM_CONSUMER SOFTWARE: The enum member of type str. + ENUM_DIGITAL SERVICES: The enum member of type str. + ENUM_PHYSICAL GOODS: The enum member of type str. + OTHER: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/item_price_point_changed.py b/advancedbilling/models/item_price_point_changed.py index 43f22a93..46320086 100644 --- a/advancedbilling/models/item_price_point_changed.py +++ b/advancedbilling/models/item_price_point_changed.py @@ -14,15 +14,15 @@ class ItemPricePointChanged(object): """Implementation of the 'Item Price Point Changed' model. - TODO: type model description here. - Attributes: - item_id (int): TODO: type description here. - item_type (str): TODO: type description here. - item_handle (str): TODO: type description here. - item_name (str): TODO: type description here. - previous_price_point (ItemPricePointData): TODO: type description here. - current_price_point (ItemPricePointData): TODO: type description here. + item_id (int): The model property of type int. + item_type (str): The model property of type str. + item_handle (str): The model property of type str. + item_name (str): The model property of type str. + previous_price_point (ItemPricePointData): The model property of type + ItemPricePointData. + current_price_point (ItemPricePointData): The model property of type + ItemPricePointData. additional_properties (Dict[str, object]): The additional properties for the model. @@ -144,3 +144,23 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('current_price_point'), type_callable=lambda value: ItemPricePointData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'item_id={self.item_id!r}, ' + f'item_type={self.item_type!r}, ' + f'item_handle={self.item_handle!r}, ' + f'item_name={self.item_name!r}, ' + f'previous_price_point={self.previous_price_point!r}, ' + f'current_price_point={self.current_price_point!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'item_id={self.item_id!s}, ' + f'item_type={self.item_type!s}, ' + f'item_handle={self.item_handle!s}, ' + f'item_name={self.item_name!s}, ' + f'previous_price_point={self.previous_price_point!s}, ' + f'current_price_point={self.current_price_point!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/item_price_point_data.py b/advancedbilling/models/item_price_point_data.py index 0af0cd01..34657235 100644 --- a/advancedbilling/models/item_price_point_data.py +++ b/advancedbilling/models/item_price_point_data.py @@ -13,12 +13,10 @@ class ItemPricePointData(object): """Implementation of the 'Item Price Point Data' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - handle (str): TODO: type description here. - name (str): TODO: type description here. + id (int): The model property of type int. + handle (str): The model property of type str. + name (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -108,3 +106,17 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'handle={self.handle!r}, ' + f'name={self.name!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'handle={self.handle!s}, ' + f'name={self.name!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/line_item_kind.py b/advancedbilling/models/line_item_kind.py index 369cd0d9..6f203596 100644 --- a/advancedbilling/models/line_item_kind.py +++ b/advancedbilling/models/line_item_kind.py @@ -15,16 +15,16 @@ class LineItemKind(object): A handle for the line item kind Attributes: - BASELINE: TODO: type description here. - INITIAL: TODO: type description here. - TRIAL: TODO: type description here. - QUANTITY_BASED_COMPONENT: TODO: type description here. - PREPAID_USAGE_COMPONENT: TODO: type description here. - ON_OFF_COMPONENT: TODO: type description here. - METERED_COMPONENT: TODO: type description here. - EVENT_BASED_COMPONENT: TODO: type description here. - COUPON: TODO: type description here. - TAX: TODO: type description here. + BASELINE: The enum member of type str. + INITIAL: The enum member of type str. + TRIAL: The enum member of type str. + QUANTITY_BASED_COMPONENT: The enum member of type str. + PREPAID_USAGE_COMPONENT: The enum member of type str. + ON_OFF_COMPONENT: The enum member of type str. + METERED_COMPONENT: The enum member of type str. + EVENT_BASED_COMPONENT: The enum member of type str. + COUPON: The enum member of type str. + TAX: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/line_item_transaction_type.py b/advancedbilling/models/line_item_transaction_type.py index 0f9992f2..f70ea700 100644 --- a/advancedbilling/models/line_item_transaction_type.py +++ b/advancedbilling/models/line_item_transaction_type.py @@ -15,13 +15,13 @@ class LineItemTransactionType(object): A handle for the line item transaction type Attributes: - CHARGE: TODO: type description here. - CREDIT: TODO: type description here. - ADJUSTMENT: TODO: type description here. - PAYMENT: TODO: type description here. - REFUND: TODO: type description here. - INFO_TRANSACTION: TODO: type description here. - PAYMENT_AUTHORIZATION: TODO: type description here. + CHARGE: The enum member of type str. + CREDIT: The enum member of type str. + ADJUSTMENT: The enum member of type str. + PAYMENT: The enum member of type str. + REFUND: The enum member of type str. + INFO_TRANSACTION: The enum member of type str. + PAYMENT_AUTHORIZATION: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/list_components_filter.py b/advancedbilling/models/list_components_filter.py index 0fe7b7c1..b595c092 100644 --- a/advancedbilling/models/list_components_filter.py +++ b/advancedbilling/models/list_components_filter.py @@ -13,8 +13,6 @@ class ListComponentsFilter(object): """Implementation of the 'List Components Filter' model. - TODO: type model description here. - Attributes: ids (List[int]): Allows fetching components with matching id based on provided value. Use in query `filter[ids]=1,2,3`. @@ -82,3 +80,15 @@ def from_dictionary(cls, return cls(ids, use_site_exchange_rate, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'ids={self.ids!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'ids={self.ids!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_components_price_points_include.py b/advancedbilling/models/list_components_price_points_include.py index edeb30bf..f836e396 100644 --- a/advancedbilling/models/list_components_price_points_include.py +++ b/advancedbilling/models/list_components_price_points_include.py @@ -12,10 +12,8 @@ class ListComponentsPricePointsInclude(object): """Implementation of the 'List Components Price Points Include' enum. - TODO: type enum description here. - Attributes: - CURRENCY_PRICES: TODO: type description here. + CURRENCY_PRICES: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/list_components_price_points_response.py b/advancedbilling/models/list_components_price_points_response.py index ab0d4000..8b912896 100644 --- a/advancedbilling/models/list_components_price_points_response.py +++ b/advancedbilling/models/list_components_price_points_response.py @@ -13,10 +13,9 @@ class ListComponentsPricePointsResponse(object): """Implementation of the 'List Components Price Points Response' model. - TODO: type model description here. - Attributes: - price_points (List[ComponentPricePoint]): TODO: type description here. + price_points (List[ComponentPricePoint]): The model property of type + List[ComponentPricePoint]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -67,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(price_points, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_coupons_filter.py b/advancedbilling/models/list_coupons_filter.py index 293391b0..1f766063 100644 --- a/advancedbilling/models/list_coupons_filter.py +++ b/advancedbilling/models/list_coupons_filter.py @@ -15,8 +15,6 @@ class ListCouponsFilter(object): """Implementation of the 'List Coupons Filter' model. - TODO: type model description here. - Attributes: date_field (BasicDateField): The type of filter you would like to apply to your search. Use in query `filter[date_field]=created_at`. @@ -151,3 +149,27 @@ def from_dictionary(cls, codes, use_site_exchange_rate, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'date_field={self.date_field!r}, ' + f'start_date={self.start_date!r}, ' + f'end_date={self.end_date!r}, ' + f'start_datetime={self.start_datetime!r}, ' + f'end_datetime={self.end_datetime!r}, ' + f'ids={self.ids!r}, ' + f'codes={self.codes!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'date_field={self.date_field!s}, ' + f'start_date={self.start_date!s}, ' + f'end_date={self.end_date!s}, ' + f'start_datetime={self.start_datetime!s}, ' + f'end_datetime={self.end_datetime!s}, ' + f'ids={self.ids!s}, ' + f'codes={self.codes!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_credit_notes_response.py b/advancedbilling/models/list_credit_notes_response.py index b7587693..aae7153d 100644 --- a/advancedbilling/models/list_credit_notes_response.py +++ b/advancedbilling/models/list_credit_notes_response.py @@ -13,10 +13,9 @@ class ListCreditNotesResponse(object): """Implementation of the 'List Credit Notes Response' model. - TODO: type model description here. - Attributes: - credit_notes (List[CreditNote]): TODO: type description here. + credit_notes (List[CreditNote]): The model property of type + List[CreditNote]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -67,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(credit_notes, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'credit_notes={self.credit_notes!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'credit_notes={self.credit_notes!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_events_date_field.py b/advancedbilling/models/list_events_date_field.py index 97cb911a..c42029ef 100644 --- a/advancedbilling/models/list_events_date_field.py +++ b/advancedbilling/models/list_events_date_field.py @@ -12,10 +12,8 @@ class ListEventsDateField(object): """Implementation of the 'List Events Date Field' enum. - TODO: type enum description here. - Attributes: - CREATED_AT: TODO: type description here. + CREATED_AT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/list_invoice_events_response.py b/advancedbilling/models/list_invoice_events_response.py index 80fa56ae..d852f3b9 100644 --- a/advancedbilling/models/list_invoice_events_response.py +++ b/advancedbilling/models/list_invoice_events_response.py @@ -13,8 +13,6 @@ class ListInvoiceEventsResponse(object): """Implementation of the 'List Invoice Events Response' model. - TODO: type model description here. - Attributes: events (List[ApplyCreditNoteEvent | ApplyDebitNoteEvent | ApplyPaymentEvent | BackportInvoiceEvent | @@ -22,10 +20,17 @@ class ListInvoiceEventsResponse(object): ChangeInvoiceStatusEvent | CreateCreditNoteEvent | CreateDebitNoteEvent | FailedPaymentEvent | IssueInvoiceEvent | RefundInvoiceEvent | RemovePaymentEvent | VoidInvoiceEvent | - VoidRemainderEvent] | None): TODO: type description here. - page (int): TODO: type description here. - per_page (int): TODO: type description here. - total_pages (int): TODO: type description here. + VoidRemainderEvent] | None): The model property of type + List[ApplyCreditNoteEvent | ApplyDebitNoteEvent | + ApplyPaymentEvent | BackportInvoiceEvent | + ChangeChargebackStatusEvent | ChangeInvoiceCollectionMethodEvent | + ChangeInvoiceStatusEvent | CreateCreditNoteEvent | + CreateDebitNoteEvent | FailedPaymentEvent | IssueInvoiceEvent | + RefundInvoiceEvent | RemovePaymentEvent | VoidInvoiceEvent | + VoidRemainderEvent] | None. + page (int): The model property of type int. + per_page (int): The model property of type int. + total_pages (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -101,3 +106,19 @@ def from_dictionary(cls, per_page, total_pages, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'events={self.events!r}, ' + f'page={self.page!r}, ' + f'per_page={self.per_page!r}, ' + f'total_pages={self.total_pages!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'events={self.events!s}, ' + f'page={self.page!s}, ' + f'per_page={self.per_page!s}, ' + f'total_pages={self.total_pages!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_invoices_response.py b/advancedbilling/models/list_invoices_response.py index d3dec179..ad3d3cb4 100644 --- a/advancedbilling/models/list_invoices_response.py +++ b/advancedbilling/models/list_invoices_response.py @@ -13,10 +13,8 @@ class ListInvoicesResponse(object): """Implementation of the 'List Invoices Response' model. - TODO: type model description here. - Attributes: - invoices (List[Invoice]): TODO: type description here. + invoices (List[Invoice]): The model property of type List[Invoice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -67,3 +65,13 @@ def from_dictionary(cls, # Return an object of this model return cls(invoices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'invoices={self.invoices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'invoices={self.invoices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_metafields_response.py b/advancedbilling/models/list_metafields_response.py index 28dc2a06..d103fe01 100644 --- a/advancedbilling/models/list_metafields_response.py +++ b/advancedbilling/models/list_metafields_response.py @@ -14,14 +14,13 @@ class ListMetafieldsResponse(object): """Implementation of the 'List Metafields Response' model. - TODO: type model description here. - Attributes: - total_count (int): TODO: type description here. - current_page (int): TODO: type description here. - total_pages (int): TODO: type description here. - per_page (int): TODO: type description here. - metafields (List[Metafield]): TODO: type description here. + total_count (int): The model property of type int. + current_page (int): The model property of type int. + total_pages (int): The model property of type int. + per_page (int): The model property of type int. + metafields (List[Metafield]): The model property of type + List[Metafield]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -107,3 +106,21 @@ def from_dictionary(cls, per_page, metafields, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'total_count={self.total_count!r}, ' + f'current_page={self.current_page!r}, ' + f'total_pages={self.total_pages!r}, ' + f'per_page={self.per_page!r}, ' + f'metafields={self.metafields!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'total_count={self.total_count!s}, ' + f'current_page={self.current_page!s}, ' + f'total_pages={self.total_pages!s}, ' + f'per_page={self.per_page!s}, ' + f'metafields={self.metafields!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_mrr_filter.py b/advancedbilling/models/list_mrr_filter.py index fce6576b..dc2d841f 100644 --- a/advancedbilling/models/list_mrr_filter.py +++ b/advancedbilling/models/list_mrr_filter.py @@ -13,8 +13,6 @@ class ListMrrFilter(object): """Implementation of the 'List Mrr Filter' model. - TODO: type model description here. - Attributes: subscription_ids (List[int]): Submit ids in order to limit results. Use in query: `filter[subscription_ids]=1,2,3`. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription_ids, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_ids={self.subscription_ids!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_ids={self.subscription_ids!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_mrr_response.py b/advancedbilling/models/list_mrr_response.py index fb6092d7..a40991be 100644 --- a/advancedbilling/models/list_mrr_response.py +++ b/advancedbilling/models/list_mrr_response.py @@ -13,10 +13,9 @@ class ListMRRResponse(object): """Implementation of the 'List MRR Response' model. - TODO: type model description here. - Attributes: - mrr (ListMRRResponseResult): TODO: type description here. + mrr (ListMRRResponseResult): The model property of type + ListMRRResponseResult. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(mrr, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'mrr={self.mrr!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'mrr={self.mrr!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_mrr_response_result.py b/advancedbilling/models/list_mrr_response_result.py index 25c15c4e..ae4e5a0e 100644 --- a/advancedbilling/models/list_mrr_response_result.py +++ b/advancedbilling/models/list_mrr_response_result.py @@ -14,16 +14,14 @@ class ListMRRResponseResult(object): """Implementation of the 'List MRR Response Result' model. - TODO: type model description here. - Attributes: - page (int): TODO: type description here. - per_page (int): TODO: type description here. - total_pages (int): TODO: type description here. - total_entries (int): TODO: type description here. - currency (str): TODO: type description here. - currency_symbol (str): TODO: type description here. - movements (List[Movement]): TODO: type description here. + page (int): The model property of type int. + per_page (int): The model property of type int. + total_pages (int): The model property of type int. + total_entries (int): The model property of type int. + currency (str): The model property of type str. + currency_symbol (str): The model property of type str. + movements (List[Movement]): The model property of type List[Movement]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -123,3 +121,25 @@ def from_dictionary(cls, currency_symbol, movements, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'page={self.page!r}, ' + f'per_page={self.per_page!r}, ' + f'total_pages={self.total_pages!r}, ' + f'total_entries={self.total_entries!r}, ' + f'currency={self.currency!r}, ' + f'currency_symbol={self.currency_symbol!r}, ' + f'movements={self.movements!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'page={self.page!s}, ' + f'per_page={self.per_page!s}, ' + f'total_pages={self.total_pages!s}, ' + f'total_entries={self.total_entries!s}, ' + f'currency={self.currency!s}, ' + f'currency_symbol={self.currency_symbol!s}, ' + f'movements={self.movements!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_offers_response.py b/advancedbilling/models/list_offers_response.py index ccc85552..5a089cbc 100644 --- a/advancedbilling/models/list_offers_response.py +++ b/advancedbilling/models/list_offers_response.py @@ -14,10 +14,8 @@ class ListOffersResponse(object): """Implementation of the 'List Offers Response' model. - TODO: type model description here. - Attributes: - offers (List[Offer]): TODO: type description here. + offers (List[Offer]): The model property of type List[Offer]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -75,3 +73,13 @@ def from_dictionary(cls, # Return an object of this model return cls(offers, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'offers={self.offers!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'offers={self.offers!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_prepayment_date_field.py b/advancedbilling/models/list_prepayment_date_field.py index 26a9e11a..ee87de58 100644 --- a/advancedbilling/models/list_prepayment_date_field.py +++ b/advancedbilling/models/list_prepayment_date_field.py @@ -12,11 +12,9 @@ class ListPrepaymentDateField(object): """Implementation of the 'List Prepayment Date Field' enum. - TODO: type enum description here. - Attributes: - CREATED_AT: TODO: type description here. - APPLICATION_AT: TODO: type description here. + CREATED_AT: The enum member of type str. + APPLICATION_AT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/list_prepayments_filter.py b/advancedbilling/models/list_prepayments_filter.py index a8650c5d..1f678213 100644 --- a/advancedbilling/models/list_prepayments_filter.py +++ b/advancedbilling/models/list_prepayments_filter.py @@ -15,8 +15,6 @@ class ListPrepaymentsFilter(object): """Implementation of the 'List Prepayments Filter' model. - TODO: type model description here. - Attributes: date_field (ListPrepaymentDateField): The type of filter you would like to apply to your search. `created_at` - Time when prepayment @@ -97,3 +95,17 @@ def from_dictionary(cls, start_date, end_date, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'date_field={self.date_field!r}, ' + f'start_date={self.start_date!r}, ' + f'end_date={self.end_date!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'date_field={self.date_field!s}, ' + f'start_date={self.start_date!s}, ' + f'end_date={self.end_date!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_price_points_filter.py b/advancedbilling/models/list_price_points_filter.py index 3fa190ff..e786b701 100644 --- a/advancedbilling/models/list_price_points_filter.py +++ b/advancedbilling/models/list_price_points_filter.py @@ -15,8 +15,6 @@ class ListPricePointsFilter(object): """Implementation of the 'List PricePoints Filter' model. - TODO: type model description here. - Attributes: date_field (BasicDateField): The type of filter you would like to apply to your search. Use in query: @@ -150,3 +148,27 @@ def from_dictionary(cls, ids, archived_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'date_field={self.date_field!r}, ' + f'start_date={self.start_date!r}, ' + f'end_date={self.end_date!r}, ' + f'start_datetime={self.start_datetime!r}, ' + f'end_datetime={self.end_datetime!r}, ' + f'mtype={self.mtype!r}, ' + f'ids={self.ids!r}, ' + f'archived_at={self.archived_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'date_field={self.date_field!s}, ' + f'start_date={self.start_date!s}, ' + f'end_date={self.end_date!s}, ' + f'start_datetime={self.start_datetime!s}, ' + f'end_datetime={self.end_datetime!s}, ' + f'mtype={self.mtype!s}, ' + f'ids={self.ids!s}, ' + f'archived_at={self.archived_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_product_price_points_response.py b/advancedbilling/models/list_product_price_points_response.py index 6b04ed4e..6ff2b240 100644 --- a/advancedbilling/models/list_product_price_points_response.py +++ b/advancedbilling/models/list_product_price_points_response.py @@ -13,10 +13,9 @@ class ListProductPricePointsResponse(object): """Implementation of the 'List Product Price Points Response' model. - TODO: type model description here. - Attributes: - price_points (List[ProductPricePoint]): TODO: type description here. + price_points (List[ProductPricePoint]): The model property of type + List[ProductPricePoint]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -67,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(price_points, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_points={self.price_points!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_products_filter.py b/advancedbilling/models/list_products_filter.py index 108b238b..29189f79 100644 --- a/advancedbilling/models/list_products_filter.py +++ b/advancedbilling/models/list_products_filter.py @@ -14,8 +14,6 @@ class ListProductsFilter(object): """Implementation of the 'List Products Filter' model. - TODO: type model description here. - Attributes: ids (List[int]): Allows fetching products with matching id based on provided values. Use in query `filter[ids]=1,2,3`. @@ -96,3 +94,17 @@ def from_dictionary(cls, prepaid_product_price_point, use_site_exchange_rate, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'ids={self.ids!r}, ' + f'prepaid_product_price_point={self.prepaid_product_price_point!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'ids={self.ids!s}, ' + f'prepaid_product_price_point={self.prepaid_product_price_point!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_products_include.py b/advancedbilling/models/list_products_include.py index 897731f0..32b25d76 100644 --- a/advancedbilling/models/list_products_include.py +++ b/advancedbilling/models/list_products_include.py @@ -12,10 +12,8 @@ class ListProductsInclude(object): """Implementation of the 'List Products Include' enum. - TODO: type enum description here. - Attributes: - PREPAID_PRODUCT_PRICE_POINT: TODO: type description here. + PREPAID_PRODUCT_PRICE_POINT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/list_products_price_points_include.py b/advancedbilling/models/list_products_price_points_include.py index affd9709..af67a74b 100644 --- a/advancedbilling/models/list_products_price_points_include.py +++ b/advancedbilling/models/list_products_price_points_include.py @@ -12,10 +12,8 @@ class ListProductsPricePointsInclude(object): """Implementation of the 'List Products Price Points Include' enum. - TODO: type enum description here. - Attributes: - CURRENCY_PRICES: TODO: type description here. + CURRENCY_PRICES: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/list_proforma_invoices_meta.py b/advancedbilling/models/list_proforma_invoices_meta.py index 6de2099b..b2c1180e 100644 --- a/advancedbilling/models/list_proforma_invoices_meta.py +++ b/advancedbilling/models/list_proforma_invoices_meta.py @@ -13,13 +13,11 @@ class ListProformaInvoicesMeta(object): """Implementation of the 'List Proforma Invoices Meta' model. - TODO: type model description here. - Attributes: - total_count (int): TODO: type description here. - current_page (int): TODO: type description here. - total_pages (int): TODO: type description here. - status_code (int): TODO: type description here. + total_count (int): The model property of type int. + current_page (int): The model property of type int. + total_pages (int): The model property of type int. + status_code (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -94,3 +92,19 @@ def from_dictionary(cls, total_pages, status_code, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'total_count={self.total_count!r}, ' + f'current_page={self.current_page!r}, ' + f'total_pages={self.total_pages!r}, ' + f'status_code={self.status_code!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'total_count={self.total_count!s}, ' + f'current_page={self.current_page!s}, ' + f'total_pages={self.total_pages!s}, ' + f'status_code={self.status_code!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_proforma_invoices_response.py b/advancedbilling/models/list_proforma_invoices_response.py index 13d7b1d5..9bb3a965 100644 --- a/advancedbilling/models/list_proforma_invoices_response.py +++ b/advancedbilling/models/list_proforma_invoices_response.py @@ -15,11 +15,11 @@ class ListProformaInvoicesResponse(object): """Implementation of the 'List Proforma Invoices Response' model. - TODO: type model description here. - Attributes: - proforma_invoices (List[ProformaInvoice]): TODO: type description here. - meta (ListProformaInvoicesMeta): TODO: type description here. + proforma_invoices (List[ProformaInvoice]): The model property of type + List[ProformaInvoice]. + meta (ListProformaInvoicesMeta): The model property of type + ListProformaInvoicesMeta. additional_properties (Dict[str, object]): The additional properties for the model. @@ -84,3 +84,15 @@ def from_dictionary(cls, return cls(proforma_invoices, meta, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'proforma_invoices={self.proforma_invoices!r}, ' + f'meta={self.meta!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'proforma_invoices={self.proforma_invoices!s}, ' + f'meta={self.meta!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_public_keys_meta.py b/advancedbilling/models/list_public_keys_meta.py index 27707d5f..35078bff 100644 --- a/advancedbilling/models/list_public_keys_meta.py +++ b/advancedbilling/models/list_public_keys_meta.py @@ -13,13 +13,11 @@ class ListPublicKeysMeta(object): """Implementation of the 'List Public Keys Meta' model. - TODO: type model description here. - Attributes: - total_count (int): TODO: type description here. - current_page (int): TODO: type description here. - total_pages (int): TODO: type description here. - per_page (int): TODO: type description here. + total_count (int): The model property of type int. + current_page (int): The model property of type int. + total_pages (int): The model property of type int. + per_page (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -94,3 +92,19 @@ def from_dictionary(cls, total_pages, per_page, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'total_count={self.total_count!r}, ' + f'current_page={self.current_page!r}, ' + f'total_pages={self.total_pages!r}, ' + f'per_page={self.per_page!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'total_count={self.total_count!s}, ' + f'current_page={self.current_page!s}, ' + f'total_pages={self.total_pages!s}, ' + f'per_page={self.per_page!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_public_keys_response.py b/advancedbilling/models/list_public_keys_response.py index 5f139613..f62264b8 100644 --- a/advancedbilling/models/list_public_keys_response.py +++ b/advancedbilling/models/list_public_keys_response.py @@ -15,11 +15,11 @@ class ListPublicKeysResponse(object): """Implementation of the 'List Public Keys Response' model. - TODO: type model description here. - Attributes: - chargify_js_keys (List[PublicKey]): TODO: type description here. - meta (ListPublicKeysMeta): TODO: type description here. + chargify_js_keys (List[PublicKey]): The model property of type + List[PublicKey]. + meta (ListPublicKeysMeta): The model property of type + ListPublicKeysMeta. additional_properties (Dict[str, object]): The additional properties for the model. @@ -84,3 +84,15 @@ def from_dictionary(cls, return cls(chargify_js_keys, meta, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'chargify_js_keys={self.chargify_js_keys!r}, ' + f'meta={self.meta!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'chargify_js_keys={self.chargify_js_keys!s}, ' + f'meta={self.meta!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_sale_rep_item.py b/advancedbilling/models/list_sale_rep_item.py index f9718fbf..e8b3350a 100644 --- a/advancedbilling/models/list_sale_rep_item.py +++ b/advancedbilling/models/list_sale_rep_item.py @@ -14,14 +14,13 @@ class ListSaleRepItem(object): """Implementation of the 'List Sale Rep Item' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - full_name (str): TODO: type description here. - subscriptions_count (int): TODO: type description here. - mrr_data (Dict[str, SaleRepItemMrr]): TODO: type description here. - test_mode (bool): TODO: type description here. + id (int): The model property of type int. + full_name (str): The model property of type str. + subscriptions_count (int): The model property of type int. + mrr_data (Dict[str, SaleRepItemMrr]): The model property of type + Dict[str, SaleRepItemMrr]. + test_mode (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -103,3 +102,21 @@ def from_dictionary(cls, mrr_data, test_mode, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'full_name={self.full_name!r}, ' + f'subscriptions_count={self.subscriptions_count!r}, ' + f'mrr_data={self.mrr_data!r}, ' + f'test_mode={self.test_mode!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'full_name={self.full_name!s}, ' + f'subscriptions_count={self.subscriptions_count!s}, ' + f'mrr_data={self.mrr_data!s}, ' + f'test_mode={self.test_mode!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_segments_filter.py b/advancedbilling/models/list_segments_filter.py index dc873ac3..c6b0ab24 100644 --- a/advancedbilling/models/list_segments_filter.py +++ b/advancedbilling/models/list_segments_filter.py @@ -13,8 +13,6 @@ class ListSegmentsFilter(object): """Implementation of the 'List Segments Filter' model. - TODO: type model description here. - Attributes: segment_property_1_value (str): The value passed here would be used to filter segments. Pass a value related to `segment_property_1` on @@ -106,3 +104,19 @@ def from_dictionary(cls, segment_property_3_value, segment_property_4_value, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'segment_property_1_value={self.segment_property_1_value!r}, ' + f'segment_property_2_value={self.segment_property_2_value!r}, ' + f'segment_property_3_value={self.segment_property_3_value!r}, ' + f'segment_property_4_value={self.segment_property_4_value!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'segment_property_1_value={self.segment_property_1_value!s}, ' + f'segment_property_2_value={self.segment_property_2_value!s}, ' + f'segment_property_3_value={self.segment_property_3_value!s}, ' + f'segment_property_4_value={self.segment_property_4_value!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_segments_response.py b/advancedbilling/models/list_segments_response.py index c75fa24a..c3af0aca 100644 --- a/advancedbilling/models/list_segments_response.py +++ b/advancedbilling/models/list_segments_response.py @@ -14,10 +14,8 @@ class ListSegmentsResponse(object): """Implementation of the 'List Segments Response' model. - TODO: type model description here. - Attributes: - segments (List[Segment]): TODO: type description here. + segments (List[Segment]): The model property of type List[Segment]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -75,3 +73,13 @@ def from_dictionary(cls, # Return an object of this model return cls(segments, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'segments={self.segments!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'segments={self.segments!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_subcription_group_prepayment_item.py b/advancedbilling/models/list_subcription_group_prepayment_item.py index bcb5230a..c55273e6 100644 --- a/advancedbilling/models/list_subcription_group_prepayment_item.py +++ b/advancedbilling/models/list_subcription_group_prepayment_item.py @@ -13,18 +13,17 @@ class ListSubcriptionGroupPrepaymentItem(object): """Implementation of the 'List Subcription Group Prepayment Item' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - subscription_group_uid (str): TODO: type description here. - amount_in_cents (long|int): TODO: type description here. - remaining_amount_in_cents (long|int): TODO: type description here. - details (str): TODO: type description here. - external (bool): TODO: type description here. - memo (str): TODO: type description here. - payment_type (PrepaymentMethod): TODO: type description here. - created_at (datetime): TODO: type description here. + id (int): The model property of type int. + subscription_group_uid (str): The model property of type str. + amount_in_cents (int): The model property of type int. + remaining_amount_in_cents (int): The model property of type int. + details (str): The model property of type str. + external (bool): The model property of type bool. + memo (str): The model property of type str. + payment_type (PrepaymentMethod): The model property of type + PrepaymentMethod. + created_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -134,3 +133,29 @@ def from_dictionary(cls, payment_type, created_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'subscription_group_uid={self.subscription_group_uid!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'remaining_amount_in_cents={self.remaining_amount_in_cents!r}, ' + f'details={self.details!r}, ' + f'external={self.external!r}, ' + f'memo={self.memo!r}, ' + f'payment_type={self.payment_type!r}, ' + f'created_at={self.created_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'subscription_group_uid={self.subscription_group_uid!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'remaining_amount_in_cents={self.remaining_amount_in_cents!s}, ' + f'details={self.details!s}, ' + f'external={self.external!s}, ' + f'memo={self.memo!s}, ' + f'payment_type={self.payment_type!s}, ' + f'created_at={self.created_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_subscription_components_filter.py b/advancedbilling/models/list_subscription_components_filter.py index d0ebce00..0a6e2727 100644 --- a/advancedbilling/models/list_subscription_components_filter.py +++ b/advancedbilling/models/list_subscription_components_filter.py @@ -13,8 +13,6 @@ class ListSubscriptionComponentsFilter(object): """Implementation of the 'List Subscription Components Filter' model. - TODO: type model description here. - Attributes: currencies (List[str]): Allows fetching components allocation with matching currency based on provided values. Use in query @@ -82,3 +80,15 @@ def from_dictionary(cls, return cls(currencies, use_site_exchange_rate, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currencies={self.currencies!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currencies={self.currencies!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_subscription_components_for_site_filter.py b/advancedbilling/models/list_subscription_components_for_site_filter.py index 38277ca7..cf2c743c 100644 --- a/advancedbilling/models/list_subscription_components_for_site_filter.py +++ b/advancedbilling/models/list_subscription_components_for_site_filter.py @@ -14,8 +14,6 @@ class ListSubscriptionComponentsForSiteFilter(object): """Implementation of the 'List Subscription Components For Site Filter' model. - TODO: type model description here. - Attributes: currencies (List[str]): Allows fetching components allocation with matching currency based on provided values. Use in query @@ -92,3 +90,17 @@ def from_dictionary(cls, use_site_exchange_rate, subscription, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currencies={self.currencies!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'subscription={self.subscription!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currencies={self.currencies!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'subscription={self.subscription!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_subscription_components_include.py b/advancedbilling/models/list_subscription_components_include.py index 3753eee5..a1c42d02 100644 --- a/advancedbilling/models/list_subscription_components_include.py +++ b/advancedbilling/models/list_subscription_components_include.py @@ -12,11 +12,9 @@ class ListSubscriptionComponentsInclude(object): """Implementation of the 'List Subscription Components Include' enum. - TODO: type enum description here. - Attributes: - SUBSCRIPTION: TODO: type description here. - HISTORIC_USAGES: TODO: type description here. + SUBSCRIPTION: The enum member of type str. + HISTORIC_USAGES: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/list_subscription_components_response.py b/advancedbilling/models/list_subscription_components_response.py index 468c4035..a3d0e646 100644 --- a/advancedbilling/models/list_subscription_components_response.py +++ b/advancedbilling/models/list_subscription_components_response.py @@ -13,11 +13,9 @@ class ListSubscriptionComponentsResponse(object): """Implementation of the 'List Subscription Components Response' model. - TODO: type model description here. - Attributes: - subscriptions_components (List[SubscriptionComponent]): TODO: type - description here. + subscriptions_components (List[SubscriptionComponent]): The model + property of type List[SubscriptionComponent]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -68,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscriptions_components, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscriptions_components={self.subscriptions_components!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscriptions_components={self.subscriptions_components!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_subscription_components_sort.py b/advancedbilling/models/list_subscription_components_sort.py index b621ecf3..ae42e130 100644 --- a/advancedbilling/models/list_subscription_components_sort.py +++ b/advancedbilling/models/list_subscription_components_sort.py @@ -12,11 +12,9 @@ class ListSubscriptionComponentsSort(object): """Implementation of the 'List Subscription Components Sort' enum. - TODO: type enum description here. - Attributes: - ID: TODO: type description here. - UPDATED_AT: TODO: type description here. + ID: The enum member of type str. + UPDATED_AT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/list_subscription_group_prepayment.py b/advancedbilling/models/list_subscription_group_prepayment.py index 0be4c9f9..01a26f3e 100644 --- a/advancedbilling/models/list_subscription_group_prepayment.py +++ b/advancedbilling/models/list_subscription_group_prepayment.py @@ -13,11 +13,9 @@ class ListSubscriptionGroupPrepayment(object): """Implementation of the 'List Subscription Group Prepayment' model. - TODO: type model description here. - Attributes: - prepayment (ListSubcriptionGroupPrepaymentItem): TODO: type - description here. + prepayment (ListSubcriptionGroupPrepaymentItem): The model property of + type ListSubcriptionGroupPrepaymentItem. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(prepayment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepayment={self.prepayment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepayment={self.prepayment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_subscription_group_prepayment_response.py b/advancedbilling/models/list_subscription_group_prepayment_response.py index 0965f2ac..56987390 100644 --- a/advancedbilling/models/list_subscription_group_prepayment_response.py +++ b/advancedbilling/models/list_subscription_group_prepayment_response.py @@ -13,11 +13,9 @@ class ListSubscriptionGroupPrepaymentResponse(object): """Implementation of the 'List Subscription Group Prepayment Response' model. - TODO: type model description here. - Attributes: - prepayments (List[ListSubscriptionGroupPrepayment]): TODO: type - description here. + prepayments (List[ListSubscriptionGroupPrepayment]): The model + property of type List[ListSubscriptionGroupPrepayment]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -68,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(prepayments, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepayments={self.prepayments!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepayments={self.prepayments!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_subscription_groups_item.py b/advancedbilling/models/list_subscription_groups_item.py index 572b9348..ab8a4139 100644 --- a/advancedbilling/models/list_subscription_groups_item.py +++ b/advancedbilling/models/list_subscription_groups_item.py @@ -14,21 +14,19 @@ class ListSubscriptionGroupsItem(object): """Implementation of the 'List Subscription Groups Item' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - scheme (int): TODO: type description here. - customer_id (int): TODO: type description here. - payment_profile_id (int): TODO: type description here. - subscription_ids (List[int]): TODO: type description here. - primary_subscription_id (int): TODO: type description here. - next_assessment_at (datetime): TODO: type description here. - state (str): TODO: type description here. - cancel_at_end_of_period (bool): TODO: type description here. - account_balances (SubscriptionGroupBalances): TODO: type description - here. - group_type (GroupType): TODO: type description here. + uid (str): The model property of type str. + scheme (int): The model property of type int. + customer_id (int): The model property of type int. + payment_profile_id (int): The model property of type int. + subscription_ids (List[int]): The model property of type List[int]. + primary_subscription_id (int): The model property of type int. + next_assessment_at (datetime): The model property of type datetime. + state (str): The model property of type str. + cancel_at_end_of_period (bool): The model property of type bool. + account_balances (SubscriptionGroupBalances): The model property of + type SubscriptionGroupBalances. + group_type (GroupType): The model property of type GroupType. additional_properties (Dict[str, object]): The additional properties for the model. @@ -152,3 +150,33 @@ def from_dictionary(cls, account_balances, group_type, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'scheme={self.scheme!r}, ' + f'customer_id={self.customer_id!r}, ' + f'payment_profile_id={self.payment_profile_id!r}, ' + f'subscription_ids={self.subscription_ids!r}, ' + f'primary_subscription_id={self.primary_subscription_id!r}, ' + f'next_assessment_at={self.next_assessment_at!r}, ' + f'state={self.state!r}, ' + f'cancel_at_end_of_period={self.cancel_at_end_of_period!r}, ' + f'account_balances={self.account_balances!r}, ' + f'group_type={self.group_type!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'scheme={self.scheme!s}, ' + f'customer_id={self.customer_id!s}, ' + f'payment_profile_id={self.payment_profile_id!s}, ' + f'subscription_ids={self.subscription_ids!s}, ' + f'primary_subscription_id={self.primary_subscription_id!s}, ' + f'next_assessment_at={self.next_assessment_at!s}, ' + f'state={self.state!s}, ' + f'cancel_at_end_of_period={self.cancel_at_end_of_period!s}, ' + f'account_balances={self.account_balances!s}, ' + f'group_type={self.group_type!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_subscription_groups_meta.py b/advancedbilling/models/list_subscription_groups_meta.py index 93d78a33..8c65c920 100644 --- a/advancedbilling/models/list_subscription_groups_meta.py +++ b/advancedbilling/models/list_subscription_groups_meta.py @@ -13,11 +13,9 @@ class ListSubscriptionGroupsMeta(object): """Implementation of the 'List Subscription Groups Meta' model. - TODO: type model description here. - Attributes: - current_page (int): TODO: type description here. - total_count (int): TODO: type description here. + current_page (int): The model property of type int. + total_count (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -78,3 +76,15 @@ def from_dictionary(cls, return cls(current_page, total_count, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'current_page={self.current_page!r}, ' + f'total_count={self.total_count!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'current_page={self.current_page!s}, ' + f'total_count={self.total_count!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/list_subscription_groups_response.py b/advancedbilling/models/list_subscription_groups_response.py index 5dae10d5..22194084 100644 --- a/advancedbilling/models/list_subscription_groups_response.py +++ b/advancedbilling/models/list_subscription_groups_response.py @@ -15,12 +15,11 @@ class ListSubscriptionGroupsResponse(object): """Implementation of the 'List Subscription Groups Response' model. - TODO: type model description here. - Attributes: - subscription_groups (List[ListSubscriptionGroupsItem]): TODO: type - description here. - meta (ListSubscriptionGroupsMeta): TODO: type description here. + subscription_groups (List[ListSubscriptionGroupsItem]): The model + property of type List[ListSubscriptionGroupsItem]. + meta (ListSubscriptionGroupsMeta): The model property of type + ListSubscriptionGroupsMeta. additional_properties (Dict[str, object]): The additional properties for the model. @@ -85,3 +84,15 @@ def from_dictionary(cls, return cls(subscription_groups, meta, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_groups={self.subscription_groups!r}, ' + f'meta={self.meta!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_groups={self.subscription_groups!s}, ' + f'meta={self.meta!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/metadata.py b/advancedbilling/models/metadata.py index a73eec32..4392c448 100644 --- a/advancedbilling/models/metadata.py +++ b/advancedbilling/models/metadata.py @@ -13,15 +13,13 @@ class Metadata(object): """Implementation of the 'Metadata' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - value (str): TODO: type description here. - resource_id (int): TODO: type description here. - name (str): TODO: type description here. - deleted_at (datetime): TODO: type description here. - metafield_id (int): TODO: type description here. + id (int): The model property of type int. + value (str): The model property of type str. + resource_id (int): The model property of type int. + name (str): The model property of type str. + deleted_at (datetime): The model property of type datetime. + metafield_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -121,3 +119,23 @@ def from_dictionary(cls, deleted_at, metafield_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'value={self.value!r}, ' + f'resource_id={self.resource_id!r}, ' + f'name={self.name!r}, ' + f'deleted_at={self.deleted_at!r}, ' + f'metafield_id={self.metafield_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'value={self.value!s}, ' + f'resource_id={self.resource_id!s}, ' + f'name={self.name!s}, ' + f'deleted_at={self.deleted_at!s}, ' + f'metafield_id={self.metafield_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/metafield.py b/advancedbilling/models/metafield.py index 1bf8c035..b08228e5 100644 --- a/advancedbilling/models/metafield.py +++ b/advancedbilling/models/metafield.py @@ -14,11 +14,9 @@ class Metafield(object): """Implementation of the 'Metafield' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - name (str): TODO: type description here. + id (int): The model property of type int. + name (str): The model property of type str. scope (MetafieldScope): Warning: When updating a metafield's scope attribute, all scope attributes must be passed. Partially complete scope attributes will override the existing settings. @@ -30,7 +28,8 @@ class Metafield(object): hand, dropdown and radio have a set of allowed values that can be input, and appear differently on a Public Signup Page. Defaults to 'text' - enum (str | List[str] | None): TODO: type description here. + enum (str | List[str] | None): The model property of type str | + List[str] | None. additional_properties (Dict[str, object]): The additional properties for the model. @@ -127,3 +126,23 @@ def from_dictionary(cls, input_type, enum, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'name={self.name!r}, ' + f'scope={self.scope!r}, ' + f'data_count={self.data_count!r}, ' + f'input_type={self.input_type!r}, ' + f'enum={self.enum!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'name={self.name!s}, ' + f'scope={self.scope!s}, ' + f'data_count={self.data_count!s}, ' + f'input_type={self.input_type!s}, ' + f'enum={self.enum!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/metafield_input.py b/advancedbilling/models/metafield_input.py index e4016b48..93bf6159 100644 --- a/advancedbilling/models/metafield_input.py +++ b/advancedbilling/models/metafield_input.py @@ -19,10 +19,10 @@ class MetafieldInput(object): Signup Page. Defaults to 'text' Attributes: - BALANCE_TRACKER: TODO: type description here. - TEXT: TODO: type description here. - RADIO: TODO: type description here. - DROPDOWN: TODO: type description here. + BALANCE_TRACKER: The enum member of type str. + TEXT: The enum member of type str. + RADIO: The enum member of type str. + DROPDOWN: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/metafield_scope.py b/advancedbilling/models/metafield_scope.py index 48d34cb6..715ee555 100644 --- a/advancedbilling/models/metafield_scope.py +++ b/advancedbilling/models/metafield_scope.py @@ -30,7 +30,7 @@ class MetafieldScope(object): from being viewable by your ecosystem. public_edit (IncludeOption): Include (1) or exclude (0) metafields from being edited by your ecosystem. - hosted (List[str]): TODO: type description here. + hosted (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -148,3 +148,25 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'csv={self.csv!r}, ' + f'invoices={self.invoices!r}, ' + f'statements={self.statements!r}, ' + f'portal={self.portal!r}, ' + f'public_show={self.public_show!r}, ' + f'public_edit={self.public_edit!r}, ' + f'hosted={self.hosted!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'csv={self.csv!s}, ' + f'invoices={self.invoices!s}, ' + f'statements={self.statements!s}, ' + f'portal={self.portal!s}, ' + f'public_show={self.public_show!s}, ' + f'public_edit={self.public_edit!s}, ' + f'hosted={self.hosted!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/metered_component.py b/advancedbilling/models/metered_component.py index ab038e7a..fde450e6 100644 --- a/advancedbilling/models/metered_component.py +++ b/advancedbilling/models/metered_component.py @@ -15,8 +15,6 @@ class MeteredComponent(object): """Implementation of the 'Metered Component' model. - TODO: type model description here. - Attributes: name (str): A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes". @@ -41,8 +39,8 @@ class MeteredComponent(object): Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-C omponent-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. - price_points (List[ComponentPricePointItem]): TODO: type description - here. + price_points (List[ComponentPricePointItem]): The model property of + type List[ComponentPricePointItem]. unit_price (str | float | None): The amount the customer will be charged per unit when the pricing scheme is “per_unit”. For On/Off Components, this is the amount that the customer will be charged @@ -56,9 +54,10 @@ class MeteredComponent(object): hide_date_range_on_invoice (bool): (Only available on Relationship Invoicing sites) Boolean flag describing if the service date range should show for the component on generated invoices. - display_on_hosted_page (bool): TODO: type description here. - allow_fractional_quantities (bool): TODO: type description here. - public_signup_page_ids (List[int]): TODO: type description here. + display_on_hosted_page (bool): The model property of type bool. + allow_fractional_quantities (bool): The model property of type bool. + public_signup_page_ids (List[int]): The model property of type + List[int]. interval (int): The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is @@ -232,3 +231,43 @@ def from_dictionary(cls, interval, interval_unit, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'unit_name={self.unit_name!r}, ' + f'description={self.description!r}, ' + f'handle={self.handle!r}, ' + f'taxable={self.taxable!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'price_points={self.price_points!r}, ' + f'unit_price={self.unit_price!r}, ' + f'tax_code={self.tax_code!r}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!r}, ' + f'display_on_hosted_page={self.display_on_hosted_page!r}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!r}, ' + f'public_signup_page_ids={self.public_signup_page_ids!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'unit_name={self.unit_name!s}, ' + f'description={self.description!s}, ' + f'handle={self.handle!s}, ' + f'taxable={self.taxable!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'price_points={self.price_points!s}, ' + f'unit_price={self.unit_price!s}, ' + f'tax_code={self.tax_code!s}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!s}, ' + f'display_on_hosted_page={self.display_on_hosted_page!s}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!s}, ' + f'public_signup_page_ids={self.public_signup_page_ids!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/metered_usage.py b/advancedbilling/models/metered_usage.py index 58e7866c..affd692c 100644 --- a/advancedbilling/models/metered_usage.py +++ b/advancedbilling/models/metered_usage.py @@ -13,15 +13,13 @@ class MeteredUsage(object): """Implementation of the 'Metered Usage' model. - TODO: type model description here. - Attributes: - previous_unit_balance (str): TODO: type description here. - new_unit_balance (int): TODO: type description here. - usage_quantity (int): TODO: type description here. - component_id (int): TODO: type description here. - component_handle (str): TODO: type description here. - memo (str): TODO: type description here. + previous_unit_balance (str): The model property of type str. + new_unit_balance (int): The model property of type int. + usage_quantity (int): The model property of type int. + component_id (int): The model property of type int. + component_handle (str): The model property of type str. + memo (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -139,3 +137,23 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('memo'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'previous_unit_balance={self.previous_unit_balance!r}, ' + f'new_unit_balance={self.new_unit_balance!r}, ' + f'usage_quantity={self.usage_quantity!r}, ' + f'component_id={self.component_id!r}, ' + f'component_handle={self.component_handle!r}, ' + f'memo={self.memo!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'previous_unit_balance={self.previous_unit_balance!s}, ' + f'new_unit_balance={self.new_unit_balance!s}, ' + f'usage_quantity={self.usage_quantity!s}, ' + f'component_id={self.component_id!s}, ' + f'component_handle={self.component_handle!s}, ' + f'memo={self.memo!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/movement.py b/advancedbilling/models/movement.py index 291b7610..08c9d57e 100644 --- a/advancedbilling/models/movement.py +++ b/advancedbilling/models/movement.py @@ -15,18 +15,17 @@ class Movement(object): """Implementation of the 'Movement' model. - TODO: type model description here. - Attributes: - timestamp (datetime): TODO: type description here. - amount_in_cents (long|int): TODO: type description here. - amount_formatted (str): TODO: type description here. - description (str): TODO: type description here. - category (str): TODO: type description here. - breakouts (Breakouts): TODO: type description here. - line_items (List[MovementLineItem]): TODO: type description here. - subscription_id (int): TODO: type description here. - subscriber_name (str): TODO: type description here. + timestamp (datetime): The model property of type datetime. + amount_in_cents (int): The model property of type int. + amount_formatted (str): The model property of type str. + description (str): The model property of type str. + category (str): The model property of type str. + breakouts (Breakouts): The model property of type Breakouts. + line_items (List[MovementLineItem]): The model property of type + List[MovementLineItem]. + subscription_id (int): The model property of type int. + subscriber_name (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -140,3 +139,29 @@ def from_dictionary(cls, subscription_id, subscriber_name, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'timestamp={self.timestamp!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'amount_formatted={self.amount_formatted!r}, ' + f'description={self.description!r}, ' + f'category={self.category!r}, ' + f'breakouts={self.breakouts!r}, ' + f'line_items={self.line_items!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'subscriber_name={self.subscriber_name!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'timestamp={self.timestamp!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'amount_formatted={self.amount_formatted!s}, ' + f'description={self.description!s}, ' + f'category={self.category!s}, ' + f'breakouts={self.breakouts!s}, ' + f'line_items={self.line_items!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'subscriber_name={self.subscriber_name!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/movement_line_item.py b/advancedbilling/models/movement_line_item.py index 837ccd2a..217f49c7 100644 --- a/advancedbilling/models/movement_line_item.py +++ b/advancedbilling/models/movement_line_item.py @@ -14,18 +14,17 @@ class MovementLineItem(object): """Implementation of the 'Movement Line Item' model. - TODO: type model description here. - Attributes: - product_id (int): TODO: type description here. + product_id (int): The model property of type int. component_id (int): For Product (or "baseline") line items, this field will have a value of `0`. - price_point_id (int): TODO: type description here. - name (str): TODO: type description here. - mrr (int): TODO: type description here. - mrr_movements (List[MRRMovement]): TODO: type description here. - quantity (int): TODO: type description here. - prev_quantity (int): TODO: type description here. + price_point_id (int): The model property of type int. + name (str): The model property of type str. + mrr (int): The model property of type int. + mrr_movements (List[MRRMovement]): The model property of type + List[MRRMovement]. + quantity (int): The model property of type int. + prev_quantity (int): The model property of type int. recurring (bool): When `true`, the line item's MRR value will contribute to the `plan` breakout. When `false`, the line item contributes to the `usage` breakout. @@ -142,3 +141,29 @@ def from_dictionary(cls, prev_quantity, recurring, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_id={self.product_id!r}, ' + f'component_id={self.component_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'name={self.name!r}, ' + f'mrr={self.mrr!r}, ' + f'mrr_movements={self.mrr_movements!r}, ' + f'quantity={self.quantity!r}, ' + f'prev_quantity={self.prev_quantity!r}, ' + f'recurring={self.recurring!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_id={self.product_id!s}, ' + f'component_id={self.component_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'name={self.name!s}, ' + f'mrr={self.mrr!s}, ' + f'mrr_movements={self.mrr_movements!s}, ' + f'quantity={self.quantity!s}, ' + f'prev_quantity={self.prev_quantity!s}, ' + f'recurring={self.recurring!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/mrr.py b/advancedbilling/models/mrr.py index 12387034..ce5c7680 100644 --- a/advancedbilling/models/mrr.py +++ b/advancedbilling/models/mrr.py @@ -14,14 +14,12 @@ class MRR(object): """Implementation of the 'MRR' model. - TODO: type model description here. - Attributes: - amount_in_cents (long|int): TODO: type description here. - amount_formatted (str): TODO: type description here. - currency (str): TODO: type description here. - currency_symbol (str): TODO: type description here. - breakouts (Breakouts): TODO: type description here. + amount_in_cents (int): The model property of type int. + amount_formatted (str): The model property of type str. + currency (str): The model property of type str. + currency_symbol (str): The model property of type str. + breakouts (Breakouts): The model property of type Breakouts. at_time (datetime): ISO8601 timestamp additional_properties (Dict[str, object]): The additional properties for the model. @@ -111,3 +109,23 @@ def from_dictionary(cls, breakouts, at_time, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'amount_formatted={self.amount_formatted!r}, ' + f'currency={self.currency!r}, ' + f'currency_symbol={self.currency_symbol!r}, ' + f'breakouts={self.breakouts!r}, ' + f'at_time={self.at_time!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'amount_formatted={self.amount_formatted!s}, ' + f'currency={self.currency!s}, ' + f'currency_symbol={self.currency_symbol!s}, ' + f'breakouts={self.breakouts!s}, ' + f'at_time={self.at_time!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/mrr_movement.py b/advancedbilling/models/mrr_movement.py index e050a273..88a1eda1 100644 --- a/advancedbilling/models/mrr_movement.py +++ b/advancedbilling/models/mrr_movement.py @@ -13,13 +13,11 @@ class MRRMovement(object): """Implementation of the 'MRR Movement' model. - TODO: type model description here. - Attributes: - amount (int): TODO: type description here. - category (str): TODO: type description here. - subscriber_delta (int): TODO: type description here. - lead_delta (int): TODO: type description here. + amount (int): The model property of type int. + category (str): The model property of type str. + subscriber_delta (int): The model property of type int. + lead_delta (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -94,3 +92,19 @@ def from_dictionary(cls, subscriber_delta, lead_delta, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!r}, ' + f'category={self.category!r}, ' + f'subscriber_delta={self.subscriber_delta!r}, ' + f'lead_delta={self.lead_delta!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!s}, ' + f'category={self.category!s}, ' + f'subscriber_delta={self.subscriber_delta!s}, ' + f'lead_delta={self.lead_delta!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/mrr_response.py b/advancedbilling/models/mrr_response.py index eb73fc37..1ed48352 100644 --- a/advancedbilling/models/mrr_response.py +++ b/advancedbilling/models/mrr_response.py @@ -13,10 +13,8 @@ class MRRResponse(object): """Implementation of the 'MRR response' model. - TODO: type model description here. - Attributes: - mrr (MRR): TODO: type description here. + mrr (MRR): The model property of type MRR. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(mrr, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'mrr={self.mrr!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'mrr={self.mrr!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/multi_invoice_payment.py b/advancedbilling/models/multi_invoice_payment.py index 2521a143..ccc774cd 100644 --- a/advancedbilling/models/multi_invoice_payment.py +++ b/advancedbilling/models/multi_invoice_payment.py @@ -14,15 +14,13 @@ class MultiInvoicePayment(object): """Implementation of the 'Multi Invoice Payment' model. - TODO: type model description here. - Attributes: transaction_id (int): The numeric ID of the transaction. total_amount (str): Dollar amount of the sum of the paid invoices. currency_code (str): The ISO 4217 currency code (3 character string) representing the currency of invoice transaction. - applications (List[InvoicePaymentApplication]): TODO: type description - here. + applications (List[InvoicePaymentApplication]): The model property of + type List[InvoicePaymentApplication]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -101,3 +99,19 @@ def from_dictionary(cls, currency_code, applications, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'transaction_id={self.transaction_id!r}, ' + f'total_amount={self.total_amount!r}, ' + f'currency_code={self.currency_code!r}, ' + f'applications={self.applications!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'transaction_id={self.transaction_id!s}, ' + f'total_amount={self.total_amount!s}, ' + f'currency_code={self.currency_code!s}, ' + f'applications={self.applications!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/multi_invoice_payment_response.py b/advancedbilling/models/multi_invoice_payment_response.py index 42092926..5051c8b4 100644 --- a/advancedbilling/models/multi_invoice_payment_response.py +++ b/advancedbilling/models/multi_invoice_payment_response.py @@ -13,10 +13,9 @@ class MultiInvoicePaymentResponse(object): """Implementation of the 'Multi Invoice Payment Response' model. - TODO: type model description here. - Attributes: - payment (MultiInvoicePayment): TODO: type description here. + payment (MultiInvoicePayment): The model property of type + MultiInvoicePayment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(payment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payment={self.payment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payment={self.payment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/nested_subscription_group.py b/advancedbilling/models/nested_subscription_group.py index eb1c530f..571ae0b6 100644 --- a/advancedbilling/models/nested_subscription_group.py +++ b/advancedbilling/models/nested_subscription_group.py @@ -13,8 +13,6 @@ class NestedSubscriptionGroup(object): """Implementation of the 'Nested Subscription Group' model. - TODO: type model description here. - Attributes: uid (str): The UID for the group scheme (int): Whether the group is configured to rely on a primary @@ -97,3 +95,19 @@ def from_dictionary(cls, primary_subscription_id, primary, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'scheme={self.scheme!r}, ' + f'primary_subscription_id={self.primary_subscription_id!r}, ' + f'primary={self.primary!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'scheme={self.scheme!s}, ' + f'primary_subscription_id={self.primary_subscription_id!s}, ' + f'primary={self.primary!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/net_terms.py b/advancedbilling/models/net_terms.py index 1fab976b..0a1fa289 100644 --- a/advancedbilling/models/net_terms.py +++ b/advancedbilling/models/net_terms.py @@ -13,15 +13,13 @@ class NetTerms(object): """Implementation of the 'Net Terms' model. - TODO: type model description here. - Attributes: - default_net_terms (int): TODO: type description here. - automatic_net_terms (int): TODO: type description here. - remittance_net_terms (int): TODO: type description here. - net_terms_on_remittance_signups_enabled (bool): TODO: type description - here. - custom_net_terms_enabled (bool): TODO: type description here. + default_net_terms (int): The model property of type int. + automatic_net_terms (int): The model property of type int. + remittance_net_terms (int): The model property of type int. + net_terms_on_remittance_signups_enabled (bool): The model property of + type bool. + custom_net_terms_enabled (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -98,3 +96,21 @@ def from_dictionary(cls, net_terms_on_remittance_signups_enabled, custom_net_terms_enabled, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'default_net_terms={self.default_net_terms!r}, ' + f'automatic_net_terms={self.automatic_net_terms!r}, ' + f'remittance_net_terms={self.remittance_net_terms!r}, ' + f'net_terms_on_remittance_signups_enabled={self.net_terms_on_remittance_signups_enabled!r}, ' + f'custom_net_terms_enabled={self.custom_net_terms_enabled!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'default_net_terms={self.default_net_terms!s}, ' + f'automatic_net_terms={self.automatic_net_terms!s}, ' + f'remittance_net_terms={self.remittance_net_terms!s}, ' + f'net_terms_on_remittance_signups_enabled={self.net_terms_on_remittance_signups_enabled!s}, ' + f'custom_net_terms_enabled={self.custom_net_terms_enabled!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/offer.py b/advancedbilling/models/offer.py index c7971335..4b166e8e 100644 --- a/advancedbilling/models/offer.py +++ b/advancedbilling/models/offer.py @@ -16,29 +16,29 @@ class Offer(object): """Implementation of the 'Offer' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - site_id (int): TODO: type description here. - product_family_id (int): TODO: type description here. - product_id (int): TODO: type description here. - product_price_point_id (int): TODO: type description here. - product_revisable_number (int): TODO: type description here. - name (str): TODO: type description here. - handle (str): TODO: type description here. - description (str): TODO: type description here. - created_at (datetime): TODO: type description here. - updated_at (datetime): TODO: type description here. - archived_at (datetime): TODO: type description here. - offer_items (List[OfferItem]): TODO: type description here. - offer_discounts (List[OfferDiscount]): TODO: type description here. - product_family_name (str): TODO: type description here. - product_name (str): TODO: type description here. - product_price_point_name (str): TODO: type description here. - product_price_in_cents (long|int): TODO: type description here. - offer_signup_pages (List[OfferSignupPage]): TODO: type description - here. + id (int): The model property of type int. + site_id (int): The model property of type int. + product_family_id (int): The model property of type int. + product_id (int): The model property of type int. + product_price_point_id (int): The model property of type int. + product_revisable_number (int): The model property of type int. + name (str): The model property of type str. + handle (str): The model property of type str. + description (str): The model property of type str. + created_at (datetime): The model property of type datetime. + updated_at (datetime): The model property of type datetime. + archived_at (datetime): The model property of type datetime. + offer_items (List[OfferItem]): The model property of type + List[OfferItem]. + offer_discounts (List[OfferDiscount]): The model property of type + List[OfferDiscount]. + product_family_name (str): The model property of type str. + product_name (str): The model property of type str. + product_price_point_name (str): The model property of type str. + product_price_in_cents (int): The model property of type int. + offer_signup_pages (List[OfferSignupPage]): The model property of type + List[OfferSignupPage]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -238,3 +238,49 @@ def from_dictionary(cls, product_price_in_cents, offer_signup_pages, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'site_id={self.site_id!r}, ' + f'product_family_id={self.product_family_id!r}, ' + f'product_id={self.product_id!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'product_revisable_number={self.product_revisable_number!r}, ' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'description={self.description!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'archived_at={self.archived_at!r}, ' + f'offer_items={self.offer_items!r}, ' + f'offer_discounts={self.offer_discounts!r}, ' + f'product_family_name={self.product_family_name!r}, ' + f'product_name={self.product_name!r}, ' + f'product_price_point_name={self.product_price_point_name!r}, ' + f'product_price_in_cents={self.product_price_in_cents!r}, ' + f'offer_signup_pages={self.offer_signup_pages!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'site_id={self.site_id!s}, ' + f'product_family_id={self.product_family_id!s}, ' + f'product_id={self.product_id!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'product_revisable_number={self.product_revisable_number!s}, ' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'description={self.description!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'archived_at={self.archived_at!s}, ' + f'offer_items={self.offer_items!s}, ' + f'offer_discounts={self.offer_discounts!s}, ' + f'product_family_name={self.product_family_name!s}, ' + f'product_name={self.product_name!s}, ' + f'product_price_point_name={self.product_price_point_name!s}, ' + f'product_price_in_cents={self.product_price_in_cents!s}, ' + f'offer_signup_pages={self.offer_signup_pages!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/offer_discount.py b/advancedbilling/models/offer_discount.py index b9d87471..e1b88a17 100644 --- a/advancedbilling/models/offer_discount.py +++ b/advancedbilling/models/offer_discount.py @@ -13,12 +13,10 @@ class OfferDiscount(object): """Implementation of the 'Offer Discount' model. - TODO: type model description here. - Attributes: - coupon_code (str): TODO: type description here. - coupon_id (int): TODO: type description here. - coupon_name (str): TODO: type description here. + coupon_code (str): The model property of type str. + coupon_id (int): The model property of type int. + coupon_name (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -86,3 +84,17 @@ def from_dictionary(cls, coupon_id, coupon_name, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'coupon_code={self.coupon_code!r}, ' + f'coupon_id={self.coupon_id!r}, ' + f'coupon_name={self.coupon_name!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'coupon_code={self.coupon_code!s}, ' + f'coupon_id={self.coupon_id!s}, ' + f'coupon_name={self.coupon_name!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/offer_item.py b/advancedbilling/models/offer_item.py index a2ba2134..5f93eb35 100644 --- a/advancedbilling/models/offer_item.py +++ b/advancedbilling/models/offer_item.py @@ -14,17 +14,16 @@ class OfferItem(object): """Implementation of the 'Offer Item' model. - TODO: type model description here. - Attributes: - component_id (int): TODO: type description here. - price_point_id (int): TODO: type description here. - starting_quantity (str): TODO: type description here. - editable (bool): TODO: type description here. - component_unit_price (str): TODO: type description here. - component_name (str): TODO: type description here. - price_point_name (str): TODO: type description here. - currency_prices (List[CurrencyPrice]): TODO: type description here. + component_id (int): The model property of type int. + price_point_id (int): The model property of type int. + starting_quantity (str): The model property of type str. + editable (bool): The model property of type bool. + component_unit_price (str): The model property of type str. + component_name (str): The model property of type str. + price_point_name (str): The model property of type str. + currency_prices (List[CurrencyPrice]): The model property of type + List[CurrencyPrice]. interval (int): The numerical interval. i.e. an interval of '30' coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only @@ -156,3 +155,31 @@ def from_dictionary(cls, interval, interval_unit, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'starting_quantity={self.starting_quantity!r}, ' + f'editable={self.editable!r}, ' + f'component_unit_price={self.component_unit_price!r}, ' + f'component_name={self.component_name!r}, ' + f'price_point_name={self.price_point_name!r}, ' + f'currency_prices={self.currency_prices!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'starting_quantity={self.starting_quantity!s}, ' + f'editable={self.editable!s}, ' + f'component_unit_price={self.component_unit_price!s}, ' + f'component_name={self.component_name!s}, ' + f'price_point_name={self.price_point_name!s}, ' + f'currency_prices={self.currency_prices!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/offer_response.py b/advancedbilling/models/offer_response.py index 7fac0e16..0796707f 100644 --- a/advancedbilling/models/offer_response.py +++ b/advancedbilling/models/offer_response.py @@ -14,10 +14,8 @@ class OfferResponse(object): """Implementation of the 'Offer Response' model. - TODO: type model description here. - Attributes: - offer (Offer): TODO: type description here. + offer (Offer): The model property of type Offer. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(offer, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'offer={self.offer!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'offer={self.offer!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/offer_signup_page.py b/advancedbilling/models/offer_signup_page.py index a42cc61a..a8d722dd 100644 --- a/advancedbilling/models/offer_signup_page.py +++ b/advancedbilling/models/offer_signup_page.py @@ -13,15 +13,13 @@ class OfferSignupPage(object): """Implementation of the 'Offer Signup Page' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - nickname (str): TODO: type description here. - enabled (bool): TODO: type description here. - return_url (str): TODO: type description here. - return_params (str): TODO: type description here. - url (str): TODO: type description here. + id (int): The model property of type int. + nickname (str): The model property of type str. + enabled (bool): The model property of type bool. + return_url (str): The model property of type str. + return_params (str): The model property of type str. + url (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -110,3 +108,23 @@ def from_dictionary(cls, return_params, url, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'nickname={self.nickname!r}, ' + f'enabled={self.enabled!r}, ' + f'return_url={self.return_url!r}, ' + f'return_params={self.return_params!r}, ' + f'url={self.url!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'nickname={self.nickname!s}, ' + f'enabled={self.enabled!s}, ' + f'return_url={self.return_url!s}, ' + f'return_params={self.return_params!s}, ' + f'url={self.url!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/ok_response.py b/advancedbilling/models/ok_response.py index 1aba942c..2a20d1aa 100644 --- a/advancedbilling/models/ok_response.py +++ b/advancedbilling/models/ok_response.py @@ -13,10 +13,8 @@ class OkResponse(object): """Implementation of the 'Ok Response' model. - TODO: type model description here. - Attributes: - ok (str): TODO: type description here. + ok (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(ok, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'ok={self.ok!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'ok={self.ok!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/on_off_component.py b/advancedbilling/models/on_off_component.py index b1908e06..694ecf10 100644 --- a/advancedbilling/models/on_off_component.py +++ b/advancedbilling/models/on_off_component.py @@ -14,8 +14,6 @@ class OnOffComponent(object): """Implementation of the 'On/Off Component' model. - TODO: type model description here. - Attributes: name (str): A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes". @@ -35,8 +33,8 @@ class OnOffComponent(object): upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, `prorated`, `none`. - price_points (List[ComponentPricePointItem]): TODO: type description - here. + price_points (List[ComponentPricePointItem]): The model property of + type List[ComponentPricePointItem]. unit_price (str | float): This is the amount that the customer will be charged when they turn the component on for the subscription. The price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or @@ -48,9 +46,10 @@ class OnOffComponent(object): hide_date_range_on_invoice (bool): (Only available on Relationship Invoicing sites) Boolean flag describing if the service date range should show for the component on generated invoices. - display_on_hosted_page (bool): TODO: type description here. - allow_fractional_quantities (bool): TODO: type description here. - public_signup_page_ids (List[int]): TODO: type description here. + display_on_hosted_page (bool): The model property of type bool. + allow_fractional_quantities (bool): The model property of type bool. + public_signup_page_ids (List[int]): The model property of type + List[int]. interval (int): The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is @@ -244,3 +243,41 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('name'), type_callable=lambda value: isinstance(value, str)) \ and UnionTypeLookUp.get('OnOffComponentUnitPrice').validate(dictionary.get('unit_price')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'description={self.description!r}, ' + f'handle={self.handle!r}, ' + f'taxable={self.taxable!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'price_points={self.price_points!r}, ' + f'unit_price={self.unit_price!r}, ' + f'tax_code={self.tax_code!r}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!r}, ' + f'display_on_hosted_page={self.display_on_hosted_page!r}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!r}, ' + f'public_signup_page_ids={self.public_signup_page_ids!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'description={self.description!s}, ' + f'handle={self.handle!s}, ' + f'taxable={self.taxable!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'price_points={self.price_points!s}, ' + f'unit_price={self.unit_price!s}, ' + f'tax_code={self.tax_code!s}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!s}, ' + f'display_on_hosted_page={self.display_on_hosted_page!s}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!s}, ' + f'public_signup_page_ids={self.public_signup_page_ids!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/organization_address.py b/advancedbilling/models/organization_address.py index 24bf3b97..b385e2f6 100644 --- a/advancedbilling/models/organization_address.py +++ b/advancedbilling/models/organization_address.py @@ -13,17 +13,15 @@ class OrganizationAddress(object): """Implementation of the 'Organization Address' model. - TODO: type model description here. - Attributes: - street (str): TODO: type description here. - line_2 (str): TODO: type description here. - city (str): TODO: type description here. - state (str): TODO: type description here. - zip (str): TODO: type description here. - country (str): TODO: type description here. - name (str): TODO: type description here. - phone (str): TODO: type description here. + street (str): The model property of type str. + line_2 (str): The model property of type str. + city (str): The model property of type str. + state (str): The model property of type str. + zip (str): The model property of type str. + country (str): The model property of type str. + name (str): The model property of type str. + phone (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -137,3 +135,27 @@ def from_dictionary(cls, name, phone, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'street={self.street!r}, ' + f'line_2={self.line_2!r}, ' + f'city={self.city!r}, ' + f'state={self.state!r}, ' + f'zip={self.zip!r}, ' + f'country={self.country!r}, ' + f'name={self.name!r}, ' + f'phone={self.phone!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'street={self.street!s}, ' + f'line_2={self.line_2!s}, ' + f'city={self.city!s}, ' + f'state={self.state!s}, ' + f'zip={self.zip!s}, ' + f'country={self.country!s}, ' + f'name={self.name!s}, ' + f'phone={self.phone!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/origin_invoice.py b/advancedbilling/models/origin_invoice.py index 644c2d79..2db96064 100644 --- a/advancedbilling/models/origin_invoice.py +++ b/advancedbilling/models/origin_invoice.py @@ -13,8 +13,6 @@ class OriginInvoice(object): """Implementation of the 'Origin Invoice' model. - TODO: type model description here. - Attributes: uid (str): The UID of the invoice serving as an origin invoice. number (str): The number of the invoice serving as an origin invoice. @@ -100,3 +98,15 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'number={self.number!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'number={self.number!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/overage_pricing.py b/advancedbilling/models/overage_pricing.py index 4b236b2d..e2cd1ab7 100644 --- a/advancedbilling/models/overage_pricing.py +++ b/advancedbilling/models/overage_pricing.py @@ -15,14 +15,12 @@ class OveragePricing(object): """Implementation of the 'Overage Pricing' model. - TODO: type model description here. - Attributes: pricing_scheme (PricingScheme): The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.h tml) for an overview of pricing schemes. - prices (List[Price]): TODO: type description here. + prices (List[Price]): The model property of type List[Price]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -109,3 +107,15 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('pricing_scheme'), type_callable=lambda value: PricingScheme.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/override_subscription.py b/advancedbilling/models/override_subscription.py index 426d5bdd..48cc7eb1 100644 --- a/advancedbilling/models/override_subscription.py +++ b/advancedbilling/models/override_subscription.py @@ -13,8 +13,6 @@ class OverrideSubscription(object): """Implementation of the 'Override Subscription' model. - TODO: type model description here. - Attributes: activated_at (datetime): Can be used to record an external signup date. Chargify uses this field to record when a subscription first @@ -117,3 +115,21 @@ def from_dictionary(cls, expires_at, current_period_starts_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'activated_at={self.activated_at!r}, ' + f'canceled_at={self.canceled_at!r}, ' + f'cancellation_message={self.cancellation_message!r}, ' + f'expires_at={self.expires_at!r}, ' + f'current_period_starts_at={self.current_period_starts_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'activated_at={self.activated_at!s}, ' + f'canceled_at={self.canceled_at!s}, ' + f'cancellation_message={self.cancellation_message!s}, ' + f'expires_at={self.expires_at!s}, ' + f'current_period_starts_at={self.current_period_starts_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/override_subscription_request.py b/advancedbilling/models/override_subscription_request.py index b2e40cbe..61727968 100644 --- a/advancedbilling/models/override_subscription_request.py +++ b/advancedbilling/models/override_subscription_request.py @@ -13,10 +13,9 @@ class OverrideSubscriptionRequest(object): """Implementation of the 'Override Subscription Request' model. - TODO: type model description here. - Attributes: - subscription (OverrideSubscription): TODO: type description here. + subscription (OverrideSubscription): The model property of type + OverrideSubscription. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/paginated_metadata.py b/advancedbilling/models/paginated_metadata.py index 827deda9..1a109c7c 100644 --- a/advancedbilling/models/paginated_metadata.py +++ b/advancedbilling/models/paginated_metadata.py @@ -14,14 +14,12 @@ class PaginatedMetadata(object): """Implementation of the 'Paginated Metadata' model. - TODO: type model description here. - Attributes: - total_count (int): TODO: type description here. - current_page (int): TODO: type description here. - total_pages (int): TODO: type description here. - per_page (int): TODO: type description here. - metadata (List[Metadata]): TODO: type description here. + total_count (int): The model property of type int. + current_page (int): The model property of type int. + total_pages (int): The model property of type int. + per_page (int): The model property of type int. + metadata (List[Metadata]): The model property of type List[Metadata]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -107,3 +105,21 @@ def from_dictionary(cls, per_page, metadata, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'total_count={self.total_count!r}, ' + f'current_page={self.current_page!r}, ' + f'total_pages={self.total_pages!r}, ' + f'per_page={self.per_page!r}, ' + f'metadata={self.metadata!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'total_count={self.total_count!s}, ' + f'current_page={self.current_page!s}, ' + f'total_pages={self.total_pages!s}, ' + f'per_page={self.per_page!s}, ' + f'metadata={self.metadata!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/paid_invoice.py b/advancedbilling/models/paid_invoice.py index ebdea2b7..f3d4b3e9 100644 --- a/advancedbilling/models/paid_invoice.py +++ b/advancedbilling/models/paid_invoice.py @@ -13,8 +13,6 @@ class PaidInvoice(object): """Implementation of the 'Paid Invoice' model. - TODO: type model description here. - Attributes: invoice_id (str): The uid of the paid invoice status (InvoiceStatus): The current status of the invoice. See @@ -98,3 +96,19 @@ def from_dictionary(cls, due_amount, paid_amount, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'invoice_id={self.invoice_id!r}, ' + f'status={self.status!r}, ' + f'due_amount={self.due_amount!r}, ' + f'paid_amount={self.paid_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'invoice_id={self.invoice_id!s}, ' + f'status={self.status!s}, ' + f'due_amount={self.due_amount!s}, ' + f'paid_amount={self.paid_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/pause_request.py b/advancedbilling/models/pause_request.py index c19a2211..6c32e038 100644 --- a/advancedbilling/models/pause_request.py +++ b/advancedbilling/models/pause_request.py @@ -17,7 +17,7 @@ class PauseRequest(object): Allows to pause a Subscription Attributes: - hold (AutoResume): TODO: type description here. + hold (AutoResume): The model property of type AutoResume. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +71,13 @@ def from_dictionary(cls, # Return an object of this model return cls(hold, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'hold={self.hold!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'hold={self.hold!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/pay_pal_vault.py b/advancedbilling/models/pay_pal_vault.py index c367c08f..3cbc8db5 100644 --- a/advancedbilling/models/pay_pal_vault.py +++ b/advancedbilling/models/pay_pal_vault.py @@ -15,10 +15,10 @@ class PayPalVault(object): The vault that stores the payment profile with the provided vault_token. Attributes: - BRAINTREE_BLUE: TODO: type description here. - PAYPAL: TODO: type description here. - MODUSLINK: TODO: type description here. - PAYPAL_COMPLETE: TODO: type description here. + BRAINTREE_BLUE: The enum member of type str. + PAYPAL: The enum member of type str. + MODUSLINK: The enum member of type str. + PAYPAL_COMPLETE: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/payer_attributes.py b/advancedbilling/models/payer_attributes.py index 1b6ccbf3..820eed30 100644 --- a/advancedbilling/models/payer_attributes.py +++ b/advancedbilling/models/payer_attributes.py @@ -13,26 +13,24 @@ class PayerAttributes(object): """Implementation of the 'Payer Attributes' model. - TODO: type model description here. - Attributes: - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - email (str): TODO: type description here. - cc_emails (str): TODO: type description here. - organization (str): TODO: type description here. - reference (str): TODO: type description here. - address (str): TODO: type description here. - address_2 (str): TODO: type description here. - city (str): TODO: type description here. - state (str): TODO: type description here. - zip (str): TODO: type description here. - country (str): TODO: type description here. - phone (str): TODO: type description here. - locale (str): TODO: type description here. - vat_number (str): TODO: type description here. - tax_exempt (bool): TODO: type description here. - tax_exempt_reason (str): TODO: type description here. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + email (str): The model property of type str. + cc_emails (str): The model property of type str. + organization (str): The model property of type str. + reference (str): The model property of type str. + address (str): The model property of type str. + address_2 (str): The model property of type str. + city (str): The model property of type str. + state (str): The model property of type str. + zip (str): The model property of type str. + country (str): The model property of type str. + phone (str): The model property of type str. + locale (str): The model property of type str. + vat_number (str): The model property of type str. + tax_exempt (bool): The model property of type bool. + tax_exempt_reason (str): The model property of type str. metafields (Dict[str, str]): (Optional) A set of key/value pairs representing custom fields and their values. Metafields will be created “on-the-fly” in your site for a given key, if they have @@ -231,3 +229,47 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'email={self.email!r}, ' + f'cc_emails={self.cc_emails!r}, ' + f'organization={self.organization!r}, ' + f'reference={self.reference!r}, ' + f'address={self.address!r}, ' + f'address_2={self.address_2!r}, ' + f'city={self.city!r}, ' + f'state={self.state!r}, ' + f'zip={self.zip!r}, ' + f'country={self.country!r}, ' + f'phone={self.phone!r}, ' + f'locale={self.locale!r}, ' + f'vat_number={self.vat_number!r}, ' + f'tax_exempt={self.tax_exempt!r}, ' + f'tax_exempt_reason={self.tax_exempt_reason!r}, ' + f'metafields={self.metafields!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'email={self.email!s}, ' + f'cc_emails={self.cc_emails!s}, ' + f'organization={self.organization!s}, ' + f'reference={self.reference!s}, ' + f'address={self.address!s}, ' + f'address_2={self.address_2!s}, ' + f'city={self.city!s}, ' + f'state={self.state!s}, ' + f'zip={self.zip!s}, ' + f'country={self.country!s}, ' + f'phone={self.phone!s}, ' + f'locale={self.locale!s}, ' + f'vat_number={self.vat_number!s}, ' + f'tax_exempt={self.tax_exempt!s}, ' + f'tax_exempt_reason={self.tax_exempt_reason!s}, ' + f'metafields={self.metafields!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payer_error.py b/advancedbilling/models/payer_error.py index f193a748..56b0268f 100644 --- a/advancedbilling/models/payer_error.py +++ b/advancedbilling/models/payer_error.py @@ -13,12 +13,10 @@ class PayerError(object): """Implementation of the 'Payer Error' model. - TODO: type model description here. - Attributes: - last_name (List[str]): TODO: type description here. - first_name (List[str]): TODO: type description here. - email (List[str]): TODO: type description here. + last_name (List[str]): The model property of type List[str]. + first_name (List[str]): The model property of type List[str]. + email (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -86,3 +84,17 @@ def from_dictionary(cls, first_name, email, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'last_name={self.last_name!r}, ' + f'first_name={self.first_name!r}, ' + f'email={self.email!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'last_name={self.last_name!s}, ' + f'first_name={self.first_name!s}, ' + f'email={self.email!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_collection_method_changed.py b/advancedbilling/models/payment_collection_method_changed.py index fe4548a7..ea16ec37 100644 --- a/advancedbilling/models/payment_collection_method_changed.py +++ b/advancedbilling/models/payment_collection_method_changed.py @@ -13,11 +13,9 @@ class PaymentCollectionMethodChanged(object): """Implementation of the 'Payment Collection Method Changed' model. - TODO: type model description here. - Attributes: - previous_value (str): TODO: type description here. - current_value (str): TODO: type description here. + previous_value (str): The model property of type str. + current_value (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -99,3 +97,15 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('current_value'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'previous_value={self.previous_value!r}, ' + f'current_value={self.current_value!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'previous_value={self.previous_value!s}, ' + f'current_value={self.current_value!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_for_allocation.py b/advancedbilling/models/payment_for_allocation.py index 923e59dc..afe41abb 100644 --- a/advancedbilling/models/payment_for_allocation.py +++ b/advancedbilling/models/payment_for_allocation.py @@ -16,10 +16,10 @@ class PaymentForAllocation(object): Information for captured payment, if applicable Attributes: - id (int): TODO: type description here. - amount_in_cents (long|int): TODO: type description here. - success (bool): TODO: type description here. - memo (str): TODO: type description here. + id (int): The model property of type int. + amount_in_cents (int): The model property of type int. + success (bool): The model property of type bool. + memo (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -116,3 +116,19 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'success={self.success!r}, ' + f'memo={self.memo!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'success={self.success!s}, ' + f'memo={self.memo!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_method_apple_pay.py b/advancedbilling/models/payment_method_apple_pay.py index b7f43c89..169bf78f 100644 --- a/advancedbilling/models/payment_method_apple_pay.py +++ b/advancedbilling/models/payment_method_apple_pay.py @@ -14,10 +14,9 @@ class PaymentMethodApplePay(object): """Implementation of the 'Payment Method Apple Pay' model. - TODO: type model description here. - Attributes: - mtype (InvoiceEventPaymentMethod): TODO: type description here. + mtype (InvoiceEventPaymentMethod): The model property of type + InvoiceEventPaymentMethod. additional_properties (Dict[str, object]): The additional properties for the model. @@ -90,3 +89,13 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('type'), type_callable=lambda value: InvoiceEventPaymentMethod.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'mtype={self.mtype!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'mtype={self.mtype!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_method_bank_account.py b/advancedbilling/models/payment_method_bank_account.py index 1bdba94c..8d794e13 100644 --- a/advancedbilling/models/payment_method_bank_account.py +++ b/advancedbilling/models/payment_method_bank_account.py @@ -14,12 +14,11 @@ class PaymentMethodBankAccount(object): """Implementation of the 'Payment Method Bank Account' model. - TODO: type model description here. - Attributes: - masked_account_number (str): TODO: type description here. - masked_routing_number (str): TODO: type description here. - mtype (InvoiceEventPaymentMethod): TODO: type description here. + masked_account_number (str): The model property of type str. + masked_routing_number (str): The model property of type str. + mtype (InvoiceEventPaymentMethod): The model property of type + InvoiceEventPaymentMethod. additional_properties (Dict[str, object]): The additional properties for the model. @@ -110,3 +109,17 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('type'), type_callable=lambda value: InvoiceEventPaymentMethod.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'masked_account_number={self.masked_account_number!r}, ' + f'masked_routing_number={self.masked_routing_number!r}, ' + f'mtype={self.mtype!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'masked_account_number={self.masked_account_number!s}, ' + f'masked_routing_number={self.masked_routing_number!s}, ' + f'mtype={self.mtype!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_method_credit_card.py b/advancedbilling/models/payment_method_credit_card.py index f45a8715..2a163c97 100644 --- a/advancedbilling/models/payment_method_credit_card.py +++ b/advancedbilling/models/payment_method_credit_card.py @@ -14,14 +14,13 @@ class PaymentMethodCreditCard(object): """Implementation of the 'Payment Method Credit Card' model. - TODO: type model description here. - Attributes: - card_brand (str): TODO: type description here. - card_expiration (str): TODO: type description here. - last_four (str): TODO: type description here. - masked_card_number (str): TODO: type description here. - mtype (InvoiceEventPaymentMethod): TODO: type description here. + card_brand (str): The model property of type str. + card_expiration (str): The model property of type str. + last_four (str): The model property of type str. + masked_card_number (str): The model property of type str. + mtype (InvoiceEventPaymentMethod): The model property of type + InvoiceEventPaymentMethod. additional_properties (Dict[str, object]): The additional properties for the model. @@ -133,3 +132,21 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('type'), type_callable=lambda value: InvoiceEventPaymentMethod.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'card_brand={self.card_brand!r}, ' + f'card_expiration={self.card_expiration!r}, ' + f'last_four={self.last_four!r}, ' + f'masked_card_number={self.masked_card_number!r}, ' + f'mtype={self.mtype!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'card_brand={self.card_brand!s}, ' + f'card_expiration={self.card_expiration!s}, ' + f'last_four={self.last_four!s}, ' + f'masked_card_number={self.masked_card_number!s}, ' + f'mtype={self.mtype!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_method_external.py b/advancedbilling/models/payment_method_external.py index 7f0e08c5..1632338e 100644 --- a/advancedbilling/models/payment_method_external.py +++ b/advancedbilling/models/payment_method_external.py @@ -14,13 +14,12 @@ class PaymentMethodExternal(object): """Implementation of the 'Payment Method External' model. - TODO: type model description here. - Attributes: - details (str): TODO: type description here. - kind (str): TODO: type description here. - memo (str): TODO: type description here. - mtype (InvoiceEventPaymentMethod): TODO: type description here. + details (str): The model property of type str. + kind (str): The model property of type str. + memo (str): The model property of type str. + mtype (InvoiceEventPaymentMethod): The model property of type + InvoiceEventPaymentMethod. additional_properties (Dict[str, object]): The additional properties for the model. @@ -129,3 +128,19 @@ def validate(cls, dictionary): is_value_nullable=True) \ and APIHelper.is_valid_type(value=dictionary.get('type'), type_callable=lambda value: InvoiceEventPaymentMethod.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'details={self.details!r}, ' + f'kind={self.kind!r}, ' + f'memo={self.memo!r}, ' + f'mtype={self.mtype!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'details={self.details!s}, ' + f'kind={self.kind!s}, ' + f'memo={self.memo!s}, ' + f'mtype={self.mtype!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_method_paypal.py b/advancedbilling/models/payment_method_paypal.py index b2debe94..e9fea0fd 100644 --- a/advancedbilling/models/payment_method_paypal.py +++ b/advancedbilling/models/payment_method_paypal.py @@ -14,11 +14,10 @@ class PaymentMethodPaypal(object): """Implementation of the 'Payment Method Paypal' model. - TODO: type model description here. - Attributes: - email (str): TODO: type description here. - mtype (InvoiceEventPaymentMethod): TODO: type description here. + email (str): The model property of type str. + mtype (InvoiceEventPaymentMethod): The model property of type + InvoiceEventPaymentMethod. additional_properties (Dict[str, object]): The additional properties for the model. @@ -100,3 +99,15 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('type'), type_callable=lambda value: InvoiceEventPaymentMethod.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'email={self.email!r}, ' + f'mtype={self.mtype!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'email={self.email!s}, ' + f'mtype={self.mtype!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_profile_attributes.py b/advancedbilling/models/payment_profile_attributes.py index 478b6bbd..ffcbf226 100644 --- a/advancedbilling/models/payment_profile_attributes.py +++ b/advancedbilling/models/payment_profile_attributes.py @@ -20,13 +20,13 @@ class PaymentProfileAttributes(object): information using chargify.js. This token must be passed as a sole attribute of `payment_profile_attributes` (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) - id (int): TODO: type description here. - payment_type (PaymentType): TODO: type description here. + id (int): The model property of type int. + payment_type (PaymentType): The model property of type PaymentType. first_name (str): (Optional) First name on card or bank account. If omitted, the first_name from customer attributes will be used. last_name (str): (Optional) Last name on card or bank account. If omitted, the last_name from customer attributes will be used. - masked_card_number (str): TODO: type description here. + masked_card_number (str): The model property of type str. full_number (str): The full credit card number (string representation, i.e. 5424000000000015) card_type (CardType): (Optional, used only for Subscription Import) If @@ -78,8 +78,8 @@ class PaymentProfileAttributes(object): Import) (only for Authorize.Net CIM storage or Square) The customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token - customer_id (int): TODO: type description here. - paypal_email (str): TODO: type description here. + customer_id (int): The model property of type int. + paypal_email (str): The model property of type str. payment_method_nonce (str): (Required for Square unless importing with vault_token and customer_vault_token) The nonce generated by the Square Javascript library (SqPaymentForm) @@ -349,3 +349,61 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'chargify_token={self.chargify_token!r}, ' + f'id={self.id!r}, ' + f'payment_type={self.payment_type!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'masked_card_number={self.masked_card_number!r}, ' + f'full_number={self.full_number!r}, ' + f'card_type={self.card_type!r}, ' + f'expiration_month={self.expiration_month!r}, ' + f'expiration_year={self.expiration_year!r}, ' + f'billing_address={self.billing_address!r}, ' + f'billing_address_2={self.billing_address_2!r}, ' + f'billing_city={self.billing_city!r}, ' + f'billing_state={self.billing_state!r}, ' + f'billing_country={self.billing_country!r}, ' + f'billing_zip={self.billing_zip!r}, ' + f'current_vault={self.current_vault!r}, ' + f'vault_token={self.vault_token!r}, ' + f'customer_vault_token={self.customer_vault_token!r}, ' + f'customer_id={self.customer_id!r}, ' + f'paypal_email={self.paypal_email!r}, ' + f'payment_method_nonce={self.payment_method_nonce!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'cvv={self.cvv!r}, ' + f'last_four={self.last_four!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'chargify_token={self.chargify_token!s}, ' + f'id={self.id!s}, ' + f'payment_type={self.payment_type!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'masked_card_number={self.masked_card_number!s}, ' + f'full_number={self.full_number!s}, ' + f'card_type={self.card_type!s}, ' + f'expiration_month={self.expiration_month!s}, ' + f'expiration_year={self.expiration_year!s}, ' + f'billing_address={self.billing_address!s}, ' + f'billing_address_2={self.billing_address_2!s}, ' + f'billing_city={self.billing_city!s}, ' + f'billing_state={self.billing_state!s}, ' + f'billing_country={self.billing_country!s}, ' + f'billing_zip={self.billing_zip!s}, ' + f'current_vault={self.current_vault!s}, ' + f'vault_token={self.vault_token!s}, ' + f'customer_vault_token={self.customer_vault_token!s}, ' + f'customer_id={self.customer_id!s}, ' + f'paypal_email={self.paypal_email!s}, ' + f'payment_method_nonce={self.payment_method_nonce!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'cvv={self.cvv!s}, ' + f'last_four={self.last_four!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_profile_response.py b/advancedbilling/models/payment_profile_response.py index 2b4fac83..01c2a719 100644 --- a/advancedbilling/models/payment_profile_response.py +++ b/advancedbilling/models/payment_profile_response.py @@ -13,12 +13,12 @@ class PaymentProfileResponse(object): """Implementation of the 'Payment Profile Response' model. - TODO: type model description here. - Attributes: payment_profile (ApplePayPaymentProfile | BankAccountPaymentProfile | - CreditCardPaymentProfile | PaypalPaymentProfile): TODO: type - description here. + CreditCardPaymentProfile | PaypalPaymentProfile): The model + property of type ApplePayPaymentProfile | + BankAccountPaymentProfile | CreditCardPaymentProfile | + PaypalPaymentProfile. additional_properties (Dict[str, object]): The additional properties for the model. @@ -91,3 +91,13 @@ def validate(cls, dictionary): return False return UnionTypeLookUp.get('Payment-Profile').validate(dictionary.get('payment_profile')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile={self.payment_profile!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile={self.payment_profile!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_related_events.py b/advancedbilling/models/payment_related_events.py index a78c1c8c..9213fdef 100644 --- a/advancedbilling/models/payment_related_events.py +++ b/advancedbilling/models/payment_related_events.py @@ -13,11 +13,9 @@ class PaymentRelatedEvents(object): """Implementation of the 'Payment Related Events' model. - TODO: type model description here. - Attributes: - product_id (int): TODO: type description here. - account_transaction_id (int): TODO: type description here. + product_id (int): The model property of type int. + account_transaction_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -99,3 +97,15 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, int)) \ and APIHelper.is_valid_type(value=dictionary.get('account_transaction_id'), type_callable=lambda value: isinstance(value, int)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_id={self.product_id!r}, ' + f'account_transaction_id={self.account_transaction_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_id={self.product_id!s}, ' + f'account_transaction_id={self.account_transaction_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/payment_type.py b/advancedbilling/models/payment_type.py index 38007a69..76937f25 100644 --- a/advancedbilling/models/payment_type.py +++ b/advancedbilling/models/payment_type.py @@ -12,13 +12,11 @@ class PaymentType(object): """Implementation of the 'Payment Type' enum. - TODO: type enum description here. - Attributes: - CREDIT_CARD: TODO: type description here. - BANK_ACCOUNT: TODO: type description here. - PAYPAL_ACCOUNT: TODO: type description here. - APPLE_PAY: TODO: type description here. + CREDIT_CARD: The enum member of type str. + BANK_ACCOUNT: The enum member of type str. + PAYPAL_ACCOUNT: The enum member of type str. + APPLE_PAY: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/paypal_payment_profile.py b/advancedbilling/models/paypal_payment_profile.py index 8d7068ce..bc8cfb9b 100644 --- a/advancedbilling/models/paypal_payment_profile.py +++ b/advancedbilling/models/paypal_payment_profile.py @@ -14,8 +14,6 @@ class PaypalPaymentProfile(object): """Implementation of the 'Paypal Payment Profile' model. - TODO: type model description here. - Attributes: id (int): The Chargify-assigned ID of the stored PayPal payment profile. @@ -37,13 +35,13 @@ class PaypalPaymentProfile(object): account billing_country (str): The current billing address country for the PayPal account - customer_vault_token (str): TODO: type description here. + customer_vault_token (str): The model property of type str. billing_address_2 (str): The current billing street address, second line, for the PayPal account - payment_type (PaymentType): TODO: type description here. - site_gateway_setting_id (int): TODO: type description here. - gateway_handle (str): TODO: type description here. - paypal_email (str): TODO: type description here. + payment_type (PaymentType): The model property of type PaymentType. + site_gateway_setting_id (int): The model property of type int. + gateway_handle (str): The model property of type str. + paypal_email (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -243,3 +241,45 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('payment_type'), type_callable=lambda value: PaymentType.validate(value)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'customer_id={self.customer_id!r}, ' + f'current_vault={self.current_vault!r}, ' + f'vault_token={self.vault_token!r}, ' + f'billing_address={self.billing_address!r}, ' + f'billing_city={self.billing_city!r}, ' + f'billing_state={self.billing_state!r}, ' + f'billing_zip={self.billing_zip!r}, ' + f'billing_country={self.billing_country!r}, ' + f'customer_vault_token={self.customer_vault_token!r}, ' + f'billing_address_2={self.billing_address_2!r}, ' + f'payment_type={self.payment_type!r}, ' + f'site_gateway_setting_id={self.site_gateway_setting_id!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'paypal_email={self.paypal_email!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'customer_id={self.customer_id!s}, ' + f'current_vault={self.current_vault!s}, ' + f'vault_token={self.vault_token!s}, ' + f'billing_address={self.billing_address!s}, ' + f'billing_city={self.billing_city!s}, ' + f'billing_state={self.billing_state!s}, ' + f'billing_zip={self.billing_zip!s}, ' + f'billing_country={self.billing_country!s}, ' + f'customer_vault_token={self.customer_vault_token!s}, ' + f'billing_address_2={self.billing_address_2!s}, ' + f'payment_type={self.payment_type!s}, ' + f'site_gateway_setting_id={self.site_gateway_setting_id!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'paypal_email={self.paypal_email!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/pending_cancellation_change.py b/advancedbilling/models/pending_cancellation_change.py index 214eb2e8..49e880b1 100644 --- a/advancedbilling/models/pending_cancellation_change.py +++ b/advancedbilling/models/pending_cancellation_change.py @@ -13,11 +13,9 @@ class PendingCancellationChange(object): """Implementation of the 'Pending Cancellation Change' model. - TODO: type model description here. - Attributes: - cancellation_state (str): TODO: type description here. - cancels_at (datetime): TODO: type description here. + cancellation_state (str): The model property of type str. + cancels_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -99,3 +97,15 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('cancels_at'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'cancellation_state={self.cancellation_state!r}, ' + f'cancels_at={self.cancels_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'cancellation_state={self.cancellation_state!s}, ' + f'cancels_at={self.cancels_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/portal_management_link.py b/advancedbilling/models/portal_management_link.py index 0da9c8f9..ea318b7b 100644 --- a/advancedbilling/models/portal_management_link.py +++ b/advancedbilling/models/portal_management_link.py @@ -13,15 +13,13 @@ class PortalManagementLink(object): """Implementation of the 'Portal Management Link' model. - TODO: type model description here. - Attributes: - url (str): TODO: type description here. - fetch_count (int): TODO: type description here. - created_at (datetime): TODO: type description here. - new_link_available_at (datetime): TODO: type description here. - expires_at (datetime): TODO: type description here. - last_invite_sent_at (datetime): TODO: type description here. + url (str): The model property of type str. + fetch_count (int): The model property of type int. + created_at (datetime): The model property of type datetime. + new_link_available_at (datetime): The model property of type datetime. + expires_at (datetime): The model property of type datetime. + last_invite_sent_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -117,3 +115,23 @@ def from_dictionary(cls, expires_at, last_invite_sent_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'url={self.url!r}, ' + f'fetch_count={self.fetch_count!r}, ' + f'created_at={self.created_at!r}, ' + f'new_link_available_at={self.new_link_available_at!r}, ' + f'expires_at={self.expires_at!r}, ' + f'last_invite_sent_at={self.last_invite_sent_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'url={self.url!s}, ' + f'fetch_count={self.fetch_count!s}, ' + f'created_at={self.created_at!s}, ' + f'new_link_available_at={self.new_link_available_at!s}, ' + f'expires_at={self.expires_at!s}, ' + f'last_invite_sent_at={self.last_invite_sent_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepaid_configuration.py b/advancedbilling/models/prepaid_configuration.py index 46530f6d..18e0c86a 100644 --- a/advancedbilling/models/prepaid_configuration.py +++ b/advancedbilling/models/prepaid_configuration.py @@ -13,16 +13,13 @@ class PrepaidConfiguration(object): """Implementation of the 'Prepaid Configuration' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - initial_funding_amount_in_cents (long|int): TODO: type description - here. - replenish_to_amount_in_cents (long|int): TODO: type description here. - auto_replenish (bool): TODO: type description here. - replenish_threshold_amount_in_cents (long|int): TODO: type description - here. + id (int): The model property of type int. + initial_funding_amount_in_cents (int): The model property of type int. + replenish_to_amount_in_cents (int): The model property of type int. + auto_replenish (bool): The model property of type bool. + replenish_threshold_amount_in_cents (int): The model property of type + int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -104,3 +101,21 @@ def from_dictionary(cls, auto_replenish, replenish_threshold_amount_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'initial_funding_amount_in_cents={self.initial_funding_amount_in_cents!r}, ' + f'replenish_to_amount_in_cents={self.replenish_to_amount_in_cents!r}, ' + f'auto_replenish={self.auto_replenish!r}, ' + f'replenish_threshold_amount_in_cents={self.replenish_threshold_amount_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'initial_funding_amount_in_cents={self.initial_funding_amount_in_cents!s}, ' + f'replenish_to_amount_in_cents={self.replenish_to_amount_in_cents!s}, ' + f'auto_replenish={self.auto_replenish!s}, ' + f'replenish_threshold_amount_in_cents={self.replenish_threshold_amount_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepaid_configuration_response.py b/advancedbilling/models/prepaid_configuration_response.py index 4c4834e1..93728c6a 100644 --- a/advancedbilling/models/prepaid_configuration_response.py +++ b/advancedbilling/models/prepaid_configuration_response.py @@ -13,11 +13,9 @@ class PrepaidConfigurationResponse(object): """Implementation of the 'Prepaid Configuration Response' model. - TODO: type model description here. - Attributes: - prepaid_configuration (PrepaidConfiguration): TODO: type description - here. + prepaid_configuration (PrepaidConfiguration): The model property of + type PrepaidConfiguration. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(prepaid_configuration, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepaid_configuration={self.prepaid_configuration!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepaid_configuration={self.prepaid_configuration!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepaid_product_price_point_filter.py b/advancedbilling/models/prepaid_product_price_point_filter.py index 9a974d3f..c96d7ed6 100644 --- a/advancedbilling/models/prepaid_product_price_point_filter.py +++ b/advancedbilling/models/prepaid_product_price_point_filter.py @@ -12,8 +12,6 @@ class PrepaidProductPricePointFilter(object): """Implementation of the 'Prepaid Product Price Point Filter' model. - TODO: type model description here. - Attributes: product_price_point_id (str): Passed as a parameter to list methods to return only non null values. @@ -63,3 +61,13 @@ def from_dictionary(cls, additional_properties = {k: v for k, v in dictionary.items() if k not in cls._names.values()} # Return an object of this model return cls(additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepaid_subscription_balance_changed.py b/advancedbilling/models/prepaid_subscription_balance_changed.py index bd51539c..7e363cf6 100644 --- a/advancedbilling/models/prepaid_subscription_balance_changed.py +++ b/advancedbilling/models/prepaid_subscription_balance_changed.py @@ -13,15 +13,12 @@ class PrepaidSubscriptionBalanceChanged(object): """Implementation of the 'Prepaid Subscription Balance Changed' model. - TODO: type model description here. - Attributes: - reason (str): TODO: type description here. - current_account_balance_in_cents (long|int): TODO: type description - here. - prepayment_account_balance_in_cents (long|int): TODO: type description - here. - current_usage_amount_in_cents (long|int): TODO: type description here. + reason (str): The model property of type str. + current_account_balance_in_cents (int): The model property of type int. + prepayment_account_balance_in_cents (int): The model property of type + int. + current_usage_amount_in_cents (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -121,3 +118,19 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, int)) \ and APIHelper.is_valid_type(value=dictionary.get('current_usage_amount_in_cents'), type_callable=lambda value: isinstance(value, int)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'reason={self.reason!r}, ' + f'current_account_balance_in_cents={self.current_account_balance_in_cents!r}, ' + f'prepayment_account_balance_in_cents={self.prepayment_account_balance_in_cents!r}, ' + f'current_usage_amount_in_cents={self.current_usage_amount_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'reason={self.reason!s}, ' + f'current_account_balance_in_cents={self.current_account_balance_in_cents!s}, ' + f'prepayment_account_balance_in_cents={self.prepayment_account_balance_in_cents!s}, ' + f'current_usage_amount_in_cents={self.current_usage_amount_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepaid_usage.py b/advancedbilling/models/prepaid_usage.py index f51bdd42..ff3a6000 100644 --- a/advancedbilling/models/prepaid_usage.py +++ b/advancedbilling/models/prepaid_usage.py @@ -14,20 +14,18 @@ class PrepaidUsage(object): """Implementation of the 'Prepaid Usage' model. - TODO: type model description here. - Attributes: - previous_unit_balance (str): TODO: type description here. - previous_overage_unit_balance (str): TODO: type description here. - new_unit_balance (int): TODO: type description here. - new_overage_unit_balance (int): TODO: type description here. - usage_quantity (int): TODO: type description here. - overage_usage_quantity (int): TODO: type description here. - component_id (int): TODO: type description here. - component_handle (str): TODO: type description here. - memo (str): TODO: type description here. - allocation_details (List[PrepaidUsageAllocationDetail]): TODO: type - description here. + previous_unit_balance (str): The model property of type str. + previous_overage_unit_balance (str): The model property of type str. + new_unit_balance (int): The model property of type int. + new_overage_unit_balance (int): The model property of type int. + usage_quantity (int): The model property of type int. + overage_usage_quantity (int): The model property of type int. + component_id (int): The model property of type int. + component_handle (str): The model property of type str. + memo (str): The model property of type str. + allocation_details (List[PrepaidUsageAllocationDetail]): The model + property of type List[PrepaidUsageAllocationDetail]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -187,3 +185,31 @@ def validate(cls, dictionary): type_callable=lambda value: PrepaidUsageAllocationDetail.validate(value), is_model_dict=True, is_inner_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'previous_unit_balance={self.previous_unit_balance!r}, ' + f'previous_overage_unit_balance={self.previous_overage_unit_balance!r}, ' + f'new_unit_balance={self.new_unit_balance!r}, ' + f'new_overage_unit_balance={self.new_overage_unit_balance!r}, ' + f'usage_quantity={self.usage_quantity!r}, ' + f'overage_usage_quantity={self.overage_usage_quantity!r}, ' + f'component_id={self.component_id!r}, ' + f'component_handle={self.component_handle!r}, ' + f'memo={self.memo!r}, ' + f'allocation_details={self.allocation_details!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'previous_unit_balance={self.previous_unit_balance!s}, ' + f'previous_overage_unit_balance={self.previous_overage_unit_balance!s}, ' + f'new_unit_balance={self.new_unit_balance!s}, ' + f'new_overage_unit_balance={self.new_overage_unit_balance!s}, ' + f'usage_quantity={self.usage_quantity!s}, ' + f'overage_usage_quantity={self.overage_usage_quantity!s}, ' + f'component_id={self.component_id!s}, ' + f'component_handle={self.component_handle!s}, ' + f'memo={self.memo!s}, ' + f'allocation_details={self.allocation_details!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepaid_usage_allocation_detail.py b/advancedbilling/models/prepaid_usage_allocation_detail.py index f9c32448..9015fd85 100644 --- a/advancedbilling/models/prepaid_usage_allocation_detail.py +++ b/advancedbilling/models/prepaid_usage_allocation_detail.py @@ -13,12 +13,10 @@ class PrepaidUsageAllocationDetail(object): """Implementation of the 'Prepaid Usage Allocation Detail' model. - TODO: type model description here. - Attributes: - allocation_id (int): TODO: type description here. - charge_id (int): TODO: type description here. - usage_quantity (int): TODO: type description here. + allocation_id (int): The model property of type int. + charge_id (int): The model property of type int. + usage_quantity (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -108,3 +106,17 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'allocation_id={self.allocation_id!r}, ' + f'charge_id={self.charge_id!r}, ' + f'usage_quantity={self.usage_quantity!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'allocation_id={self.allocation_id!s}, ' + f'charge_id={self.charge_id!s}, ' + f'usage_quantity={self.usage_quantity!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepaid_usage_component.py b/advancedbilling/models/prepaid_usage_component.py index f7761e66..c993a5e9 100644 --- a/advancedbilling/models/prepaid_usage_component.py +++ b/advancedbilling/models/prepaid_usage_component.py @@ -16,8 +16,6 @@ class PrepaidUsageComponent(object): """Implementation of the 'Prepaid Usage Component' model. - TODO: type model description here. - Attributes: name (str): A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes". @@ -50,8 +48,8 @@ class PrepaidUsageComponent(object): upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, `prorated`, `none`. - price_points (List[CreatePrepaidUsageComponentPricePoint]): TODO: type - description here. + price_points (List[CreatePrepaidUsageComponentPricePoint]): The model + property of type List[CreatePrepaidUsageComponentPricePoint]. unit_price (str | float | None): The amount the customer will be charged per unit when the pricing scheme is “per_unit”. For On/Off Components, this is the amount that the customer will be charged @@ -65,7 +63,8 @@ class PrepaidUsageComponent(object): hide_date_range_on_invoice (bool): (Only available on Relationship Invoicing sites) Boolean flag describing if the service date range should show for the component on generated invoices. - overage_pricing (OveragePricing): TODO: type description here. + overage_pricing (OveragePricing): The model property of type + OveragePricing. rollover_prepaid_remainder (bool): Boolean which controls whether or not remaining units should be rolled over to the next period renew_prepaid_allocation (bool): Boolean which controls whether or not @@ -75,11 +74,12 @@ class PrepaidUsageComponent(object): rollover_prepaid_remainder is true) The number of `expiration_interval_unit`s after which rollover amounts should expire - expiration_interval_unit (ExpirationIntervalUnit): TODO: type - description here. - display_on_hosted_page (bool): TODO: type description here. - allow_fractional_quantities (bool): TODO: type description here. - public_signup_page_ids (List[int]): TODO: type description here. + expiration_interval_unit (ExpirationIntervalUnit): The model property + of type ExpirationIntervalUnit. + display_on_hosted_page (bool): The model property of type bool. + allow_fractional_quantities (bool): The model property of type bool. + public_signup_page_ids (List[int]): The model property of type + List[int]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -280,3 +280,53 @@ def from_dictionary(cls, allow_fractional_quantities, public_signup_page_ids, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'unit_name={self.unit_name!r}, ' + f'description={self.description!r}, ' + f'handle={self.handle!r}, ' + f'taxable={self.taxable!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'price_points={self.price_points!r}, ' + f'unit_price={self.unit_price!r}, ' + f'tax_code={self.tax_code!r}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!r}, ' + f'overage_pricing={self.overage_pricing!r}, ' + f'rollover_prepaid_remainder={self.rollover_prepaid_remainder!r}, ' + f'renew_prepaid_allocation={self.renew_prepaid_allocation!r}, ' + f'expiration_interval={self.expiration_interval!r}, ' + f'expiration_interval_unit={self.expiration_interval_unit!r}, ' + f'display_on_hosted_page={self.display_on_hosted_page!r}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!r}, ' + f'public_signup_page_ids={self.public_signup_page_ids!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'unit_name={self.unit_name!s}, ' + f'description={self.description!s}, ' + f'handle={self.handle!s}, ' + f'taxable={self.taxable!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'price_points={self.price_points!s}, ' + f'unit_price={self.unit_price!s}, ' + f'tax_code={self.tax_code!s}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!s}, ' + f'overage_pricing={self.overage_pricing!s}, ' + f'rollover_prepaid_remainder={self.rollover_prepaid_remainder!s}, ' + f'renew_prepaid_allocation={self.renew_prepaid_allocation!s}, ' + f'expiration_interval={self.expiration_interval!s}, ' + f'expiration_interval_unit={self.expiration_interval_unit!s}, ' + f'display_on_hosted_page={self.display_on_hosted_page!s}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!s}, ' + f'public_signup_page_ids={self.public_signup_page_ids!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepayment.py b/advancedbilling/models/prepayment.py index 611be60c..3fa1d74c 100644 --- a/advancedbilling/models/prepayment.py +++ b/advancedbilling/models/prepayment.py @@ -13,19 +13,17 @@ class Prepayment(object): """Implementation of the 'Prepayment' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - subscription_id (int): TODO: type description here. - amount_in_cents (long|int): TODO: type description here. - remaining_amount_in_cents (long|int): TODO: type description here. - refunded_amount_in_cents (long|int): TODO: type description here. - details (str): TODO: type description here. - external (bool): TODO: type description here. - memo (str): TODO: type description here. + id (int): The model property of type int. + subscription_id (int): The model property of type int. + amount_in_cents (int): The model property of type int. + remaining_amount_in_cents (int): The model property of type int. + refunded_amount_in_cents (int): The model property of type int. + details (str): The model property of type str. + external (bool): The model property of type bool. + memo (str): The model property of type str. payment_type (PrepaymentMethod): The payment type of the prepayment. - created_at (datetime): TODO: type description here. + created_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -128,3 +126,31 @@ def from_dictionary(cls, details, payment_type, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'remaining_amount_in_cents={self.remaining_amount_in_cents!r}, ' + f'refunded_amount_in_cents={self.refunded_amount_in_cents!r}, ' + f'details={self.details!r}, ' + f'external={self.external!r}, ' + f'memo={self.memo!r}, ' + f'payment_type={self.payment_type!r}, ' + f'created_at={self.created_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'remaining_amount_in_cents={self.remaining_amount_in_cents!s}, ' + f'refunded_amount_in_cents={self.refunded_amount_in_cents!s}, ' + f'details={self.details!s}, ' + f'external={self.external!s}, ' + f'memo={self.memo!s}, ' + f'payment_type={self.payment_type!s}, ' + f'created_at={self.created_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepayment_account_balance_changed.py b/advancedbilling/models/prepayment_account_balance_changed.py index 38cc14a8..cc86047e 100644 --- a/advancedbilling/models/prepayment_account_balance_changed.py +++ b/advancedbilling/models/prepayment_account_balance_changed.py @@ -13,15 +13,13 @@ class PrepaymentAccountBalanceChanged(object): """Implementation of the 'Prepayment Account Balance Changed' model. - TODO: type model description here. - Attributes: - reason (str): TODO: type description here. - prepayment_account_balance_in_cents (long|int): TODO: type description - here. - prepayment_balance_change_in_cents (long|int): TODO: type description - here. - currency_code (str): TODO: type description here. + reason (str): The model property of type str. + prepayment_account_balance_in_cents (int): The model property of type + int. + prepayment_balance_change_in_cents (int): The model property of type + int. + currency_code (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -121,3 +119,19 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, int)) \ and APIHelper.is_valid_type(value=dictionary.get('currency_code'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'reason={self.reason!r}, ' + f'prepayment_account_balance_in_cents={self.prepayment_account_balance_in_cents!r}, ' + f'prepayment_balance_change_in_cents={self.prepayment_balance_change_in_cents!r}, ' + f'currency_code={self.currency_code!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'reason={self.reason!s}, ' + f'prepayment_account_balance_in_cents={self.prepayment_account_balance_in_cents!s}, ' + f'prepayment_balance_change_in_cents={self.prepayment_balance_change_in_cents!s}, ' + f'currency_code={self.currency_code!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepayment_method.py b/advancedbilling/models/prepayment_method.py index 44efd386..7d7244c7 100644 --- a/advancedbilling/models/prepayment_method.py +++ b/advancedbilling/models/prepayment_method.py @@ -12,16 +12,14 @@ class PrepaymentMethod(object): """Implementation of the 'Prepayment Method' enum. - TODO: type enum description here. - Attributes: - CHECK: TODO: type description here. - CASH: TODO: type description here. - MONEY_ORDER: TODO: type description here. - ACH: TODO: type description here. - PAYPAL_ACCOUNT: TODO: type description here. - CREDIT_CARD: TODO: type description here. - OTHER: TODO: type description here. + CHECK: The enum member of type str. + CASH: The enum member of type str. + MONEY_ORDER: The enum member of type str. + ACH: The enum member of type str. + PAYPAL_ACCOUNT: The enum member of type str. + CREDIT_CARD: The enum member of type str. + OTHER: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/prepayment_response.py b/advancedbilling/models/prepayment_response.py index 33009b88..368103f7 100644 --- a/advancedbilling/models/prepayment_response.py +++ b/advancedbilling/models/prepayment_response.py @@ -13,10 +13,8 @@ class PrepaymentResponse(object): """Implementation of the 'Prepayment Response' model. - TODO: type model description here. - Attributes: - prepayment (Prepayment): TODO: type description here. + prepayment (Prepayment): The model property of type Prepayment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(prepayment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepayment={self.prepayment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepayment={self.prepayment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/prepayments_response.py b/advancedbilling/models/prepayments_response.py index 6ce95a9a..41a26abe 100644 --- a/advancedbilling/models/prepayments_response.py +++ b/advancedbilling/models/prepayments_response.py @@ -14,10 +14,9 @@ class PrepaymentsResponse(object): """Implementation of the 'Prepayments Response' model. - TODO: type model description here. - Attributes: - prepayments (List[Prepayment]): TODO: type description here. + prepayments (List[Prepayment]): The model property of type + List[Prepayment]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -75,3 +74,13 @@ def from_dictionary(cls, # Return an object of this model return cls(prepayments, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepayments={self.prepayments!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepayments={self.prepayments!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/preview_allocations_request.py b/advancedbilling/models/preview_allocations_request.py index 1ec9d34b..496c5b20 100644 --- a/advancedbilling/models/preview_allocations_request.py +++ b/advancedbilling/models/preview_allocations_request.py @@ -16,10 +16,9 @@ class PreviewAllocationsRequest(object): """Implementation of the 'Preview Allocations Request' model. - TODO: type model description here. - Attributes: - allocations (List[CreateAllocation]): TODO: type description here. + allocations (List[CreateAllocation]): The model property of type + List[CreateAllocation]. effective_proration_date (date): To calculate proration amounts for a future time. Only within a current subscription period. Only ISO8601 format is supported. @@ -110,3 +109,19 @@ def from_dictionary(cls, upgrade_charge, downgrade_credit, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'allocations={self.allocations!r}, ' + f'effective_proration_date={self.effective_proration_date!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'allocations={self.allocations!s}, ' + f'effective_proration_date={self.effective_proration_date!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/price.py b/advancedbilling/models/price.py index c43e70ed..7d414e6f 100644 --- a/advancedbilling/models/price.py +++ b/advancedbilling/models/price.py @@ -13,11 +13,10 @@ class Price(object): """Implementation of the 'Price' model. - TODO: type model description here. - Attributes: - starting_quantity (int | str): TODO: type description here. - ending_quantity (int | str | None): TODO: type description here. + starting_quantity (int | str): The model property of type int | str. + ending_quantity (int | str | None): The model property of type int | + str | None. unit_price (float | str): The price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or 0.00000065 additional_properties (Dict[str, object]): The additional properties @@ -116,3 +115,17 @@ def validate(cls, dictionary): return UnionTypeLookUp.get('PriceStartingQuantity').validate(dictionary.get('starting_quantity')).is_valid \ and UnionTypeLookUp.get('PriceUnitPrice').validate(dictionary.get('unit_price')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'starting_quantity={self.starting_quantity!r}, ' + f'ending_quantity={self.ending_quantity!r}, ' + f'unit_price={self.unit_price!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'starting_quantity={self.starting_quantity!s}, ' + f'ending_quantity={self.ending_quantity!s}, ' + f'unit_price={self.unit_price!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/price_point_type.py b/advancedbilling/models/price_point_type.py index b269fce5..4ec4657b 100644 --- a/advancedbilling/models/price_point_type.py +++ b/advancedbilling/models/price_point_type.py @@ -20,9 +20,9 @@ class PricePointType(object): for a certain product and is **not** a custom one. Attributes: - CATALOG: TODO: type description here. - DEFAULT: TODO: type description here. - CUSTOM: TODO: type description here. + CATALOG: The enum member of type str. + DEFAULT: The enum member of type str. + CUSTOM: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/pricing_scheme.py b/advancedbilling/models/pricing_scheme.py index 3435e914..43d555fb 100644 --- a/advancedbilling/models/pricing_scheme.py +++ b/advancedbilling/models/pricing_scheme.py @@ -17,10 +17,10 @@ class PricingScheme(object): for an overview of pricing schemes. Attributes: - STAIRSTEP: TODO: type description here. - VOLUME: TODO: type description here. - PER_UNIT: TODO: type description here. - TIERED: TODO: type description here. + STAIRSTEP: The enum member of type str. + VOLUME: The enum member of type str. + PER_UNIT: The enum member of type str. + TIERED: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/product.py b/advancedbilling/models/product.py index 5d1f89e4..f1422334 100644 --- a/advancedbilling/models/product.py +++ b/advancedbilling/models/product.py @@ -15,10 +15,8 @@ class Product(object): """Implementation of the 'Product' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. + id (int): The model property of type int. name (str): The product name handle (str): The product API handle description (str): The product description @@ -37,15 +35,14 @@ class Product(object): created updated_at (datetime): Timestamp indicating when this product was last updated - price_in_cents (long|int): The product price, in integer cents + price_in_cents (int): The product price, in integer cents interval (int): The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this product would renew every 30 days interval_unit (IntervalUnit): A string representing the interval unit for this product, either month or day - initial_charge_in_cents (long|int): The up front charge you have - specified. - trial_price_in_cents (long|int): The price of the trial period for a + initial_charge_in_cents (int): The up front charge you have specified. + trial_price_in_cents (int): The price of the trial period for a subscription to this product, in integer cents. trial_interval (int): A numerical interval for the length of the trial period of a subscription to this product. See the description of @@ -58,20 +55,21 @@ class Product(object): require_credit_card (bool): Boolean that controls whether a payment profile is required to be entered for customers wishing to sign up on this product. - return_params (str): TODO: type description here. - taxable (bool): TODO: type description here. + return_params (str): The model property of type str. + taxable (bool): The model property of type bool. update_return_url (str): The url to which a customer will be returned after a successful account update - initial_charge_after_trial (bool): TODO: type description here. + initial_charge_after_trial (bool): The model property of type bool. version_number (int): The version of the product update_return_params (str): The parameters will append to the url after a successful account update. See [help documentation](https://help.chargify.com/products/product-editing.h tml#return-parameters-after-account-update) - product_family (ProductFamily): TODO: type description here. - public_signup_pages (List[PublicSignupPage]): TODO: type description - here. - product_price_point_name (str): TODO: type description here. + product_family (ProductFamily): The model property of type + ProductFamily. + public_signup_pages (List[PublicSignupPage]): The model property of + type List[PublicSignupPage]. + product_price_point_name (str): The model property of type str. request_billing_address (bool): A boolean indicating whether to request a billing address on any Self-Service Pages that are used by subscribers of this product. @@ -84,12 +82,12 @@ class Product(object): product type. This is especially important when using the Avalara service to tax based on locale. This attribute has a max length of 10 characters. - default_product_price_point_id (int): TODO: type description here. - use_site_exchange_rate (bool): TODO: type description here. + default_product_price_point_id (int): The model property of type int. + use_site_exchange_rate (bool): The model property of type bool. item_category (str): One of the following: Business Software, Consumer Software, Digital Services, Physical Goods, Other - product_price_point_id (int): TODO: type description here. - product_price_point_handle (str): TODO: type description here. + product_price_point_id (int): The model property of type int. + product_price_point_handle (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -423,3 +421,85 @@ def from_dictionary(cls, product_price_point_id, product_price_point_handle, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'description={self.description!r}, ' + f'accounting_code={self.accounting_code!r}, ' + f'request_credit_card={self.request_credit_card!r}, ' + f'expiration_interval={self.expiration_interval!r}, ' + f'expiration_interval_unit={self.expiration_interval_unit!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'price_in_cents={self.price_in_cents!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'initial_charge_in_cents={self.initial_charge_in_cents!r}, ' + f'trial_price_in_cents={self.trial_price_in_cents!r}, ' + f'trial_interval={self.trial_interval!r}, ' + f'trial_interval_unit={self.trial_interval_unit!r}, ' + f'archived_at={self.archived_at!r}, ' + f'require_credit_card={self.require_credit_card!r}, ' + f'return_params={self.return_params!r}, ' + f'taxable={self.taxable!r}, ' + f'update_return_url={self.update_return_url!r}, ' + f'initial_charge_after_trial={self.initial_charge_after_trial!r}, ' + f'version_number={self.version_number!r}, ' + f'update_return_params={self.update_return_params!r}, ' + f'product_family={self.product_family!r}, ' + f'public_signup_pages={self.public_signup_pages!r}, ' + f'product_price_point_name={self.product_price_point_name!r}, ' + f'request_billing_address={self.request_billing_address!r}, ' + f'require_billing_address={self.require_billing_address!r}, ' + f'require_shipping_address={self.require_shipping_address!r}, ' + f'tax_code={self.tax_code!r}, ' + f'default_product_price_point_id={self.default_product_price_point_id!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'item_category={self.item_category!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'product_price_point_handle={self.product_price_point_handle!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'description={self.description!s}, ' + f'accounting_code={self.accounting_code!s}, ' + f'request_credit_card={self.request_credit_card!s}, ' + f'expiration_interval={self.expiration_interval!s}, ' + f'expiration_interval_unit={self.expiration_interval_unit!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'price_in_cents={self.price_in_cents!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'initial_charge_in_cents={self.initial_charge_in_cents!s}, ' + f'trial_price_in_cents={self.trial_price_in_cents!s}, ' + f'trial_interval={self.trial_interval!s}, ' + f'trial_interval_unit={self.trial_interval_unit!s}, ' + f'archived_at={self.archived_at!s}, ' + f'require_credit_card={self.require_credit_card!s}, ' + f'return_params={self.return_params!s}, ' + f'taxable={self.taxable!s}, ' + f'update_return_url={self.update_return_url!s}, ' + f'initial_charge_after_trial={self.initial_charge_after_trial!s}, ' + f'version_number={self.version_number!s}, ' + f'update_return_params={self.update_return_params!s}, ' + f'product_family={self.product_family!s}, ' + f'public_signup_pages={self.public_signup_pages!s}, ' + f'product_price_point_name={self.product_price_point_name!s}, ' + f'request_billing_address={self.request_billing_address!s}, ' + f'require_billing_address={self.require_billing_address!s}, ' + f'require_shipping_address={self.require_shipping_address!s}, ' + f'tax_code={self.tax_code!s}, ' + f'default_product_price_point_id={self.default_product_price_point_id!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'item_category={self.item_category!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'product_price_point_handle={self.product_price_point_handle!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/product_family.py b/advancedbilling/models/product_family.py index 16098567..d6ee3364 100644 --- a/advancedbilling/models/product_family.py +++ b/advancedbilling/models/product_family.py @@ -13,16 +13,14 @@ class ProductFamily(object): """Implementation of the 'Product Family' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - name (str): TODO: type description here. - handle (str): TODO: type description here. - accounting_code (str): TODO: type description here. - description (str): TODO: type description here. - created_at (datetime): TODO: type description here. - updated_at (datetime): TODO: type description here. + id (int): The model property of type int. + name (str): The model property of type str. + handle (str): The model property of type str. + accounting_code (str): The model property of type str. + description (str): The model property of type str. + created_at (datetime): The model property of type datetime. + updated_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -123,3 +121,25 @@ def from_dictionary(cls, created_at, updated_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'accounting_code={self.accounting_code!r}, ' + f'description={self.description!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'accounting_code={self.accounting_code!s}, ' + f'description={self.description!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/product_family_response.py b/advancedbilling/models/product_family_response.py index 46503261..6df658ae 100644 --- a/advancedbilling/models/product_family_response.py +++ b/advancedbilling/models/product_family_response.py @@ -14,10 +14,9 @@ class ProductFamilyResponse(object): """Implementation of the 'Product Family Response' model. - TODO: type model description here. - Attributes: - product_family (ProductFamily): TODO: type description here. + product_family (ProductFamily): The model property of type + ProductFamily. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +70,13 @@ def from_dictionary(cls, # Return an object of this model return cls(product_family, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_family={self.product_family!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_family={self.product_family!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/product_price_point.py b/advancedbilling/models/product_price_point.py index 7ab5f6b6..8c850a04 100644 --- a/advancedbilling/models/product_price_point.py +++ b/advancedbilling/models/product_price_point.py @@ -14,31 +14,28 @@ class ProductPricePoint(object): """Implementation of the 'Product Price Point' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. + id (int): The model property of type int. name (str): The product price point name handle (str): The product price point API handle - price_in_cents (long|int): The product price point price, in integer - cents + price_in_cents (int): The product price point price, in integer cents interval (int): The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this product price point would renew every 30 days interval_unit (IntervalUnit): A string representing the interval unit for this product price point, either month or day - trial_price_in_cents (long|int): The product price point trial price, - in integer cents + trial_price_in_cents (int): The product price point trial price, in + integer cents trial_interval (int): The numerical trial interval. i.e. an interval of ‘30’ coupled with a trial_interval_unit of day would mean this product price point trial would last 30 days trial_interval_unit (IntervalUnit): A string representing the trial interval unit for this product price point, either month or day - trial_type (str): TODO: type description here. + trial_type (str): The model property of type str. introductory_offer (bool): reserved for future use - initial_charge_in_cents (long|int): The product price point initial - charge, in integer cents - initial_charge_after_trial (bool): TODO: type description here. + initial_charge_in_cents (int): The product price point initial charge, + in integer cents + initial_charge_after_trial (bool): The model property of type bool. expiration_interval (int): The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product price @@ -299,3 +296,59 @@ def from_dictionary(cls, subscription_id, currency_prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'price_in_cents={self.price_in_cents!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'trial_price_in_cents={self.trial_price_in_cents!r}, ' + f'trial_interval={self.trial_interval!r}, ' + f'trial_interval_unit={self.trial_interval_unit!r}, ' + f'trial_type={self.trial_type!r}, ' + f'introductory_offer={self.introductory_offer!r}, ' + f'initial_charge_in_cents={self.initial_charge_in_cents!r}, ' + f'initial_charge_after_trial={self.initial_charge_after_trial!r}, ' + f'expiration_interval={self.expiration_interval!r}, ' + f'expiration_interval_unit={self.expiration_interval_unit!r}, ' + f'product_id={self.product_id!r}, ' + f'archived_at={self.archived_at!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'mtype={self.mtype!r}, ' + f'tax_included={self.tax_included!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'currency_prices={self.currency_prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'price_in_cents={self.price_in_cents!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'trial_price_in_cents={self.trial_price_in_cents!s}, ' + f'trial_interval={self.trial_interval!s}, ' + f'trial_interval_unit={self.trial_interval_unit!s}, ' + f'trial_type={self.trial_type!s}, ' + f'introductory_offer={self.introductory_offer!s}, ' + f'initial_charge_in_cents={self.initial_charge_in_cents!s}, ' + f'initial_charge_after_trial={self.initial_charge_after_trial!s}, ' + f'expiration_interval={self.expiration_interval!s}, ' + f'expiration_interval_unit={self.expiration_interval_unit!s}, ' + f'product_id={self.product_id!s}, ' + f'archived_at={self.archived_at!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'mtype={self.mtype!s}, ' + f'tax_included={self.tax_included!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'currency_prices={self.currency_prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/product_price_point_errors.py b/advancedbilling/models/product_price_point_errors.py index 00b97adf..079f8c7f 100644 --- a/advancedbilling/models/product_price_point_errors.py +++ b/advancedbilling/models/product_price_point_errors.py @@ -13,15 +13,13 @@ class ProductPricePointErrors(object): """Implementation of the 'Product Price Point Errors' model. - TODO: type model description here. - Attributes: - price_point (str): TODO: type description here. - interval (List[str]): TODO: type description here. - interval_unit (List[str]): TODO: type description here. - name (List[str]): TODO: type description here. - price (List[str]): TODO: type description here. - price_in_cents (List[str]): TODO: type description here. + price_point (str): The model property of type str. + interval (List[str]): The model property of type List[str]. + interval_unit (List[str]): The model property of type List[str]. + name (List[str]): The model property of type List[str]. + price (List[str]): The model property of type List[str]. + price_in_cents (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -110,3 +108,23 @@ def from_dictionary(cls, price, price_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'name={self.name!r}, ' + f'price={self.price!r}, ' + f'price_in_cents={self.price_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'name={self.name!s}, ' + f'price={self.price!s}, ' + f'price_in_cents={self.price_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/product_price_point_response.py b/advancedbilling/models/product_price_point_response.py index 5a652231..a0cedf89 100644 --- a/advancedbilling/models/product_price_point_response.py +++ b/advancedbilling/models/product_price_point_response.py @@ -13,10 +13,9 @@ class ProductPricePointResponse(object): """Implementation of the 'Product Price Point Response' model. - TODO: type model description here. - Attributes: - price_point (ProductPricePoint): TODO: type description here. + price_point (ProductPricePoint): The model property of type + ProductPricePoint. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(price_point, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/product_response.py b/advancedbilling/models/product_response.py index a3d90087..db146952 100644 --- a/advancedbilling/models/product_response.py +++ b/advancedbilling/models/product_response.py @@ -13,10 +13,8 @@ class ProductResponse(object): """Implementation of the 'Product Response' model. - TODO: type model description here. - Attributes: - product (Product): TODO: type description here. + product (Product): The model property of type Product. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(product, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product={self.product!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product={self.product!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/proforma_error.py b/advancedbilling/models/proforma_error.py index a11f1490..9cf6c734 100644 --- a/advancedbilling/models/proforma_error.py +++ b/advancedbilling/models/proforma_error.py @@ -14,8 +14,6 @@ class ProformaError(object): """Implementation of the 'Proforma Error' model. - TODO: type model description here. - Attributes: subscription (BaseStringError): The error is base if it is not directly associated with a single attribute. @@ -72,3 +70,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/proforma_invoice.py b/advancedbilling/models/proforma_invoice.py index e7be60d3..4fbe471f 100644 --- a/advancedbilling/models/proforma_invoice.py +++ b/advancedbilling/models/proforma_invoice.py @@ -24,25 +24,24 @@ class ProformaInvoice(object): """Implementation of the 'Proforma Invoice' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - site_id (int): TODO: type description here. - customer_id (int): TODO: type description here. - subscription_id (int): TODO: type description here. - number (int): TODO: type description here. - sequence_number (int): TODO: type description here. - created_at (datetime): TODO: type description here. - delivery_date (date): TODO: type description here. - status (ProformaInvoiceStatus): TODO: type description here. + uid (str): The model property of type str. + site_id (int): The model property of type int. + customer_id (int): The model property of type int. + subscription_id (int): The model property of type int. + number (int): The model property of type int. + sequence_number (int): The model property of type int. + created_at (datetime): The model property of type datetime. + delivery_date (date): The model property of type date. + status (ProformaInvoiceStatus): The model property of type + ProformaInvoiceStatus. collection_method (CollectionMethod): The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For current Relationship Invoicing Architecture valid options are - `remittance`, `automatic`, `prepaid`. - payment_instructions (str): TODO: type description here. - currency (str): TODO: type description here. + payment_instructions (str): The model property of type str. + currency (str): The model property of type str. consolidation_level (InvoiceConsolidationLevel): Consolidation level of the invoice, which is applicable to invoice consolidation. It will hold one of the following values: * "none": A normal invoice @@ -54,32 +53,40 @@ class ProformaInvoice(object): segments. See also the [invoice consolidation documentation](https://maxio.zendesk.com/hc/en-us/articles/24252269 909389-Invoice-Consolidation). - product_name (str): TODO: type description here. - product_family_name (str): TODO: type description here. + product_name (str): The model property of type str. + product_family_name (str): The model property of type str. role (ProformaInvoiceRole): 'proforma' value is deprecated in favor of proforma_adhoc and proforma_automatic seller (InvoiceSeller): Information about the seller (merchant) listed on the masthead of the invoice. customer (InvoiceCustomer): Information about the customer who is owner or recipient the invoiced subscription. - memo (str): TODO: type description here. - billing_address (InvoiceAddress): TODO: type description here. - shipping_address (InvoiceAddress): TODO: type description here. - subtotal_amount (str): TODO: type description here. - discount_amount (str): TODO: type description here. - tax_amount (str): TODO: type description here. - total_amount (str): TODO: type description here. - credit_amount (str): TODO: type description here. - paid_amount (str): TODO: type description here. - refund_amount (str): TODO: type description here. - due_amount (str): TODO: type description here. - line_items (List[InvoiceLineItem]): TODO: type description here. - discounts (List[ProformaInvoiceDiscount]): TODO: type description here. - taxes (List[ProformaInvoiceTax]): TODO: type description here. - credits (List[ProformaInvoiceCredit]): TODO: type description here. - payments (List[ProformaInvoicePayment]): TODO: type description here. - custom_fields (List[InvoiceCustomField]): TODO: type description here. - public_url (str): TODO: type description here. + memo (str): The model property of type str. + billing_address (InvoiceAddress): The model property of type + InvoiceAddress. + shipping_address (InvoiceAddress): The model property of type + InvoiceAddress. + subtotal_amount (str): The model property of type str. + discount_amount (str): The model property of type str. + tax_amount (str): The model property of type str. + total_amount (str): The model property of type str. + credit_amount (str): The model property of type str. + paid_amount (str): The model property of type str. + refund_amount (str): The model property of type str. + due_amount (str): The model property of type str. + line_items (List[InvoiceLineItem]): The model property of type + List[InvoiceLineItem]. + discounts (List[ProformaInvoiceDiscount]): The model property of type + List[ProformaInvoiceDiscount]. + taxes (List[ProformaInvoiceTax]): The model property of type + List[ProformaInvoiceTax]. + credits (List[ProformaInvoiceCredit]): The model property of type + List[ProformaInvoiceCredit]. + payments (List[ProformaInvoicePayment]): The model property of type + List[ProformaInvoicePayment]. + custom_fields (List[InvoiceCustomField]): The model property of type + List[InvoiceCustomField]. + public_url (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -410,3 +417,83 @@ def from_dictionary(cls, custom_fields, public_url, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'site_id={self.site_id!r}, ' + f'customer_id={self.customer_id!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'number={self.number!r}, ' + f'sequence_number={self.sequence_number!r}, ' + f'created_at={self.created_at!r}, ' + f'delivery_date={self.delivery_date!r}, ' + f'status={self.status!r}, ' + f'collection_method={self.collection_method!r}, ' + f'payment_instructions={self.payment_instructions!r}, ' + f'currency={self.currency!r}, ' + f'consolidation_level={self.consolidation_level!r}, ' + f'product_name={self.product_name!r}, ' + f'product_family_name={self.product_family_name!r}, ' + f'role={self.role!r}, ' + f'seller={self.seller!r}, ' + f'customer={self.customer!r}, ' + f'memo={self.memo!r}, ' + f'billing_address={self.billing_address!r}, ' + f'shipping_address={self.shipping_address!r}, ' + f'subtotal_amount={self.subtotal_amount!r}, ' + f'discount_amount={self.discount_amount!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'total_amount={self.total_amount!r}, ' + f'credit_amount={self.credit_amount!r}, ' + f'paid_amount={self.paid_amount!r}, ' + f'refund_amount={self.refund_amount!r}, ' + f'due_amount={self.due_amount!r}, ' + f'line_items={self.line_items!r}, ' + f'discounts={self.discounts!r}, ' + f'taxes={self.taxes!r}, ' + f'credits={self.credits!r}, ' + f'payments={self.payments!r}, ' + f'custom_fields={self.custom_fields!r}, ' + f'public_url={self.public_url!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'site_id={self.site_id!s}, ' + f'customer_id={self.customer_id!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'number={self.number!s}, ' + f'sequence_number={self.sequence_number!s}, ' + f'created_at={self.created_at!s}, ' + f'delivery_date={self.delivery_date!s}, ' + f'status={self.status!s}, ' + f'collection_method={self.collection_method!s}, ' + f'payment_instructions={self.payment_instructions!s}, ' + f'currency={self.currency!s}, ' + f'consolidation_level={self.consolidation_level!s}, ' + f'product_name={self.product_name!s}, ' + f'product_family_name={self.product_family_name!s}, ' + f'role={self.role!s}, ' + f'seller={self.seller!s}, ' + f'customer={self.customer!s}, ' + f'memo={self.memo!s}, ' + f'billing_address={self.billing_address!s}, ' + f'shipping_address={self.shipping_address!s}, ' + f'subtotal_amount={self.subtotal_amount!s}, ' + f'discount_amount={self.discount_amount!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'total_amount={self.total_amount!s}, ' + f'credit_amount={self.credit_amount!s}, ' + f'paid_amount={self.paid_amount!s}, ' + f'refund_amount={self.refund_amount!s}, ' + f'due_amount={self.due_amount!s}, ' + f'line_items={self.line_items!s}, ' + f'discounts={self.discounts!s}, ' + f'taxes={self.taxes!s}, ' + f'credits={self.credits!s}, ' + f'payments={self.payments!s}, ' + f'custom_fields={self.custom_fields!s}, ' + f'public_url={self.public_url!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/proforma_invoice_credit.py b/advancedbilling/models/proforma_invoice_credit.py index 63db02dd..43cccd6e 100644 --- a/advancedbilling/models/proforma_invoice_credit.py +++ b/advancedbilling/models/proforma_invoice_credit.py @@ -13,13 +13,11 @@ class ProformaInvoiceCredit(object): """Implementation of the 'Proforma Invoice Credit' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - memo (str): TODO: type description here. - original_amount (str): TODO: type description here. - applied_amount (str): TODO: type description here. + uid (str): The model property of type str. + memo (str): The model property of type str. + original_amount (str): The model property of type str. + applied_amount (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -94,3 +92,19 @@ def from_dictionary(cls, original_amount, applied_amount, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'memo={self.memo!r}, ' + f'original_amount={self.original_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'memo={self.memo!s}, ' + f'original_amount={self.original_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/proforma_invoice_discount.py b/advancedbilling/models/proforma_invoice_discount.py index a8723169..2589db8f 100644 --- a/advancedbilling/models/proforma_invoice_discount.py +++ b/advancedbilling/models/proforma_invoice_discount.py @@ -14,19 +14,18 @@ class ProformaInvoiceDiscount(object): """Implementation of the 'Proforma Invoice Discount' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - title (str): TODO: type description here. - code (str): TODO: type description here. - source_type (ProformaInvoiceDiscountSourceType): TODO: type - description here. - discount_type (InvoiceDiscountType): TODO: type description here. - eligible_amount (str): TODO: type description here. - discount_amount (str): TODO: type description here. - line_item_breakouts (List[InvoiceDiscountBreakout]): TODO: type - description here. + uid (str): The model property of type str. + title (str): The model property of type str. + code (str): The model property of type str. + source_type (ProformaInvoiceDiscountSourceType): The model property of + type ProformaInvoiceDiscountSourceType. + discount_type (InvoiceDiscountType): The model property of type + InvoiceDiscountType. + eligible_amount (str): The model property of type str. + discount_amount (str): The model property of type str. + line_item_breakouts (List[InvoiceDiscountBreakout]): The model + property of type List[InvoiceDiscountBreakout]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -133,3 +132,27 @@ def from_dictionary(cls, discount_amount, line_item_breakouts, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'title={self.title!r}, ' + f'code={self.code!r}, ' + f'source_type={self.source_type!r}, ' + f'discount_type={self.discount_type!r}, ' + f'eligible_amount={self.eligible_amount!r}, ' + f'discount_amount={self.discount_amount!r}, ' + f'line_item_breakouts={self.line_item_breakouts!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'title={self.title!s}, ' + f'code={self.code!s}, ' + f'source_type={self.source_type!s}, ' + f'discount_type={self.discount_type!s}, ' + f'eligible_amount={self.eligible_amount!s}, ' + f'discount_amount={self.discount_amount!s}, ' + f'line_item_breakouts={self.line_item_breakouts!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/proforma_invoice_discount_source_type.py b/advancedbilling/models/proforma_invoice_discount_source_type.py index ef0d8bea..e127697e 100644 --- a/advancedbilling/models/proforma_invoice_discount_source_type.py +++ b/advancedbilling/models/proforma_invoice_discount_source_type.py @@ -12,11 +12,9 @@ class ProformaInvoiceDiscountSourceType(object): """Implementation of the 'Proforma Invoice Discount Source Type' enum. - TODO: type enum description here. - Attributes: - COUPON: TODO: type description here. - REFERRAL: TODO: type description here. + COUPON: The enum member of type str. + REFERRAL: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/proforma_invoice_issued.py b/advancedbilling/models/proforma_invoice_issued.py index 2c54c8c7..0597ec80 100644 --- a/advancedbilling/models/proforma_invoice_issued.py +++ b/advancedbilling/models/proforma_invoice_issued.py @@ -17,21 +17,19 @@ class ProformaInvoiceIssued(object): """Implementation of the 'Proforma Invoice Issued' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - number (str): TODO: type description here. - role (str): TODO: type description here. - delivery_date (date): TODO: type description here. - created_at (datetime): TODO: type description here. - due_amount (str): TODO: type description here. - paid_amount (str): TODO: type description here. - tax_amount (str): TODO: type description here. - total_amount (str): TODO: type description here. - product_name (str): TODO: type description here. - line_items (List[InvoiceLineItemEventData]): TODO: type description - here. + uid (str): The model property of type str. + number (str): The model property of type str. + role (str): The model property of type str. + delivery_date (date): The model property of type date. + created_at (datetime): The model property of type datetime. + due_amount (str): The model property of type str. + paid_amount (str): The model property of type str. + tax_amount (str): The model property of type str. + total_amount (str): The model property of type str. + product_name (str): The model property of type str. + line_items (List[InvoiceLineItemEventData]): The model property of + type List[InvoiceLineItemEventData]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -200,3 +198,33 @@ def validate(cls, dictionary): type_callable=lambda value: InvoiceLineItemEventData.validate(value), is_model_dict=True, is_inner_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'number={self.number!r}, ' + f'role={self.role!r}, ' + f'delivery_date={self.delivery_date!r}, ' + f'created_at={self.created_at!r}, ' + f'due_amount={self.due_amount!r}, ' + f'paid_amount={self.paid_amount!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'total_amount={self.total_amount!r}, ' + f'product_name={self.product_name!r}, ' + f'line_items={self.line_items!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'number={self.number!s}, ' + f'role={self.role!s}, ' + f'delivery_date={self.delivery_date!s}, ' + f'created_at={self.created_at!s}, ' + f'due_amount={self.due_amount!s}, ' + f'paid_amount={self.paid_amount!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'total_amount={self.total_amount!s}, ' + f'product_name={self.product_name!s}, ' + f'line_items={self.line_items!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/proforma_invoice_payment.py b/advancedbilling/models/proforma_invoice_payment.py index 6b801add..02a780c5 100644 --- a/advancedbilling/models/proforma_invoice_payment.py +++ b/advancedbilling/models/proforma_invoice_payment.py @@ -13,13 +13,11 @@ class ProformaInvoicePayment(object): """Implementation of the 'Proforma Invoice Payment' model. - TODO: type model description here. - Attributes: - memo (str): TODO: type description here. - original_amount (str): TODO: type description here. - applied_amount (str): TODO: type description here. - prepayment (bool): TODO: type description here. + memo (str): The model property of type str. + original_amount (str): The model property of type str. + applied_amount (str): The model property of type str. + prepayment (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -94,3 +92,19 @@ def from_dictionary(cls, applied_amount, prepayment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'memo={self.memo!r}, ' + f'original_amount={self.original_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'prepayment={self.prepayment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'memo={self.memo!s}, ' + f'original_amount={self.original_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'prepayment={self.prepayment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/proforma_invoice_role.py b/advancedbilling/models/proforma_invoice_role.py index 070556be..1d8f72c6 100644 --- a/advancedbilling/models/proforma_invoice_role.py +++ b/advancedbilling/models/proforma_invoice_role.py @@ -16,10 +16,10 @@ class ProformaInvoiceRole(object): proforma_automatic Attributes: - UNSET: TODO: type description here. - PROFORMA: TODO: type description here. - PROFORMA_ADHOC: TODO: type description here. - PROFORMA_AUTOMATIC: TODO: type description here. + UNSET: The enum member of type str. + PROFORMA: The enum member of type str. + PROFORMA_ADHOC: The enum member of type str. + PROFORMA_AUTOMATIC: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/proforma_invoice_status.py b/advancedbilling/models/proforma_invoice_status.py index eae682d7..ff5dc06b 100644 --- a/advancedbilling/models/proforma_invoice_status.py +++ b/advancedbilling/models/proforma_invoice_status.py @@ -12,12 +12,10 @@ class ProformaInvoiceStatus(object): """Implementation of the 'Proforma Invoice Status' enum. - TODO: type enum description here. - Attributes: - DRAFT: TODO: type description here. - VOIDED: TODO: type description here. - ARCHIVED: TODO: type description here. + DRAFT: The enum member of type str. + VOIDED: The enum member of type str. + ARCHIVED: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/proforma_invoice_tax.py b/advancedbilling/models/proforma_invoice_tax.py index 95c35b4d..658a6b68 100644 --- a/advancedbilling/models/proforma_invoice_tax.py +++ b/advancedbilling/models/proforma_invoice_tax.py @@ -14,18 +14,16 @@ class ProformaInvoiceTax(object): """Implementation of the 'Proforma Invoice Tax' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - title (str): TODO: type description here. - source_type (ProformaInvoiceTaxSourceType): TODO: type description - here. - percentage (str): TODO: type description here. - taxable_amount (str): TODO: type description here. - tax_amount (str): TODO: type description here. - line_item_breakouts (List[InvoiceTaxBreakout]): TODO: type description - here. + uid (str): The model property of type str. + title (str): The model property of type str. + source_type (ProformaInvoiceTaxSourceType): The model property of type + ProformaInvoiceTaxSourceType. + percentage (str): The model property of type str. + taxable_amount (str): The model property of type str. + tax_amount (str): The model property of type str. + line_item_breakouts (List[InvoiceTaxBreakout]): The model property of + type List[InvoiceTaxBreakout]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -125,3 +123,25 @@ def from_dictionary(cls, tax_amount, line_item_breakouts, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'title={self.title!r}, ' + f'source_type={self.source_type!r}, ' + f'percentage={self.percentage!r}, ' + f'taxable_amount={self.taxable_amount!r}, ' + f'tax_amount={self.tax_amount!r}, ' + f'line_item_breakouts={self.line_item_breakouts!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'title={self.title!s}, ' + f'source_type={self.source_type!s}, ' + f'percentage={self.percentage!s}, ' + f'taxable_amount={self.taxable_amount!s}, ' + f'tax_amount={self.tax_amount!s}, ' + f'line_item_breakouts={self.line_item_breakouts!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/proforma_invoice_tax_source_type.py b/advancedbilling/models/proforma_invoice_tax_source_type.py index 0d60e5a6..bddbd3c9 100644 --- a/advancedbilling/models/proforma_invoice_tax_source_type.py +++ b/advancedbilling/models/proforma_invoice_tax_source_type.py @@ -12,11 +12,9 @@ class ProformaInvoiceTaxSourceType(object): """Implementation of the 'Proforma Invoice Tax Source Type' enum. - TODO: type enum description here. - Attributes: - TAX: TODO: type description here. - AVALARA: TODO: type description here. + TAX: The enum member of type str. + AVALARA: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/proration.py b/advancedbilling/models/proration.py index 42dbcdcf..1cdb8091 100644 --- a/advancedbilling/models/proration.py +++ b/advancedbilling/models/proration.py @@ -13,8 +13,6 @@ class Proration(object): """Implementation of the 'Proration' model. - TODO: type model description here. - Attributes: preserve_period (bool): The alternative to sending preserve_period as a direct attribute to migration @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(preserve_period, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'preserve_period={self.preserve_period!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'preserve_period={self.preserve_period!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/public_key.py b/advancedbilling/models/public_key.py index ff236494..d9176373 100644 --- a/advancedbilling/models/public_key.py +++ b/advancedbilling/models/public_key.py @@ -13,12 +13,10 @@ class PublicKey(object): """Implementation of the 'Public Key' model. - TODO: type model description here. - Attributes: - public_key (str): TODO: type description here. - requires_security_token (bool): TODO: type description here. - created_at (datetime): TODO: type description here. + public_key (str): The model property of type str. + requires_security_token (bool): The model property of type bool. + created_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -86,3 +84,17 @@ def from_dictionary(cls, requires_security_token, created_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'public_key={self.public_key!r}, ' + f'requires_security_token={self.requires_security_token!r}, ' + f'created_at={self.created_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'public_key={self.public_key!s}, ' + f'requires_security_token={self.requires_security_token!s}, ' + f'created_at={self.created_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/public_signup_page.py b/advancedbilling/models/public_signup_page.py index f2a4e0fb..95616280 100644 --- a/advancedbilling/models/public_signup_page.py +++ b/advancedbilling/models/public_signup_page.py @@ -13,8 +13,6 @@ class PublicSignupPage(object): """Implementation of the 'Public Signup Page' model. - TODO: type model description here. - Attributes: id (int): The id of the signup page (public_signup_pages only) return_url (str): The url to which a customer will be returned after a @@ -102,3 +100,19 @@ def from_dictionary(cls, return_params, url, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'return_url={self.return_url!r}, ' + f'return_params={self.return_params!r}, ' + f'url={self.url!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'return_url={self.return_url!s}, ' + f'return_params={self.return_params!s}, ' + f'url={self.url!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/quantity_based_component.py b/advancedbilling/models/quantity_based_component.py index 3308134e..47ae9c51 100644 --- a/advancedbilling/models/quantity_based_component.py +++ b/advancedbilling/models/quantity_based_component.py @@ -15,8 +15,6 @@ class QuantityBasedComponent(object): """Implementation of the 'Quantity Based Component' model. - TODO: type model description here. - Attributes: name (str): A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes". @@ -49,8 +47,8 @@ class QuantityBasedComponent(object): upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, `prorated`, `none`. - price_points (List[ComponentPricePointItem]): TODO: type description - here. + price_points (List[ComponentPricePointItem]): The model property of + type List[ComponentPricePointItem]. unit_price (str | float | None): The amount the customer will be charged per unit when the pricing scheme is “per_unit”. For On/Off Components, this is the amount that the customer will be charged @@ -64,10 +62,11 @@ class QuantityBasedComponent(object): hide_date_range_on_invoice (bool): (Only available on Relationship Invoicing sites) Boolean flag describing if the service date range should show for the component on generated invoices. - recurring (bool): TODO: type description here. - display_on_hosted_page (bool): TODO: type description here. - allow_fractional_quantities (bool): TODO: type description here. - public_signup_page_ids (List[int]): TODO: type description here. + recurring (bool): The model property of type bool. + display_on_hosted_page (bool): The model property of type bool. + allow_fractional_quantities (bool): The model property of type bool. + public_signup_page_ids (List[int]): The model property of type + List[int]. interval (int): The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is @@ -264,3 +263,49 @@ def from_dictionary(cls, interval, interval_unit, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'unit_name={self.unit_name!r}, ' + f'description={self.description!r}, ' + f'handle={self.handle!r}, ' + f'taxable={self.taxable!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'price_points={self.price_points!r}, ' + f'unit_price={self.unit_price!r}, ' + f'tax_code={self.tax_code!r}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!r}, ' + f'recurring={self.recurring!r}, ' + f'display_on_hosted_page={self.display_on_hosted_page!r}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!r}, ' + f'public_signup_page_ids={self.public_signup_page_ids!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'unit_name={self.unit_name!s}, ' + f'description={self.description!s}, ' + f'handle={self.handle!s}, ' + f'taxable={self.taxable!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'price_points={self.price_points!s}, ' + f'unit_price={self.unit_price!s}, ' + f'tax_code={self.tax_code!s}, ' + f'hide_date_range_on_invoice={self.hide_date_range_on_invoice!s}, ' + f'recurring={self.recurring!s}, ' + f'display_on_hosted_page={self.display_on_hosted_page!s}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!s}, ' + f'public_signup_page_ids={self.public_signup_page_ids!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/reactivate_subscription_group_request.py b/advancedbilling/models/reactivate_subscription_group_request.py index de0f0b4c..a4a6c2ac 100644 --- a/advancedbilling/models/reactivate_subscription_group_request.py +++ b/advancedbilling/models/reactivate_subscription_group_request.py @@ -13,11 +13,9 @@ class ReactivateSubscriptionGroupRequest(object): """Implementation of the 'Reactivate Subscription Group Request' model. - TODO: type model description here. - Attributes: - resume (bool): TODO: type description here. - resume_members (bool): TODO: type description here. + resume (bool): The model property of type bool. + resume_members (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -78,3 +76,15 @@ def from_dictionary(cls, return cls(resume, resume_members, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'resume={self.resume!r}, ' + f'resume_members={self.resume_members!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'resume={self.resume!s}, ' + f'resume_members={self.resume_members!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/reactivate_subscription_group_response.py b/advancedbilling/models/reactivate_subscription_group_response.py index ae52c524..b50f82f7 100644 --- a/advancedbilling/models/reactivate_subscription_group_response.py +++ b/advancedbilling/models/reactivate_subscription_group_response.py @@ -13,18 +13,16 @@ class ReactivateSubscriptionGroupResponse(object): """Implementation of the 'Reactivate Subscription Group Response' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - scheme (int): TODO: type description here. - customer_id (int): TODO: type description here. - payment_profile_id (int): TODO: type description here. - subscription_ids (List[int]): TODO: type description here. - primary_subscription_id (int): TODO: type description here. - next_assessment_at (datetime): TODO: type description here. - state (str): TODO: type description here. - cancel_at_end_of_period (bool): TODO: type description here. + uid (str): The model property of type str. + scheme (int): The model property of type int. + customer_id (int): The model property of type int. + payment_profile_id (int): The model property of type int. + subscription_ids (List[int]): The model property of type List[int]. + primary_subscription_id (int): The model property of type int. + next_assessment_at (datetime): The model property of type datetime. + state (str): The model property of type str. + cancel_at_end_of_period (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -134,3 +132,29 @@ def from_dictionary(cls, state, cancel_at_end_of_period, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'scheme={self.scheme!r}, ' + f'customer_id={self.customer_id!r}, ' + f'payment_profile_id={self.payment_profile_id!r}, ' + f'subscription_ids={self.subscription_ids!r}, ' + f'primary_subscription_id={self.primary_subscription_id!r}, ' + f'next_assessment_at={self.next_assessment_at!r}, ' + f'state={self.state!r}, ' + f'cancel_at_end_of_period={self.cancel_at_end_of_period!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'scheme={self.scheme!s}, ' + f'customer_id={self.customer_id!s}, ' + f'payment_profile_id={self.payment_profile_id!s}, ' + f'subscription_ids={self.subscription_ids!s}, ' + f'primary_subscription_id={self.primary_subscription_id!s}, ' + f'next_assessment_at={self.next_assessment_at!s}, ' + f'state={self.state!s}, ' + f'cancel_at_end_of_period={self.cancel_at_end_of_period!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/reactivate_subscription_request.py b/advancedbilling/models/reactivate_subscription_request.py index 3485ab78..ab3efa8f 100644 --- a/advancedbilling/models/reactivate_subscription_request.py +++ b/advancedbilling/models/reactivate_subscription_request.py @@ -14,8 +14,6 @@ class ReactivateSubscriptionRequest(object): """Implementation of the 'Reactivate Subscription Request' model. - TODO: type model description here. - Attributes: calendar_billing (ReactivationBilling): These values are only applicable to subscriptions using calendar billing @@ -122,3 +120,23 @@ def from_dictionary(cls, use_credits_and_prepayments, resume, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'calendar_billing={self.calendar_billing!r}, ' + f'include_trial={self.include_trial!r}, ' + f'preserve_balance={self.preserve_balance!r}, ' + f'coupon_code={self.coupon_code!r}, ' + f'use_credits_and_prepayments={self.use_credits_and_prepayments!r}, ' + f'resume={self.resume!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'calendar_billing={self.calendar_billing!s}, ' + f'include_trial={self.include_trial!s}, ' + f'preserve_balance={self.preserve_balance!s}, ' + f'coupon_code={self.coupon_code!s}, ' + f'use_credits_and_prepayments={self.use_credits_and_prepayments!s}, ' + f'resume={self.resume!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/reactivation_billing.py b/advancedbilling/models/reactivation_billing.py index 22bea3dc..b67a8e08 100644 --- a/advancedbilling/models/reactivation_billing.py +++ b/advancedbilling/models/reactivation_billing.py @@ -97,3 +97,13 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'reactivation_charge={self.reactivation_charge!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'reactivation_charge={self.reactivation_charge!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/reactivation_charge.py b/advancedbilling/models/reactivation_charge.py index 1601f485..dff86e7c 100644 --- a/advancedbilling/models/reactivation_charge.py +++ b/advancedbilling/models/reactivation_charge.py @@ -20,9 +20,9 @@ class ReactivationCharge(object): renewal Attributes: - PRORATED: TODO: type description here. - IMMEDIATE: TODO: type description here. - DELAYED: TODO: type description here. + PRORATED: The enum member of type str. + IMMEDIATE: The enum member of type str. + DELAYED: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/reason_code.py b/advancedbilling/models/reason_code.py index dbf8b9c4..e828b6ae 100644 --- a/advancedbilling/models/reason_code.py +++ b/advancedbilling/models/reason_code.py @@ -13,16 +13,14 @@ class ReasonCode(object): """Implementation of the 'Reason Code' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - site_id (int): TODO: type description here. - code (str): TODO: type description here. - description (str): TODO: type description here. - position (int): TODO: type description here. - created_at (datetime): TODO: type description here. - updated_at (datetime): TODO: type description here. + id (int): The model property of type int. + site_id (int): The model property of type int. + code (str): The model property of type str. + description (str): The model property of type str. + position (int): The model property of type int. + created_at (datetime): The model property of type datetime. + updated_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -118,3 +116,25 @@ def from_dictionary(cls, created_at, updated_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'site_id={self.site_id!r}, ' + f'code={self.code!r}, ' + f'description={self.description!r}, ' + f'position={self.position!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'site_id={self.site_id!s}, ' + f'code={self.code!s}, ' + f'description={self.description!s}, ' + f'position={self.position!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/reason_code_response.py b/advancedbilling/models/reason_code_response.py index 5a5655e9..b47bc49c 100644 --- a/advancedbilling/models/reason_code_response.py +++ b/advancedbilling/models/reason_code_response.py @@ -13,10 +13,8 @@ class ReasonCodeResponse(object): """Implementation of the 'Reason Code Response' model. - TODO: type model description here. - Attributes: - reason_code (ReasonCode): TODO: type description here. + reason_code (ReasonCode): The model property of type ReasonCode. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(reason_code, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'reason_code={self.reason_code!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'reason_code={self.reason_code!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/record_payment_request.py b/advancedbilling/models/record_payment_request.py index 0359c969..ac0f6a4e 100644 --- a/advancedbilling/models/record_payment_request.py +++ b/advancedbilling/models/record_payment_request.py @@ -13,10 +13,8 @@ class RecordPaymentRequest(object): """Implementation of the 'Record Payment Request' model. - TODO: type model description here. - Attributes: - payment (CreatePayment): TODO: type description here. + payment (CreatePayment): The model property of type CreatePayment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(payment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payment={self.payment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payment={self.payment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/record_payment_response.py b/advancedbilling/models/record_payment_response.py index 1985c160..507c6b73 100644 --- a/advancedbilling/models/record_payment_response.py +++ b/advancedbilling/models/record_payment_response.py @@ -15,11 +15,11 @@ class RecordPaymentResponse(object): """Implementation of the 'Record Payment Response' model. - TODO: type model description here. - Attributes: - paid_invoices (List[PaidInvoice]): TODO: type description here. - prepayment (InvoicePrePayment): TODO: type description here. + paid_invoices (List[PaidInvoice]): The model property of type + List[PaidInvoice]. + prepayment (InvoicePrePayment): The model property of type + InvoicePrePayment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -91,3 +91,15 @@ def from_dictionary(cls, return cls(paid_invoices, prepayment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'paid_invoices={self.paid_invoices!r}, ' + f'prepayment={self.prepayment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'paid_invoices={self.paid_invoices!s}, ' + f'prepayment={self.prepayment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/recurring_scheme.py b/advancedbilling/models/recurring_scheme.py index 086d1e7d..2689fc31 100644 --- a/advancedbilling/models/recurring_scheme.py +++ b/advancedbilling/models/recurring_scheme.py @@ -12,12 +12,10 @@ class RecurringScheme(object): """Implementation of the 'Recurring Scheme' enum. - TODO: type enum description here. - Attributes: - DO_NOT_RECUR: TODO: type description here. - RECUR_INDEFINITELY: TODO: type description here. - RECUR_WITH_DURATION: TODO: type description here. + DO_NOT_RECUR: The enum member of type str. + RECUR_INDEFINITELY: The enum member of type str. + RECUR_WITH_DURATION: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/referral_code.py b/advancedbilling/models/referral_code.py index 51447493..e4dcd7ad 100644 --- a/advancedbilling/models/referral_code.py +++ b/advancedbilling/models/referral_code.py @@ -13,13 +13,11 @@ class ReferralCode(object): """Implementation of the 'Referral Code' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - site_id (int): TODO: type description here. - subscription_id (int): TODO: type description here. - code (str): TODO: type description here. + id (int): The model property of type int. + site_id (int): The model property of type int. + subscription_id (int): The model property of type int. + code (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -94,3 +92,19 @@ def from_dictionary(cls, subscription_id, code, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'site_id={self.site_id!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'code={self.code!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'site_id={self.site_id!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'code={self.code!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/referral_validation_response.py b/advancedbilling/models/referral_validation_response.py index 6665adcf..a02ede93 100644 --- a/advancedbilling/models/referral_validation_response.py +++ b/advancedbilling/models/referral_validation_response.py @@ -14,10 +14,8 @@ class ReferralValidationResponse(object): """Implementation of the 'Referral Validation Response' model. - TODO: type model description here. - Attributes: - referral_code (ReferralCode): TODO: type description here. + referral_code (ReferralCode): The model property of type ReferralCode. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(referral_code, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'referral_code={self.referral_code!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'referral_code={self.referral_code!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/refund_consolidated_invoice.py b/advancedbilling/models/refund_consolidated_invoice.py index 6cbe2efd..2829c0e1 100644 --- a/advancedbilling/models/refund_consolidated_invoice.py +++ b/advancedbilling/models/refund_consolidated_invoice.py @@ -141,3 +141,23 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('payment_id'), type_callable=lambda value: isinstance(value, int)) \ and UnionTypeLookUp.get('RefundConsolidatedInvoiceSegmentUids').validate(dictionary.get('segment_uids')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'memo={self.memo!r}, ' + f'payment_id={self.payment_id!r}, ' + f'segment_uids={self.segment_uids!r}, ' + f'external={self.external!r}, ' + f'apply_credit={self.apply_credit!r}, ' + f'amount={self.amount!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'memo={self.memo!s}, ' + f'payment_id={self.payment_id!s}, ' + f'segment_uids={self.segment_uids!s}, ' + f'external={self.external!s}, ' + f'apply_credit={self.apply_credit!s}, ' + f'amount={self.amount!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/refund_invoice.py b/advancedbilling/models/refund_invoice.py index abcbd626..15944159 100644 --- a/advancedbilling/models/refund_invoice.py +++ b/advancedbilling/models/refund_invoice.py @@ -142,3 +142,23 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('payment_id'), type_callable=lambda value: isinstance(value, int)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!r}, ' + f'memo={self.memo!r}, ' + f'payment_id={self.payment_id!r}, ' + f'external={self.external!r}, ' + f'apply_credit={self.apply_credit!r}, ' + f'void_invoice={self.void_invoice!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!s}, ' + f'memo={self.memo!s}, ' + f'payment_id={self.payment_id!s}, ' + f'external={self.external!s}, ' + f'apply_credit={self.apply_credit!s}, ' + f'void_invoice={self.void_invoice!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/refund_invoice_event.py b/advancedbilling/models/refund_invoice_event.py index a81663bb..26179d2c 100644 --- a/advancedbilling/models/refund_invoice_event.py +++ b/advancedbilling/models/refund_invoice_event.py @@ -16,13 +16,12 @@ class RefundInvoiceEvent(object): """Implementation of the 'Refund Invoice Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (RefundInvoiceEventData): Example schema for an `refund_invoice` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: RefundInvoiceEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/refund_invoice_event_data.py b/advancedbilling/models/refund_invoice_event_data.py index 449d17a4..adab5580 100644 --- a/advancedbilling/models/refund_invoice_event_data.py +++ b/advancedbilling/models/refund_invoice_event_data.py @@ -30,7 +30,8 @@ class RefundInvoiceEventData(object): segments. See also the [invoice consolidation documentation](https://maxio.zendesk.com/hc/en-us/articles/24252269 909389-Invoice-Consolidation). - credit_note_attributes (CreditNote): TODO: type description here. + credit_note_attributes (CreditNote): The model property of type + CreditNote. memo (str): The refund memo. original_amount (str): The full, original amount of the refund. payment_id (int): The ID of the payment transaction to be refunded. @@ -181,3 +182,29 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, int)) \ and APIHelper.is_valid_type(value=dictionary.get('transaction_time'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'apply_credit={self.apply_credit!r}, ' + f'consolidation_level={self.consolidation_level!r}, ' + f'credit_note_attributes={self.credit_note_attributes!r}, ' + f'memo={self.memo!r}, ' + f'original_amount={self.original_amount!r}, ' + f'payment_id={self.payment_id!r}, ' + f'refund_amount={self.refund_amount!r}, ' + f'refund_id={self.refund_id!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'apply_credit={self.apply_credit!s}, ' + f'consolidation_level={self.consolidation_level!s}, ' + f'credit_note_attributes={self.credit_note_attributes!s}, ' + f'memo={self.memo!s}, ' + f'original_amount={self.original_amount!s}, ' + f'payment_id={self.payment_id!s}, ' + f'refund_amount={self.refund_amount!s}, ' + f'refund_id={self.refund_id!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/refund_invoice_request.py b/advancedbilling/models/refund_invoice_request.py index e6836680..f0b0ef11 100644 --- a/advancedbilling/models/refund_invoice_request.py +++ b/advancedbilling/models/refund_invoice_request.py @@ -13,11 +13,9 @@ class RefundInvoiceRequest(object): """Implementation of the 'Refund Invoice Request' model. - TODO: type model description here. - Attributes: - refund (RefundInvoice | RefundConsolidatedInvoice): TODO: type - description here. + refund (RefundInvoice | RefundConsolidatedInvoice): The model property + of type RefundInvoice | RefundConsolidatedInvoice. additional_properties (Dict[str, object]): The additional properties for the model. @@ -90,3 +88,13 @@ def validate(cls, dictionary): return False return UnionTypeLookUp.get('RefundInvoiceRequestRefund').validate(dictionary.get('refund')).is_valid + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'refund={self.refund!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'refund={self.refund!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/refund_prepayment.py b/advancedbilling/models/refund_prepayment.py index 6ba0acce..5730403e 100644 --- a/advancedbilling/models/refund_prepayment.py +++ b/advancedbilling/models/refund_prepayment.py @@ -13,14 +13,12 @@ class RefundPrepayment(object): """Implementation of the 'Refund Prepayment' model. - TODO: type model description here. - Attributes: - amount_in_cents (long|int): `amount` is not required if you pass + amount_in_cents (int): `amount` is not required if you pass `amount_in_cents`. amount (str | float): `amount_in_cents` is not required if you pass `amount`. - memo (str): TODO: type description here. + memo (str): The model property of type str. external (bool): Specify the type of refund you wish to initiate. When the prepayment is external, the `external` flag is optional. But if the prepayment was made through a payment profile, the @@ -131,3 +129,19 @@ def validate(cls, dictionary): and UnionTypeLookUp.get('RefundPrepaymentAmount').validate(dictionary.get('amount')).is_valid \ and APIHelper.is_valid_type(value=dictionary.get('memo'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'amount={self.amount!r}, ' + f'memo={self.memo!r}, ' + f'external={self.external!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'amount={self.amount!s}, ' + f'memo={self.memo!s}, ' + f'external={self.external!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/refund_prepayment_base_refund_error.py b/advancedbilling/models/refund_prepayment_base_refund_error.py index 70d89720..7a783424 100644 --- a/advancedbilling/models/refund_prepayment_base_refund_error.py +++ b/advancedbilling/models/refund_prepayment_base_refund_error.py @@ -14,10 +14,8 @@ class RefundPrepaymentBaseRefundError(object): """Implementation of the 'Refund Prepayment Base Refund Error' model. - TODO: type model description here. - Attributes: - refund (BaseRefundError): TODO: type description here. + refund (BaseRefundError): The model property of type BaseRefundError. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(refund, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'refund={self.refund!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'refund={self.refund!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/refund_prepayment_request.py b/advancedbilling/models/refund_prepayment_request.py index 87beb616..a4237a46 100644 --- a/advancedbilling/models/refund_prepayment_request.py +++ b/advancedbilling/models/refund_prepayment_request.py @@ -13,10 +13,8 @@ class RefundPrepaymentRequest(object): """Implementation of the 'Refund Prepayment Request' model. - TODO: type model description here. - Attributes: - refund (RefundPrepayment): TODO: type description here. + refund (RefundPrepayment): The model property of type RefundPrepayment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(refund, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'refund={self.refund!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'refund={self.refund!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/refund_success.py b/advancedbilling/models/refund_success.py index b1cc6e6c..acc59939 100644 --- a/advancedbilling/models/refund_success.py +++ b/advancedbilling/models/refund_success.py @@ -13,12 +13,10 @@ class RefundSuccess(object): """Implementation of the 'Refund Success' model. - TODO: type model description here. - Attributes: - refund_id (int): TODO: type description here. - gateway_transaction_id (int): TODO: type description here. - product_id (int): TODO: type description here. + refund_id (int): The model property of type int. + gateway_transaction_id (int): The model property of type int. + product_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -109,3 +107,17 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, int)) \ and APIHelper.is_valid_type(value=dictionary.get('product_id'), type_callable=lambda value: isinstance(value, int)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'refund_id={self.refund_id!r}, ' + f'gateway_transaction_id={self.gateway_transaction_id!r}, ' + f'product_id={self.product_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'refund_id={self.refund_id!s}, ' + f'gateway_transaction_id={self.gateway_transaction_id!s}, ' + f'product_id={self.product_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/remove_payment_event.py b/advancedbilling/models/remove_payment_event.py index 94097eec..95520ae1 100644 --- a/advancedbilling/models/remove_payment_event.py +++ b/advancedbilling/models/remove_payment_event.py @@ -16,13 +16,12 @@ class RemovePaymentEvent(object): """Implementation of the 'Remove Payment Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (RemovePaymentEventData): Example schema for an `remove_payment` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: RemovePaymentEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/remove_payment_event_data.py b/advancedbilling/models/remove_payment_event_data.py index 15af31fa..97798768 100644 --- a/advancedbilling/models/remove_payment_event_data.py +++ b/advancedbilling/models/remove_payment_event_data.py @@ -156,3 +156,25 @@ def validate(cls, dictionary): and UnionTypeLookUp.get('Invoice-Event-Payment').validate(dictionary.get('payment_method')).is_valid \ and APIHelper.is_valid_type(value=dictionary.get('prepayment'), type_callable=lambda value: isinstance(value, bool)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'transaction_id={self.transaction_id!r}, ' + f'memo={self.memo!r}, ' + f'original_amount={self.original_amount!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'payment_method={self.payment_method!r}, ' + f'prepayment={self.prepayment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'transaction_id={self.transaction_id!s}, ' + f'memo={self.memo!s}, ' + f'original_amount={self.original_amount!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'payment_method={self.payment_method!s}, ' + f'prepayment={self.prepayment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/renewal_preview.py b/advancedbilling/models/renewal_preview.py index 4aab299a..81dac6e8 100644 --- a/advancedbilling/models/renewal_preview.py +++ b/advancedbilling/models/renewal_preview.py @@ -14,23 +14,21 @@ class RenewalPreview(object): """Implementation of the 'Renewal Preview' model. - TODO: type model description here. - Attributes: next_assessment_at (datetime): The timestamp for the subscription’s next renewal - subtotal_in_cents (long|int): An integer representing the amount of - the total pre-tax, pre-discount charges that will be assessed at - the next renewal - total_tax_in_cents (long|int): An integer representing the total tax + subtotal_in_cents (int): An integer representing the amount of the + total pre-tax, pre-discount charges that will be assessed at the + next renewal + total_tax_in_cents (int): An integer representing the total tax charges that will be assessed at the next renewal - total_discount_in_cents (long|int): An integer representing the amount - of the coupon discounts that will be applied to the next renewal - total_in_cents (long|int): An integer representing the total amount - owed, less any discounts, that will be assessed at the next renewal - existing_balance_in_cents (long|int): An integer representing the - amount of the subscription’s current balance - total_amount_due_in_cents (long|int): An integer representing the + total_discount_in_cents (int): An integer representing the amount of + the coupon discounts that will be applied to the next renewal + total_in_cents (int): An integer representing the total amount owed, + less any discounts, that will be assessed at the next renewal + existing_balance_in_cents (int): An integer representing the amount of + the subscription’s current balance + total_amount_due_in_cents (int): An integer representing the existing_balance_in_cents plus the total_in_cents uncalculated_taxes (bool): A boolean indicating whether or not additional taxes will be calculated at the time of renewal. This @@ -152,3 +150,29 @@ def from_dictionary(cls, uncalculated_taxes, line_items, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'next_assessment_at={self.next_assessment_at!r}, ' + f'subtotal_in_cents={self.subtotal_in_cents!r}, ' + f'total_tax_in_cents={self.total_tax_in_cents!r}, ' + f'total_discount_in_cents={self.total_discount_in_cents!r}, ' + f'total_in_cents={self.total_in_cents!r}, ' + f'existing_balance_in_cents={self.existing_balance_in_cents!r}, ' + f'total_amount_due_in_cents={self.total_amount_due_in_cents!r}, ' + f'uncalculated_taxes={self.uncalculated_taxes!r}, ' + f'line_items={self.line_items!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'next_assessment_at={self.next_assessment_at!s}, ' + f'subtotal_in_cents={self.subtotal_in_cents!s}, ' + f'total_tax_in_cents={self.total_tax_in_cents!s}, ' + f'total_discount_in_cents={self.total_discount_in_cents!s}, ' + f'total_in_cents={self.total_in_cents!s}, ' + f'existing_balance_in_cents={self.existing_balance_in_cents!s}, ' + f'total_amount_due_in_cents={self.total_amount_due_in_cents!s}, ' + f'uncalculated_taxes={self.uncalculated_taxes!s}, ' + f'line_items={self.line_items!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/renewal_preview_component.py b/advancedbilling/models/renewal_preview_component.py index 89930667..68de8579 100644 --- a/advancedbilling/models/renewal_preview_component.py +++ b/advancedbilling/models/renewal_preview_component.py @@ -13,8 +13,6 @@ class RenewalPreviewComponent(object): """Implementation of the 'Renewal Preview Component' model. - TODO: type model description here. - Attributes: component_id (str | int | None): Either the component's Chargify id or its handle prefixed with `handle:` @@ -96,3 +94,17 @@ def from_dictionary(cls, quantity, price_point_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!r}, ' + f'quantity={self.quantity!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!s}, ' + f'quantity={self.quantity!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/renewal_preview_line_item.py b/advancedbilling/models/renewal_preview_line_item.py index b76323d1..f4498a0c 100644 --- a/advancedbilling/models/renewal_preview_line_item.py +++ b/advancedbilling/models/renewal_preview_line_item.py @@ -13,24 +13,22 @@ class RenewalPreviewLineItem(object): """Implementation of the 'Renewal Preview Line Item' model. - TODO: type model description here. - Attributes: transaction_type (LineItemTransactionType): A handle for the line item transaction type kind (LineItemKind): A handle for the line item kind - amount_in_cents (long|int): TODO: type description here. - memo (str): TODO: type description here. - discount_amount_in_cents (long|int): TODO: type description here. - taxable_amount_in_cents (long|int): TODO: type description here. - product_id (int): TODO: type description here. - product_name (str): TODO: type description here. - component_id (int): TODO: type description here. - component_handle (str): TODO: type description here. - component_name (str): TODO: type description here. - product_handle (str): TODO: type description here. - period_range_start (str): TODO: type description here. - period_range_end (str): TODO: type description here. + amount_in_cents (int): The model property of type int. + memo (str): The model property of type str. + discount_amount_in_cents (int): The model property of type int. + taxable_amount_in_cents (int): The model property of type int. + product_id (int): The model property of type int. + product_name (str): The model property of type str. + component_id (int): The model property of type int. + component_handle (str): The model property of type str. + component_name (str): The model property of type str. + product_handle (str): The model property of type str. + period_range_start (str): The model property of type str. + period_range_end (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -175,3 +173,39 @@ def from_dictionary(cls, period_range_start, period_range_end, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'transaction_type={self.transaction_type!r}, ' + f'kind={self.kind!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'memo={self.memo!r}, ' + f'discount_amount_in_cents={self.discount_amount_in_cents!r}, ' + f'taxable_amount_in_cents={self.taxable_amount_in_cents!r}, ' + f'product_id={self.product_id!r}, ' + f'product_name={self.product_name!r}, ' + f'component_id={self.component_id!r}, ' + f'component_handle={self.component_handle!r}, ' + f'component_name={self.component_name!r}, ' + f'product_handle={self.product_handle!r}, ' + f'period_range_start={self.period_range_start!r}, ' + f'period_range_end={self.period_range_end!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'transaction_type={self.transaction_type!s}, ' + f'kind={self.kind!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'memo={self.memo!s}, ' + f'discount_amount_in_cents={self.discount_amount_in_cents!s}, ' + f'taxable_amount_in_cents={self.taxable_amount_in_cents!s}, ' + f'product_id={self.product_id!s}, ' + f'product_name={self.product_name!s}, ' + f'component_id={self.component_id!s}, ' + f'component_handle={self.component_handle!s}, ' + f'component_name={self.component_name!s}, ' + f'product_handle={self.product_handle!s}, ' + f'period_range_start={self.period_range_start!s}, ' + f'period_range_end={self.period_range_end!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/renewal_preview_request.py b/advancedbilling/models/renewal_preview_request.py index 714b5f19..89f76c06 100644 --- a/advancedbilling/models/renewal_preview_request.py +++ b/advancedbilling/models/renewal_preview_request.py @@ -14,8 +14,6 @@ class RenewalPreviewRequest(object): """Implementation of the 'Renewal Preview Request' model. - TODO: type model description here. - Attributes: components (List[RenewalPreviewComponent]): An optional array of component definitions to preview. Providing any component @@ -80,3 +78,13 @@ def from_dictionary(cls, # Return an object of this model return cls(components, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'components={self.components!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'components={self.components!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/renewal_preview_response.py b/advancedbilling/models/renewal_preview_response.py index 5c6592da..a5dde2f5 100644 --- a/advancedbilling/models/renewal_preview_response.py +++ b/advancedbilling/models/renewal_preview_response.py @@ -13,10 +13,9 @@ class RenewalPreviewResponse(object): """Implementation of the 'Renewal Preview Response' model. - TODO: type model description here. - Attributes: - renewal_preview (RenewalPreview): TODO: type description here. + renewal_preview (RenewalPreview): The model property of type + RenewalPreview. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(renewal_preview, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'renewal_preview={self.renewal_preview!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'renewal_preview={self.renewal_preview!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/replay_webhooks_request.py b/advancedbilling/models/replay_webhooks_request.py index 5b8e4205..07b351c8 100644 --- a/advancedbilling/models/replay_webhooks_request.py +++ b/advancedbilling/models/replay_webhooks_request.py @@ -12,10 +12,8 @@ class ReplayWebhooksRequest(object): """Implementation of the 'Replay Webhooks Request' model. - TODO: type model description here. - Attributes: - ids (List[long|int]): TODO: type description here. + ids (List[int]): The model property of type List[int]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -64,3 +62,13 @@ def from_dictionary(cls, # Return an object of this model return cls(ids, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'ids={self.ids!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'ids={self.ids!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/replay_webhooks_response.py b/advancedbilling/models/replay_webhooks_response.py index d68b3339..3c44c63a 100644 --- a/advancedbilling/models/replay_webhooks_response.py +++ b/advancedbilling/models/replay_webhooks_response.py @@ -13,10 +13,8 @@ class ReplayWebhooksResponse(object): """Implementation of the 'Replay Webhooks Response' model. - TODO: type model description here. - Attributes: - status (str): TODO: type description here. + status (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(status, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'status={self.status!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'status={self.status!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/resent_invitation.py b/advancedbilling/models/resent_invitation.py index afbce137..0f795ab1 100644 --- a/advancedbilling/models/resent_invitation.py +++ b/advancedbilling/models/resent_invitation.py @@ -13,15 +13,14 @@ class ResentInvitation(object): """Implementation of the 'Resent Invitation' model. - TODO: type model description here. - Attributes: - last_sent_at (str): TODO: type description here. - last_accepted_at (str): TODO: type description here. - send_invite_link_text (str): TODO: type description here. - uninvited_count (int): TODO: type description here. - last_invite_sent_at (datetime): TODO: type description here. - last_invite_accepted_at (datetime): TODO: type description here. + last_sent_at (str): The model property of type str. + last_accepted_at (str): The model property of type str. + send_invite_link_text (str): The model property of type str. + uninvited_count (int): The model property of type int. + last_invite_sent_at (datetime): The model property of type datetime. + last_invite_accepted_at (datetime): The model property of type + datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -110,3 +109,23 @@ def from_dictionary(cls, last_invite_sent_at, last_invite_accepted_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'last_sent_at={self.last_sent_at!r}, ' + f'last_accepted_at={self.last_accepted_at!r}, ' + f'send_invite_link_text={self.send_invite_link_text!r}, ' + f'uninvited_count={self.uninvited_count!r}, ' + f'last_invite_sent_at={self.last_invite_sent_at!r}, ' + f'last_invite_accepted_at={self.last_invite_accepted_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'last_sent_at={self.last_sent_at!s}, ' + f'last_accepted_at={self.last_accepted_at!s}, ' + f'send_invite_link_text={self.send_invite_link_text!s}, ' + f'uninvited_count={self.uninvited_count!s}, ' + f'last_invite_sent_at={self.last_invite_sent_at!s}, ' + f'last_invite_accepted_at={self.last_invite_accepted_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/resource_type.py b/advancedbilling/models/resource_type.py index a2072236..69942d60 100644 --- a/advancedbilling/models/resource_type.py +++ b/advancedbilling/models/resource_type.py @@ -12,11 +12,9 @@ class ResourceType(object): """Implementation of the 'Resource Type' enum. - TODO: type enum description here. - Attributes: - SUBSCRIPTIONS: TODO: type description here. - CUSTOMERS: TODO: type description here. + SUBSCRIPTIONS: The enum member of type str. + CUSTOMERS: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/restriction_type.py b/advancedbilling/models/restriction_type.py index 68e4507d..ce52db59 100644 --- a/advancedbilling/models/restriction_type.py +++ b/advancedbilling/models/restriction_type.py @@ -12,11 +12,9 @@ class RestrictionType(object): """Implementation of the 'Restriction Type' enum. - TODO: type enum description here. - Attributes: - COMPONENT: TODO: type description here. - PRODUCT: TODO: type description here. + COMPONENT: The enum member of type str. + PRODUCT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/resume_options.py b/advancedbilling/models/resume_options.py index 2427b60c..0059f460 100644 --- a/advancedbilling/models/resume_options.py +++ b/advancedbilling/models/resume_options.py @@ -13,8 +13,6 @@ class ResumeOptions(object): """Implementation of the 'Resume Options' model. - TODO: type model description here. - Attributes: require_resume (bool): Chargify will only attempt to resume the subscription's billing period. If not resumable, the subscription @@ -105,3 +103,15 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'require_resume={self.require_resume!r}, ' + f'forgive_balance={self.forgive_balance!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'require_resume={self.require_resume!s}, ' + f'forgive_balance={self.forgive_balance!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/resumption_charge.py b/advancedbilling/models/resumption_charge.py index 5f1be702..68ea0277 100644 --- a/advancedbilling/models/resumption_charge.py +++ b/advancedbilling/models/resumption_charge.py @@ -16,9 +16,9 @@ class ResumptionCharge(object): subscription's charge should be handled Attributes: - PRORATED: TODO: type description here. - IMMEDIATE: TODO: type description here. - DELAYED: TODO: type description here. + PRORATED: The enum member of type str. + IMMEDIATE: The enum member of type str. + DELAYED: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/revoked_invitation.py b/advancedbilling/models/revoked_invitation.py index 3840faaa..6b32a719 100644 --- a/advancedbilling/models/revoked_invitation.py +++ b/advancedbilling/models/revoked_invitation.py @@ -13,12 +13,10 @@ class RevokedInvitation(object): """Implementation of the 'Revoked Invitation' model. - TODO: type model description here. - Attributes: - last_sent_at (str): TODO: type description here. - last_accepted_at (str): TODO: type description here. - uninvited_count (int): TODO: type description here. + last_sent_at (str): The model property of type str. + last_accepted_at (str): The model property of type str. + uninvited_count (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -86,3 +84,17 @@ def from_dictionary(cls, last_accepted_at, uninvited_count, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'last_sent_at={self.last_sent_at!r}, ' + f'last_accepted_at={self.last_accepted_at!r}, ' + f'uninvited_count={self.uninvited_count!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'last_sent_at={self.last_sent_at!s}, ' + f'last_accepted_at={self.last_accepted_at!s}, ' + f'uninvited_count={self.uninvited_count!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/sale_rep.py b/advancedbilling/models/sale_rep.py index 38029645..489c1216 100644 --- a/advancedbilling/models/sale_rep.py +++ b/advancedbilling/models/sale_rep.py @@ -14,14 +14,13 @@ class SaleRep(object): """Implementation of the 'Sale Rep' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - full_name (str): TODO: type description here. - subscriptions_count (int): TODO: type description here. - test_mode (bool): TODO: type description here. - subscriptions (List[SaleRepSubscription]): TODO: type description here. + id (int): The model property of type int. + full_name (str): The model property of type str. + subscriptions_count (int): The model property of type int. + test_mode (bool): The model property of type bool. + subscriptions (List[SaleRepSubscription]): The model property of type + List[SaleRepSubscription]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -107,3 +106,21 @@ def from_dictionary(cls, test_mode, subscriptions, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'full_name={self.full_name!r}, ' + f'subscriptions_count={self.subscriptions_count!r}, ' + f'test_mode={self.test_mode!r}, ' + f'subscriptions={self.subscriptions!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'full_name={self.full_name!s}, ' + f'subscriptions_count={self.subscriptions_count!s}, ' + f'test_mode={self.test_mode!s}, ' + f'subscriptions={self.subscriptions!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/sale_rep_item_mrr.py b/advancedbilling/models/sale_rep_item_mrr.py index 90f45fed..601dd230 100644 --- a/advancedbilling/models/sale_rep_item_mrr.py +++ b/advancedbilling/models/sale_rep_item_mrr.py @@ -13,12 +13,10 @@ class SaleRepItemMrr(object): """Implementation of the 'Sale Rep Item Mrr' model. - TODO: type model description here. - Attributes: - mrr (str): TODO: type description here. - usage (str): TODO: type description here. - recurring (str): TODO: type description here. + mrr (str): The model property of type str. + usage (str): The model property of type str. + recurring (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -86,3 +84,17 @@ def from_dictionary(cls, usage, recurring, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'mrr={self.mrr!r}, ' + f'usage={self.usage!r}, ' + f'recurring={self.recurring!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'mrr={self.mrr!s}, ' + f'usage={self.usage!s}, ' + f'recurring={self.recurring!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/sale_rep_settings.py b/advancedbilling/models/sale_rep_settings.py index c3b56a6f..38b9e765 100644 --- a/advancedbilling/models/sale_rep_settings.py +++ b/advancedbilling/models/sale_rep_settings.py @@ -13,16 +13,14 @@ class SaleRepSettings(object): """Implementation of the 'Sale Rep Settings' model. - TODO: type model description here. - Attributes: - customer_name (str): TODO: type description here. - subscription_id (int): TODO: type description here. - site_link (str): TODO: type description here. - site_name (str): TODO: type description here. - subscription_mrr (str): TODO: type description here. - sales_rep_id (int): TODO: type description here. - sales_rep_name (str): TODO: type description here. + customer_name (str): The model property of type str. + subscription_id (int): The model property of type int. + site_link (str): The model property of type str. + site_name (str): The model property of type str. + subscription_mrr (str): The model property of type str. + sales_rep_id (int): The model property of type int. + sales_rep_name (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -118,3 +116,25 @@ def from_dictionary(cls, sales_rep_id, sales_rep_name, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'customer_name={self.customer_name!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'site_link={self.site_link!r}, ' + f'site_name={self.site_name!r}, ' + f'subscription_mrr={self.subscription_mrr!r}, ' + f'sales_rep_id={self.sales_rep_id!r}, ' + f'sales_rep_name={self.sales_rep_name!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'customer_name={self.customer_name!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'site_link={self.site_link!s}, ' + f'site_name={self.site_name!s}, ' + f'subscription_mrr={self.subscription_mrr!s}, ' + f'sales_rep_id={self.sales_rep_id!s}, ' + f'sales_rep_name={self.sales_rep_name!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/sale_rep_subscription.py b/advancedbilling/models/sale_rep_subscription.py index b04ad787..c0f45bcb 100644 --- a/advancedbilling/models/sale_rep_subscription.py +++ b/advancedbilling/models/sale_rep_subscription.py @@ -13,19 +13,17 @@ class SaleRepSubscription(object): """Implementation of the 'Sale Rep Subscription' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - site_name (str): TODO: type description here. - subscription_url (str): TODO: type description here. - customer_name (str): TODO: type description here. - created_at (str): TODO: type description here. - mrr (str): TODO: type description here. - usage (str): TODO: type description here. - recurring (str): TODO: type description here. - last_payment (str): TODO: type description here. - churn_date (str): TODO: type description here. + id (int): The model property of type int. + site_name (str): The model property of type str. + subscription_url (str): The model property of type str. + customer_name (str): The model property of type str. + created_at (str): The model property of type str. + mrr (str): The model property of type str. + usage (str): The model property of type str. + recurring (str): The model property of type str. + last_payment (str): The model property of type str. + churn_date (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -146,3 +144,31 @@ def from_dictionary(cls, last_payment, churn_date, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'site_name={self.site_name!r}, ' + f'subscription_url={self.subscription_url!r}, ' + f'customer_name={self.customer_name!r}, ' + f'created_at={self.created_at!r}, ' + f'mrr={self.mrr!r}, ' + f'usage={self.usage!r}, ' + f'recurring={self.recurring!r}, ' + f'last_payment={self.last_payment!r}, ' + f'churn_date={self.churn_date!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'site_name={self.site_name!s}, ' + f'subscription_url={self.subscription_url!s}, ' + f'customer_name={self.customer_name!s}, ' + f'created_at={self.created_at!s}, ' + f'mrr={self.mrr!s}, ' + f'usage={self.usage!s}, ' + f'recurring={self.recurring!s}, ' + f'last_payment={self.last_payment!s}, ' + f'churn_date={self.churn_date!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/segment.py b/advancedbilling/models/segment.py index ea304919..d4a52a82 100644 --- a/advancedbilling/models/segment.py +++ b/advancedbilling/models/segment.py @@ -14,28 +14,27 @@ class Segment(object): """Implementation of the 'Segment' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - component_id (int): TODO: type description here. - price_point_id (int): TODO: type description here. - event_based_billing_metric_id (int): TODO: type description here. + id (int): The model property of type int. + component_id (int): The model property of type int. + price_point_id (int): The model property of type int. + event_based_billing_metric_id (int): The model property of type int. pricing_scheme (PricingScheme): The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.h tml) for an overview of pricing schemes. - segment_property_1_value (str | float | int | bool | None): TODO: type - description here. - segment_property_2_value (str | float | int | bool | None): TODO: type - description here. - segment_property_3_value (str | float | int | bool | None): TODO: type - description here. - segment_property_4_value (str | float | int | bool | None): TODO: type - description here. - created_at (datetime): TODO: type description here. - updated_at (datetime): TODO: type description here. - prices (List[SegmentPrice]): TODO: type description here. + segment_property_1_value (str | float | int | bool | None): The model + property of type str | float | int | bool | None. + segment_property_2_value (str | float | int | bool | None): The model + property of type str | float | int | bool | None. + segment_property_3_value (str | float | int | bool | None): The model + property of type str | float | int | bool | None. + segment_property_4_value (str | float | int | bool | None): The model + property of type str | float | int | bool | None. + created_at (datetime): The model property of type datetime. + updated_at (datetime): The model property of type datetime. + prices (List[SegmentPrice]): The model property of type + List[SegmentPrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -171,3 +170,35 @@ def from_dictionary(cls, updated_at, prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'component_id={self.component_id!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'event_based_billing_metric_id={self.event_based_billing_metric_id!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'segment_property_1_value={self.segment_property_1_value!r}, ' + f'segment_property_2_value={self.segment_property_2_value!r}, ' + f'segment_property_3_value={self.segment_property_3_value!r}, ' + f'segment_property_4_value={self.segment_property_4_value!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'prices={self.prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'component_id={self.component_id!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'event_based_billing_metric_id={self.event_based_billing_metric_id!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'segment_property_1_value={self.segment_property_1_value!s}, ' + f'segment_property_2_value={self.segment_property_2_value!s}, ' + f'segment_property_3_value={self.segment_property_3_value!s}, ' + f'segment_property_4_value={self.segment_property_4_value!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'prices={self.prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/segment_price.py b/advancedbilling/models/segment_price.py index 4b38ff7b..1ef0cb36 100644 --- a/advancedbilling/models/segment_price.py +++ b/advancedbilling/models/segment_price.py @@ -13,17 +13,15 @@ class SegmentPrice(object): """Implementation of the 'Segment Price' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - component_id (int): TODO: type description here. - starting_quantity (int): TODO: type description here. - ending_quantity (int): TODO: type description here. - unit_price (str): TODO: type description here. - price_point_id (int): TODO: type description here. - formatted_unit_price (str): TODO: type description here. - segment_id (int): TODO: type description here. + id (int): The model property of type int. + component_id (int): The model property of type int. + starting_quantity (int): The model property of type int. + ending_quantity (int): The model property of type int. + unit_price (str): The model property of type str. + price_point_id (int): The model property of type int. + formatted_unit_price (str): The model property of type str. + segment_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -152,3 +150,27 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'component_id={self.component_id!r}, ' + f'starting_quantity={self.starting_quantity!r}, ' + f'ending_quantity={self.ending_quantity!r}, ' + f'unit_price={self.unit_price!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'formatted_unit_price={self.formatted_unit_price!r}, ' + f'segment_id={self.segment_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'component_id={self.component_id!s}, ' + f'starting_quantity={self.starting_quantity!s}, ' + f'ending_quantity={self.ending_quantity!s}, ' + f'unit_price={self.unit_price!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'formatted_unit_price={self.formatted_unit_price!s}, ' + f'segment_id={self.segment_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/segment_response.py b/advancedbilling/models/segment_response.py index 5967e817..cc8aeda6 100644 --- a/advancedbilling/models/segment_response.py +++ b/advancedbilling/models/segment_response.py @@ -14,10 +14,8 @@ class SegmentResponse(object): """Implementation of the 'Segment Response' model. - TODO: type model description here. - Attributes: - segment (Segment): TODO: type description here. + segment (Segment): The model property of type Segment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(segment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'segment={self.segment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'segment={self.segment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/send_invoice_request.py b/advancedbilling/models/send_invoice_request.py index 9eabf37f..0806f7de 100644 --- a/advancedbilling/models/send_invoice_request.py +++ b/advancedbilling/models/send_invoice_request.py @@ -13,12 +13,10 @@ class SendInvoiceRequest(object): """Implementation of the 'Send Invoice Request' model. - TODO: type model description here. - Attributes: - recipient_emails (List[str]): TODO: type description here. - cc_recipient_emails (List[str]): TODO: type description here. - bcc_recipient_emails (List[str]): TODO: type description here. + recipient_emails (List[str]): The model property of type List[str]. + cc_recipient_emails (List[str]): The model property of type List[str]. + bcc_recipient_emails (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -86,3 +84,17 @@ def from_dictionary(cls, cc_recipient_emails, bcc_recipient_emails, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'recipient_emails={self.recipient_emails!r}, ' + f'cc_recipient_emails={self.cc_recipient_emails!r}, ' + f'bcc_recipient_emails={self.bcc_recipient_emails!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'recipient_emails={self.recipient_emails!s}, ' + f'cc_recipient_emails={self.cc_recipient_emails!s}, ' + f'bcc_recipient_emails={self.bcc_recipient_emails!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/service_credit.py b/advancedbilling/models/service_credit.py index 22b0e396..8d86af4e 100644 --- a/advancedbilling/models/service_credit.py +++ b/advancedbilling/models/service_credit.py @@ -13,13 +13,10 @@ class ServiceCredit(object): """Implementation of the 'Service Credit' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - amount_in_cents (long|int): The amount in cents of the entry - ending_balance_in_cents (long|int): The new balance for the credit - account + id (int): The model property of type int. + amount_in_cents (int): The amount in cents of the entry + ending_balance_in_cents (int): The new balance for the credit account entry_type (ServiceCreditType): The type of entry memo (str): The memo attached to the entry additional_properties (Dict[str, object]): The additional properties @@ -103,3 +100,21 @@ def from_dictionary(cls, entry_type, memo, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'ending_balance_in_cents={self.ending_balance_in_cents!r}, ' + f'entry_type={self.entry_type!r}, ' + f'memo={self.memo!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'ending_balance_in_cents={self.ending_balance_in_cents!s}, ' + f'entry_type={self.entry_type!s}, ' + f'memo={self.memo!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/service_credit_response.py b/advancedbilling/models/service_credit_response.py index 119db264..48d5ad99 100644 --- a/advancedbilling/models/service_credit_response.py +++ b/advancedbilling/models/service_credit_response.py @@ -13,10 +13,9 @@ class ServiceCreditResponse(object): """Implementation of the 'Service Credit Response' model. - TODO: type model description here. - Attributes: - service_credit (ServiceCredit): TODO: type description here. + service_credit (ServiceCredit): The model property of type + ServiceCredit. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(service_credit, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'service_credit={self.service_credit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'service_credit={self.service_credit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/service_credit_type.py b/advancedbilling/models/service_credit_type.py index 1492ee64..51b39f2a 100644 --- a/advancedbilling/models/service_credit_type.py +++ b/advancedbilling/models/service_credit_type.py @@ -15,8 +15,8 @@ class ServiceCreditType(object): The type of entry Attributes: - CREDIT: TODO: type description here. - DEBIT: TODO: type description here. + CREDIT: The enum member of type str. + DEBIT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/signup_proforma_preview.py b/advancedbilling/models/signup_proforma_preview.py index 6a4eebc6..7904ea32 100644 --- a/advancedbilling/models/signup_proforma_preview.py +++ b/advancedbilling/models/signup_proforma_preview.py @@ -14,12 +14,11 @@ class SignupProformaPreview(object): """Implementation of the 'Signup Proforma Preview' model. - TODO: type model description here. - Attributes: - current_proforma_invoice (ProformaInvoice): TODO: type description - here. - next_proforma_invoice (ProformaInvoice): TODO: type description here. + current_proforma_invoice (ProformaInvoice): The model property of type + ProformaInvoice. + next_proforma_invoice (ProformaInvoice): The model property of type + ProformaInvoice. additional_properties (Dict[str, object]): The additional properties for the model. @@ -80,3 +79,15 @@ def from_dictionary(cls, return cls(current_proforma_invoice, next_proforma_invoice, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'current_proforma_invoice={self.current_proforma_invoice!r}, ' + f'next_proforma_invoice={self.next_proforma_invoice!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'current_proforma_invoice={self.current_proforma_invoice!s}, ' + f'next_proforma_invoice={self.next_proforma_invoice!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/signup_proforma_preview_response.py b/advancedbilling/models/signup_proforma_preview_response.py index 846ceb4c..eb6f72b0 100644 --- a/advancedbilling/models/signup_proforma_preview_response.py +++ b/advancedbilling/models/signup_proforma_preview_response.py @@ -13,11 +13,9 @@ class SignupProformaPreviewResponse(object): """Implementation of the 'Signup Proforma Preview Response' model. - TODO: type model description here. - Attributes: - proforma_invoice_preview (SignupProformaPreview): TODO: type - description here. + proforma_invoice_preview (SignupProformaPreview): The model property + of type SignupProformaPreview. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(proforma_invoice_preview, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'proforma_invoice_preview={self.proforma_invoice_preview!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'proforma_invoice_preview={self.proforma_invoice_preview!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/site.py b/advancedbilling/models/site.py index ce82de19..73ab58f5 100644 --- a/advancedbilling/models/site.py +++ b/advancedbilling/models/site.py @@ -17,26 +17,30 @@ class Site(object): """Implementation of the 'Site' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - name (str): TODO: type description here. - subdomain (str): TODO: type description here. - currency (str): TODO: type description here. - seller_id (int): TODO: type description here. - non_primary_currencies (List[str]): TODO: type description here. - relationship_invoicing_enabled (bool): TODO: type description here. - customer_hierarchy_enabled (bool): TODO: type description here. - whopays_enabled (bool): TODO: type description here. - whopays_default_payer (str): TODO: type description here. - allocation_settings (AllocationSettings): TODO: type description here. - default_payment_collection_method (str): TODO: type description here. - organization_address (OrganizationAddress): TODO: type description - here. - tax_configuration (TaxConfiguration): TODO: type description here. - net_terms (NetTerms): TODO: type description here. - test (bool): TODO: type description here. + id (int): The model property of type int. + name (str): The model property of type str. + subdomain (str): The model property of type str. + currency (str): The model property of type str. + seller_id (int): The model property of type int. + non_primary_currencies (List[str]): The model property of type + List[str]. + relationship_invoicing_enabled (bool): The model property of type bool. + schedule_subscription_cancellation_enabled (bool): The model property + of type bool. + customer_hierarchy_enabled (bool): The model property of type bool. + whopays_enabled (bool): The model property of type bool. + whopays_default_payer (str): The model property of type str. + allocation_settings (AllocationSettings): The model property of type + AllocationSettings. + default_payment_collection_method (str): The model property of type + str. + organization_address (OrganizationAddress): The model property of type + OrganizationAddress. + tax_configuration (TaxConfiguration): The model property of type + TaxConfiguration. + net_terms (NetTerms): The model property of type NetTerms. + test (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -51,6 +55,7 @@ class Site(object): "seller_id": 'seller_id', "non_primary_currencies": 'non_primary_currencies', "relationship_invoicing_enabled": 'relationship_invoicing_enabled', + "schedule_subscription_cancellation_enabled": 'schedule_subscription_cancellation_enabled', "customer_hierarchy_enabled": 'customer_hierarchy_enabled', "whopays_enabled": 'whopays_enabled', "whopays_default_payer": 'whopays_default_payer', @@ -70,6 +75,7 @@ class Site(object): 'seller_id', 'non_primary_currencies', 'relationship_invoicing_enabled', + 'schedule_subscription_cancellation_enabled', 'customer_hierarchy_enabled', 'whopays_enabled', 'whopays_default_payer', @@ -89,6 +95,7 @@ def __init__(self, seller_id=APIHelper.SKIP, non_primary_currencies=APIHelper.SKIP, relationship_invoicing_enabled=APIHelper.SKIP, + schedule_subscription_cancellation_enabled=APIHelper.SKIP, customer_hierarchy_enabled=APIHelper.SKIP, whopays_enabled=APIHelper.SKIP, whopays_default_payer=APIHelper.SKIP, @@ -116,6 +123,8 @@ def __init__(self, self.non_primary_currencies = non_primary_currencies if relationship_invoicing_enabled is not APIHelper.SKIP: self.relationship_invoicing_enabled = relationship_invoicing_enabled + if schedule_subscription_cancellation_enabled is not APIHelper.SKIP: + self.schedule_subscription_cancellation_enabled = schedule_subscription_cancellation_enabled if customer_hierarchy_enabled is not APIHelper.SKIP: self.customer_hierarchy_enabled = customer_hierarchy_enabled if whopays_enabled is not APIHelper.SKIP: @@ -166,6 +175,7 @@ def from_dictionary(cls, seller_id = dictionary.get("seller_id") if dictionary.get("seller_id") else APIHelper.SKIP non_primary_currencies = dictionary.get("non_primary_currencies") if dictionary.get("non_primary_currencies") else APIHelper.SKIP relationship_invoicing_enabled = dictionary.get("relationship_invoicing_enabled") if "relationship_invoicing_enabled" in dictionary.keys() else APIHelper.SKIP + schedule_subscription_cancellation_enabled = dictionary.get("schedule_subscription_cancellation_enabled") if "schedule_subscription_cancellation_enabled" in dictionary.keys() else APIHelper.SKIP customer_hierarchy_enabled = dictionary.get("customer_hierarchy_enabled") if "customer_hierarchy_enabled" in dictionary.keys() else APIHelper.SKIP whopays_enabled = dictionary.get("whopays_enabled") if "whopays_enabled" in dictionary.keys() else APIHelper.SKIP whopays_default_payer = dictionary.get("whopays_default_payer") if dictionary.get("whopays_default_payer") else APIHelper.SKIP @@ -185,6 +195,7 @@ def from_dictionary(cls, seller_id, non_primary_currencies, relationship_invoicing_enabled, + schedule_subscription_cancellation_enabled, customer_hierarchy_enabled, whopays_enabled, whopays_default_payer, @@ -195,3 +206,45 @@ def from_dictionary(cls, net_terms, test, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'name={self.name!r}, ' + f'subdomain={self.subdomain!r}, ' + f'currency={self.currency!r}, ' + f'seller_id={self.seller_id!r}, ' + f'non_primary_currencies={self.non_primary_currencies!r}, ' + f'relationship_invoicing_enabled={self.relationship_invoicing_enabled!r}, ' + f'schedule_subscription_cancellation_enabled={self.schedule_subscription_cancellation_enabled!r}, ' + f'customer_hierarchy_enabled={self.customer_hierarchy_enabled!r}, ' + f'whopays_enabled={self.whopays_enabled!r}, ' + f'whopays_default_payer={self.whopays_default_payer!r}, ' + f'allocation_settings={self.allocation_settings!r}, ' + f'default_payment_collection_method={self.default_payment_collection_method!r}, ' + f'organization_address={self.organization_address!r}, ' + f'tax_configuration={self.tax_configuration!r}, ' + f'net_terms={self.net_terms!r}, ' + f'test={self.test!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'name={self.name!s}, ' + f'subdomain={self.subdomain!s}, ' + f'currency={self.currency!s}, ' + f'seller_id={self.seller_id!s}, ' + f'non_primary_currencies={self.non_primary_currencies!s}, ' + f'relationship_invoicing_enabled={self.relationship_invoicing_enabled!s}, ' + f'schedule_subscription_cancellation_enabled={self.schedule_subscription_cancellation_enabled!s}, ' + f'customer_hierarchy_enabled={self.customer_hierarchy_enabled!s}, ' + f'whopays_enabled={self.whopays_enabled!s}, ' + f'whopays_default_payer={self.whopays_default_payer!s}, ' + f'allocation_settings={self.allocation_settings!s}, ' + f'default_payment_collection_method={self.default_payment_collection_method!s}, ' + f'organization_address={self.organization_address!s}, ' + f'tax_configuration={self.tax_configuration!s}, ' + f'net_terms={self.net_terms!s}, ' + f'test={self.test!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/site_response.py b/advancedbilling/models/site_response.py index 69fc6f10..8a65f0db 100644 --- a/advancedbilling/models/site_response.py +++ b/advancedbilling/models/site_response.py @@ -13,10 +13,8 @@ class SiteResponse(object): """Implementation of the 'Site Response' model. - TODO: type model description here. - Attributes: - site (Site): TODO: type description here. + site (Site): The model property of type Site. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(site, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'site={self.site!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'site={self.site!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/site_statistics.py b/advancedbilling/models/site_statistics.py index 09e0ef6f..3305cd57 100644 --- a/advancedbilling/models/site_statistics.py +++ b/advancedbilling/models/site_statistics.py @@ -13,20 +13,18 @@ class SiteStatistics(object): """Implementation of the 'Site Statistics' model. - TODO: type model description here. - Attributes: - total_subscriptions (int): TODO: type description here. - subscriptions_today (int): TODO: type description here. - total_revenue (str): TODO: type description here. - revenue_today (str): TODO: type description here. - revenue_this_month (str): TODO: type description here. - revenue_this_year (str): TODO: type description here. - total_canceled_subscriptions (int): TODO: type description here. - total_active_subscriptions (int): TODO: type description here. - total_past_due_subscriptions (int): TODO: type description here. - total_unpaid_subscriptions (int): TODO: type description here. - total_dunning_subscriptions (int): TODO: type description here. + total_subscriptions (int): The model property of type int. + subscriptions_today (int): The model property of type int. + total_revenue (str): The model property of type str. + revenue_today (str): The model property of type str. + revenue_this_month (str): The model property of type str. + revenue_this_year (str): The model property of type str. + total_canceled_subscriptions (int): The model property of type int. + total_active_subscriptions (int): The model property of type int. + total_past_due_subscriptions (int): The model property of type int. + total_unpaid_subscriptions (int): The model property of type int. + total_dunning_subscriptions (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -150,3 +148,33 @@ def from_dictionary(cls, total_unpaid_subscriptions, total_dunning_subscriptions, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'total_subscriptions={self.total_subscriptions!r}, ' + f'subscriptions_today={self.subscriptions_today!r}, ' + f'total_revenue={self.total_revenue!r}, ' + f'revenue_today={self.revenue_today!r}, ' + f'revenue_this_month={self.revenue_this_month!r}, ' + f'revenue_this_year={self.revenue_this_year!r}, ' + f'total_canceled_subscriptions={self.total_canceled_subscriptions!r}, ' + f'total_active_subscriptions={self.total_active_subscriptions!r}, ' + f'total_past_due_subscriptions={self.total_past_due_subscriptions!r}, ' + f'total_unpaid_subscriptions={self.total_unpaid_subscriptions!r}, ' + f'total_dunning_subscriptions={self.total_dunning_subscriptions!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'total_subscriptions={self.total_subscriptions!s}, ' + f'subscriptions_today={self.subscriptions_today!s}, ' + f'total_revenue={self.total_revenue!s}, ' + f'revenue_today={self.revenue_today!s}, ' + f'revenue_this_month={self.revenue_this_month!s}, ' + f'revenue_this_year={self.revenue_this_year!s}, ' + f'total_canceled_subscriptions={self.total_canceled_subscriptions!s}, ' + f'total_active_subscriptions={self.total_active_subscriptions!s}, ' + f'total_past_due_subscriptions={self.total_past_due_subscriptions!s}, ' + f'total_unpaid_subscriptions={self.total_unpaid_subscriptions!s}, ' + f'total_dunning_subscriptions={self.total_dunning_subscriptions!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/site_summary.py b/advancedbilling/models/site_summary.py index 399eee2c..575540bc 100644 --- a/advancedbilling/models/site_summary.py +++ b/advancedbilling/models/site_summary.py @@ -14,14 +14,12 @@ class SiteSummary(object): """Implementation of the 'Site Summary' model. - TODO: type model description here. - Attributes: - seller_name (str): TODO: type description here. - site_name (str): TODO: type description here. - site_id (int): TODO: type description here. - site_currency (str): TODO: type description here. - stats (SiteStatistics): TODO: type description here. + seller_name (str): The model property of type str. + site_name (str): The model property of type str. + site_id (int): The model property of type int. + site_currency (str): The model property of type str. + stats (SiteStatistics): The model property of type SiteStatistics. additional_properties (Dict[str, object]): The additional properties for the model. @@ -103,3 +101,21 @@ def from_dictionary(cls, site_currency, stats, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'seller_name={self.seller_name!r}, ' + f'site_name={self.site_name!r}, ' + f'site_id={self.site_id!r}, ' + f'site_currency={self.site_currency!r}, ' + f'stats={self.stats!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'seller_name={self.seller_name!s}, ' + f'site_name={self.site_name!s}, ' + f'site_id={self.site_id!s}, ' + f'site_currency={self.site_currency!s}, ' + f'stats={self.stats!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/snap_day.py b/advancedbilling/models/snap_day.py index b18f9e80..337af0cf 100644 --- a/advancedbilling/models/snap_day.py +++ b/advancedbilling/models/snap_day.py @@ -16,7 +16,7 @@ class SnapDay(object): Value can be 1-28 or 'end'. Attributes: - END: TODO: type description here. + END: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/sorting_direction.py b/advancedbilling/models/sorting_direction.py index b83a72d9..b27858b9 100644 --- a/advancedbilling/models/sorting_direction.py +++ b/advancedbilling/models/sorting_direction.py @@ -15,8 +15,8 @@ class SortingDirection(object): Used for sorting results. Attributes: - ASC: TODO: type description here. - DESC: TODO: type description here. + ASC: The enum member of type str. + DESC: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription.py b/advancedbilling/models/subscription.py index 92656b25..fe80c543 100644 --- a/advancedbilling/models/subscription.py +++ b/advancedbilling/models/subscription.py @@ -20,8 +20,6 @@ class Subscription(object): """Implementation of the 'Subscription' model. - TODO: type model description here. - Attributes: id (int): The subscription unique id within Chargify. state (SubscriptionState): The state of a subscription. * **Live @@ -89,15 +87,15 @@ class Subscription(object): States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853- Subscription-States) for more info about subscription states and state transitions. - balance_in_cents (long|int): Gives the current outstanding - subscription balance in the number of cents. - total_revenue_in_cents (long|int): Gives the total revenue from the + balance_in_cents (int): Gives the current outstanding subscription + balance in the number of cents. + total_revenue_in_cents (int): Gives the total revenue from the subscription in the number of cents. - product_price_in_cents (long|int): (Added Nov 5 2013) The recurring - amount of the product (and version),currently subscribed. NOTE: - this may differ from the current price of,the product, if you’ve - changed the price of the product but haven’t,moved this - subscription to a newer version. + product_price_in_cents (int): (Added Nov 5 2013) The recurring amount + of the product (and version),currently subscribed. NOTE: this may + differ from the current price of,the product, if you’ve changed + the price of the product but haven’t,moved this subscription to a + newer version. product_version_number (int): The version of the product for the subscription. Note that this is a deprecated field kept for backwards-compatibility. @@ -154,11 +152,14 @@ class Subscription(object): Architecture valid options are - `invoice`, `automatic`. For current Relationship Invoicing Architecture valid options are - `remittance`, `automatic`, `prepaid`. - customer (Customer): TODO: type description here. - product (Product): TODO: type description here. - credit_card (CreditCardPaymentProfile): TODO: type description here. - group (NestedSubscriptionGroup): TODO: type description here. - bank_account (BankAccountPaymentProfile): TODO: type description here. + customer (Customer): The model property of type Customer. + product (Product): The model property of type Product. + credit_card (CreditCardPaymentProfile): The model property of type + CreditCardPaymentProfile. + group (NestedSubscriptionGroup): The model property of type + NestedSubscriptionGroup. + bank_account (BankAccountPaymentProfile): The model property of type + BankAccountPaymentProfile. payment_type (str): The payment profile type for the active profile on file. referral_code (str): The subscription's unique code that can be given @@ -185,8 +186,8 @@ class Subscription(object): payer_id (int): On Relationship Invoicing, the ID of the individual paying for the subscription. Defaults to the Customer ID unless the 'Customer Hierarchies & WhoPays' feature is enabled. - current_billing_amount_in_cents (long|int): The balance in cents plus - the estimated renewal amount in cents. Returned ONLY for + current_billing_amount_in_cents (int): The balance in cents plus the + estimated renewal amount in cents. Returned ONLY for readSubscription operation as it's compute intensive operation. product_price_point_id (int): The product price point currently subscribed to. @@ -220,14 +221,15 @@ class Subscription(object): `dunning_communication_delay_time_zone` attribute. dunning_communication_delay_time_zone (str): Time zone for the Dunning Communication Delay feature. - receives_invoice_emails (bool): TODO: type description here. - locale (str): TODO: type description here. - currency (str): TODO: type description here. - scheduled_cancellation_at (datetime): TODO: type description here. - credit_balance_in_cents (long|int): TODO: type description here. - prepayment_balance_in_cents (long|int): TODO: type description here. - prepaid_configuration (PrepaidConfiguration): TODO: type description - here. + receives_invoice_emails (bool): The model property of type bool. + locale (str): The model property of type str. + currency (str): The model property of type str. + scheduled_cancellation_at (datetime): The model property of type + datetime. + credit_balance_in_cents (int): The model property of type int. + prepayment_balance_in_cents (int): The model property of type int. + prepaid_configuration (PrepaidConfiguration): The model property of + type PrepaidConfiguration. self_service_page_token (str): Returned only for list/read Subscription operation when `include[]=self_service_page_token` parameter is provided. @@ -795,3 +797,135 @@ def from_dictionary(cls, prepaid_configuration, self_service_page_token, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'state={self.state!r}, ' + f'balance_in_cents={self.balance_in_cents!r}, ' + f'total_revenue_in_cents={self.total_revenue_in_cents!r}, ' + f'product_price_in_cents={self.product_price_in_cents!r}, ' + f'product_version_number={self.product_version_number!r}, ' + f'current_period_ends_at={self.current_period_ends_at!r}, ' + f'next_assessment_at={self.next_assessment_at!r}, ' + f'trial_started_at={self.trial_started_at!r}, ' + f'trial_ended_at={self.trial_ended_at!r}, ' + f'activated_at={self.activated_at!r}, ' + f'expires_at={self.expires_at!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'cancellation_message={self.cancellation_message!r}, ' + f'cancellation_method={self.cancellation_method!r}, ' + f'cancel_at_end_of_period={self.cancel_at_end_of_period!r}, ' + f'canceled_at={self.canceled_at!r}, ' + f'current_period_started_at={self.current_period_started_at!r}, ' + f'previous_state={self.previous_state!r}, ' + f'signup_payment_id={self.signup_payment_id!r}, ' + f'signup_revenue={self.signup_revenue!r}, ' + f'delayed_cancel_at={self.delayed_cancel_at!r}, ' + f'coupon_code={self.coupon_code!r}, ' + f'snap_day={self.snap_day!r}, ' + f'payment_collection_method={self.payment_collection_method!r}, ' + f'customer={self.customer!r}, ' + f'product={self.product!r}, ' + f'credit_card={self.credit_card!r}, ' + f'group={self.group!r}, ' + f'bank_account={self.bank_account!r}, ' + f'payment_type={self.payment_type!r}, ' + f'referral_code={self.referral_code!r}, ' + f'next_product_id={self.next_product_id!r}, ' + f'next_product_handle={self.next_product_handle!r}, ' + f'coupon_use_count={self.coupon_use_count!r}, ' + f'coupon_uses_allowed={self.coupon_uses_allowed!r}, ' + f'reason_code={self.reason_code!r}, ' + f'automatically_resume_at={self.automatically_resume_at!r}, ' + f'coupon_codes={self.coupon_codes!r}, ' + f'offer_id={self.offer_id!r}, ' + f'payer_id={self.payer_id!r}, ' + f'current_billing_amount_in_cents={self.current_billing_amount_in_cents!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'product_price_point_type={self.product_price_point_type!r}, ' + f'next_product_price_point_id={self.next_product_price_point_id!r}, ' + f'net_terms={self.net_terms!r}, ' + f'stored_credential_transaction_id={self.stored_credential_transaction_id!r}, ' + f'reference={self.reference!r}, ' + f'on_hold_at={self.on_hold_at!r}, ' + f'prepaid_dunning={self.prepaid_dunning!r}, ' + f'coupons={self.coupons!r}, ' + f'dunning_communication_delay_enabled={self.dunning_communication_delay_enabled!r}, ' + f'dunning_communication_delay_time_zone={self.dunning_communication_delay_time_zone!r}, ' + f'receives_invoice_emails={self.receives_invoice_emails!r}, ' + f'locale={self.locale!r}, ' + f'currency={self.currency!r}, ' + f'scheduled_cancellation_at={self.scheduled_cancellation_at!r}, ' + f'credit_balance_in_cents={self.credit_balance_in_cents!r}, ' + f'prepayment_balance_in_cents={self.prepayment_balance_in_cents!r}, ' + f'prepaid_configuration={self.prepaid_configuration!r}, ' + f'self_service_page_token={self.self_service_page_token!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'state={self.state!s}, ' + f'balance_in_cents={self.balance_in_cents!s}, ' + f'total_revenue_in_cents={self.total_revenue_in_cents!s}, ' + f'product_price_in_cents={self.product_price_in_cents!s}, ' + f'product_version_number={self.product_version_number!s}, ' + f'current_period_ends_at={self.current_period_ends_at!s}, ' + f'next_assessment_at={self.next_assessment_at!s}, ' + f'trial_started_at={self.trial_started_at!s}, ' + f'trial_ended_at={self.trial_ended_at!s}, ' + f'activated_at={self.activated_at!s}, ' + f'expires_at={self.expires_at!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'cancellation_message={self.cancellation_message!s}, ' + f'cancellation_method={self.cancellation_method!s}, ' + f'cancel_at_end_of_period={self.cancel_at_end_of_period!s}, ' + f'canceled_at={self.canceled_at!s}, ' + f'current_period_started_at={self.current_period_started_at!s}, ' + f'previous_state={self.previous_state!s}, ' + f'signup_payment_id={self.signup_payment_id!s}, ' + f'signup_revenue={self.signup_revenue!s}, ' + f'delayed_cancel_at={self.delayed_cancel_at!s}, ' + f'coupon_code={self.coupon_code!s}, ' + f'snap_day={self.snap_day!s}, ' + f'payment_collection_method={self.payment_collection_method!s}, ' + f'customer={self.customer!s}, ' + f'product={self.product!s}, ' + f'credit_card={self.credit_card!s}, ' + f'group={self.group!s}, ' + f'bank_account={self.bank_account!s}, ' + f'payment_type={self.payment_type!s}, ' + f'referral_code={self.referral_code!s}, ' + f'next_product_id={self.next_product_id!s}, ' + f'next_product_handle={self.next_product_handle!s}, ' + f'coupon_use_count={self.coupon_use_count!s}, ' + f'coupon_uses_allowed={self.coupon_uses_allowed!s}, ' + f'reason_code={self.reason_code!s}, ' + f'automatically_resume_at={self.automatically_resume_at!s}, ' + f'coupon_codes={self.coupon_codes!s}, ' + f'offer_id={self.offer_id!s}, ' + f'payer_id={self.payer_id!s}, ' + f'current_billing_amount_in_cents={self.current_billing_amount_in_cents!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'product_price_point_type={self.product_price_point_type!s}, ' + f'next_product_price_point_id={self.next_product_price_point_id!s}, ' + f'net_terms={self.net_terms!s}, ' + f'stored_credential_transaction_id={self.stored_credential_transaction_id!s}, ' + f'reference={self.reference!s}, ' + f'on_hold_at={self.on_hold_at!s}, ' + f'prepaid_dunning={self.prepaid_dunning!s}, ' + f'coupons={self.coupons!s}, ' + f'dunning_communication_delay_enabled={self.dunning_communication_delay_enabled!s}, ' + f'dunning_communication_delay_time_zone={self.dunning_communication_delay_time_zone!s}, ' + f'receives_invoice_emails={self.receives_invoice_emails!s}, ' + f'locale={self.locale!s}, ' + f'currency={self.currency!s}, ' + f'scheduled_cancellation_at={self.scheduled_cancellation_at!s}, ' + f'credit_balance_in_cents={self.credit_balance_in_cents!s}, ' + f'prepayment_balance_in_cents={self.prepayment_balance_in_cents!s}, ' + f'prepaid_configuration={self.prepaid_configuration!s}, ' + f'self_service_page_token={self.self_service_page_token!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_component.py b/advancedbilling/models/subscription_component.py index d3da60a2..3b62d729 100644 --- a/advancedbilling/models/subscription_component.py +++ b/advancedbilling/models/subscription_component.py @@ -15,25 +15,24 @@ class SubscriptionComponent(object): """Implementation of the 'Subscription Component' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - name (str): TODO: type description here. + id (int): The model property of type int. + name (str): The model property of type str. kind (ComponentKind): A handle for the component type - unit_name (str): TODO: type description here. + unit_name (str): The model property of type str. enabled (bool): (for on/off components) indicates if the component is enabled for the subscription - unit_balance (int): TODO: type description here. - currency (str): TODO: type description here. + unit_balance (int): The model property of type int. + currency (str): The model property of type str. allocated_quantity (int | str | None): For Quantity-based components: The current allocation for the component on the given subscription. For On/Off components: Use 1 for on. Use 0 for off. - pricing_scheme (PricingScheme): TODO: type description here. - component_id (int): TODO: type description here. - component_handle (str): TODO: type description here. - subscription_id (int): TODO: type description here. - recurring (bool): TODO: type description here. + pricing_scheme (PricingScheme): The model property of type + PricingScheme. + component_id (int): The model property of type int. + component_handle (str): The model property of type str. + subscription_id (int): The model property of type int. + recurring (bool): The model property of type bool. upgrade_charge (CreditType): The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, @@ -42,22 +41,24 @@ class SubscriptionComponent(object): upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, `prorated`, `none`. - archived_at (datetime): TODO: type description here. - price_point_id (int): TODO: type description here. - price_point_handle (str): TODO: type description here. - price_point_type (PricePointType): TODO: type description here. - price_point_name (str): TODO: type description here. - product_family_id (int): TODO: type description here. - product_family_handle (str): TODO: type description here. - created_at (datetime): TODO: type description here. - updated_at (datetime): TODO: type description here. - use_site_exchange_rate (bool): TODO: type description here. - description (str): TODO: type description here. - allow_fractional_quantities (bool): TODO: type description here. + archived_at (datetime): The model property of type datetime. + price_point_id (int): The model property of type int. + price_point_handle (str): The model property of type str. + price_point_type (PricePointType): The model property of type + PricePointType. + price_point_name (str): The model property of type str. + product_family_id (int): The model property of type int. + product_family_handle (str): The model property of type str. + created_at (datetime): The model property of type datetime. + updated_at (datetime): The model property of type datetime. + use_site_exchange_rate (bool): The model property of type bool. + description (str): The model property of type str. + allow_fractional_quantities (bool): The model property of type bool. subscription (SubscriptionComponentSubscription): An optional object, will be returned if provided `include=subscription` query param. - historic_usages (List[HistoricUsage]): TODO: type description here. - display_on_hosted_page (bool): TODO: type description here. + historic_usages (List[HistoricUsage]): The model property of type + List[HistoricUsage]. + display_on_hosted_page (bool): The model property of type bool. interval (int): The numerical interval. i.e. an interval of '30' coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only @@ -358,3 +359,75 @@ def from_dictionary(cls, interval, interval_unit, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'name={self.name!r}, ' + f'kind={self.kind!r}, ' + f'unit_name={self.unit_name!r}, ' + f'enabled={self.enabled!r}, ' + f'unit_balance={self.unit_balance!r}, ' + f'currency={self.currency!r}, ' + f'allocated_quantity={self.allocated_quantity!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'component_id={self.component_id!r}, ' + f'component_handle={self.component_handle!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'recurring={self.recurring!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'downgrade_credit={self.downgrade_credit!r}, ' + f'archived_at={self.archived_at!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'price_point_handle={self.price_point_handle!r}, ' + f'price_point_type={self.price_point_type!r}, ' + f'price_point_name={self.price_point_name!r}, ' + f'product_family_id={self.product_family_id!r}, ' + f'product_family_handle={self.product_family_handle!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'description={self.description!r}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!r}, ' + f'subscription={self.subscription!r}, ' + f'historic_usages={self.historic_usages!r}, ' + f'display_on_hosted_page={self.display_on_hosted_page!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'name={self.name!s}, ' + f'kind={self.kind!s}, ' + f'unit_name={self.unit_name!s}, ' + f'enabled={self.enabled!s}, ' + f'unit_balance={self.unit_balance!s}, ' + f'currency={self.currency!s}, ' + f'allocated_quantity={self.allocated_quantity!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'component_id={self.component_id!s}, ' + f'component_handle={self.component_handle!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'recurring={self.recurring!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'downgrade_credit={self.downgrade_credit!s}, ' + f'archived_at={self.archived_at!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'price_point_handle={self.price_point_handle!s}, ' + f'price_point_type={self.price_point_type!s}, ' + f'price_point_name={self.price_point_name!s}, ' + f'product_family_id={self.product_family_id!s}, ' + f'product_family_handle={self.product_family_handle!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'description={self.description!s}, ' + f'allow_fractional_quantities={self.allow_fractional_quantities!s}, ' + f'subscription={self.subscription!s}, ' + f'historic_usages={self.historic_usages!s}, ' + f'display_on_hosted_page={self.display_on_hosted_page!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_component_allocation_error_item.py b/advancedbilling/models/subscription_component_allocation_error_item.py index e93d7a9e..01166ba1 100644 --- a/advancedbilling/models/subscription_component_allocation_error_item.py +++ b/advancedbilling/models/subscription_component_allocation_error_item.py @@ -13,11 +13,9 @@ class SubscriptionComponentAllocationErrorItem(object): """Implementation of the 'Subscription Component Allocation Error Item' model. - TODO: type model description here. - Attributes: - kind (str): TODO: type description here. - message (str): TODO: type description here. + kind (str): The model property of type str. + message (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -78,3 +76,15 @@ def from_dictionary(cls, return cls(kind, message, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'kind={self.kind!r}, ' + f'message={self.message!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'kind={self.kind!s}, ' + f'message={self.message!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_component_response.py b/advancedbilling/models/subscription_component_response.py index eaa96429..5f9c75f2 100644 --- a/advancedbilling/models/subscription_component_response.py +++ b/advancedbilling/models/subscription_component_response.py @@ -14,10 +14,9 @@ class SubscriptionComponentResponse(object): """Implementation of the 'Subscription Component Response' model. - TODO: type model description here. - Attributes: - component (SubscriptionComponent): TODO: type description here. + component (SubscriptionComponent): The model property of type + SubscriptionComponent. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +70,13 @@ def from_dictionary(cls, # Return an object of this model return cls(component, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component={self.component!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component={self.component!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_component_subscription.py b/advancedbilling/models/subscription_component_subscription.py index 1c36d797..9b8caf0c 100644 --- a/advancedbilling/models/subscription_component_subscription.py +++ b/advancedbilling/models/subscription_component_subscription.py @@ -82,7 +82,7 @@ class SubscriptionComponentSubscription(object): States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853- Subscription-States) for more info about subscription states and state transitions. - updated_at (datetime): TODO: type description here. + updated_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -165,3 +165,15 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'state={self.state!r}, ' + f'updated_at={self.updated_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'state={self.state!s}, ' + f'updated_at={self.updated_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_custom_price.py b/advancedbilling/models/subscription_custom_price.py index c930105f..3c717b0f 100644 --- a/advancedbilling/models/subscription_custom_price.py +++ b/advancedbilling/models/subscription_custom_price.py @@ -20,15 +20,14 @@ class SubscriptionCustomPrice(object): Attributes: name (str): (Optional) handle (str): (Optional) - price_in_cents (str | long | int): Required if using `custom_price` - attribute. + price_in_cents (str | int): Required if using `custom_price` attribute. interval (str | int): Required if using `custom_price` attribute. interval_unit (IntervalUnit): Required if using `custom_price` attribute. - trial_price_in_cents (str | long | int | None): (Optional) + trial_price_in_cents (str | int | None): (Optional) trial_interval (str | int | None): (Optional) trial_interval_unit (IntervalUnit): (Optional) - initial_charge_in_cents (str | long | int | None): (Optional) + initial_charge_in_cents (str | int | None): (Optional) initial_charge_after_trial (bool): (Optional) expiration_interval (str | int | None): (Optional) expiration_interval_unit (ExpirationIntervalUnit): (Optional) @@ -201,3 +200,37 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('interval_unit'), type_callable=lambda value: IntervalUnit.validate(value), is_value_nullable=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'price_in_cents={self.price_in_cents!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'trial_price_in_cents={self.trial_price_in_cents!r}, ' + f'trial_interval={self.trial_interval!r}, ' + f'trial_interval_unit={self.trial_interval_unit!r}, ' + f'initial_charge_in_cents={self.initial_charge_in_cents!r}, ' + f'initial_charge_after_trial={self.initial_charge_after_trial!r}, ' + f'expiration_interval={self.expiration_interval!r}, ' + f'expiration_interval_unit={self.expiration_interval_unit!r}, ' + f'tax_included={self.tax_included!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'price_in_cents={self.price_in_cents!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'trial_price_in_cents={self.trial_price_in_cents!s}, ' + f'trial_interval={self.trial_interval!s}, ' + f'trial_interval_unit={self.trial_interval_unit!s}, ' + f'initial_charge_in_cents={self.initial_charge_in_cents!s}, ' + f'initial_charge_after_trial={self.initial_charge_after_trial!s}, ' + f'expiration_interval={self.expiration_interval!s}, ' + f'expiration_interval_unit={self.expiration_interval_unit!s}, ' + f'tax_included={self.tax_included!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_date_field.py b/advancedbilling/models/subscription_date_field.py index 2b43d1fd..ab525149 100644 --- a/advancedbilling/models/subscription_date_field.py +++ b/advancedbilling/models/subscription_date_field.py @@ -12,18 +12,16 @@ class SubscriptionDateField(object): """Implementation of the 'Subscription Date Field' enum. - TODO: type enum description here. - Attributes: - CURRENT_PERIOD_ENDS_AT: TODO: type description here. - CURRENT_PERIOD_STARTS_AT: TODO: type description here. - CREATED_AT: TODO: type description here. - ACTIVATED_AT: TODO: type description here. - CANCELED_AT: TODO: type description here. - EXPIRES_AT: TODO: type description here. - TRIAL_STARTED_AT: TODO: type description here. - TRIAL_ENDED_AT: TODO: type description here. - UPDATED_AT: TODO: type description here. + CURRENT_PERIOD_ENDS_AT: The enum member of type str. + CURRENT_PERIOD_STARTS_AT: The enum member of type str. + CREATED_AT: The enum member of type str. + ACTIVATED_AT: The enum member of type str. + CANCELED_AT: The enum member of type str. + EXPIRES_AT: The enum member of type str. + TRIAL_STARTED_AT: The enum member of type str. + TRIAL_ENDED_AT: The enum member of type str. + UPDATED_AT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription_filter.py b/advancedbilling/models/subscription_filter.py index 05753610..eac1d6f0 100644 --- a/advancedbilling/models/subscription_filter.py +++ b/advancedbilling/models/subscription_filter.py @@ -144,3 +144,23 @@ def from_dictionary(cls, start_datetime, end_datetime, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'states={self.states!r}, ' + f'date_field={self.date_field!r}, ' + f'start_date={self.start_date!r}, ' + f'end_date={self.end_date!r}, ' + f'start_datetime={self.start_datetime!r}, ' + f'end_datetime={self.end_datetime!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'states={self.states!s}, ' + f'date_field={self.date_field!s}, ' + f'start_date={self.start_date!s}, ' + f'end_date={self.end_date!s}, ' + f'start_datetime={self.start_datetime!s}, ' + f'end_datetime={self.end_datetime!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group.py b/advancedbilling/models/subscription_group.py index e170f8ce..15e75766 100644 --- a/advancedbilling/models/subscription_group.py +++ b/advancedbilling/models/subscription_group.py @@ -14,19 +14,17 @@ class SubscriptionGroup(object): """Implementation of the 'Subscription Group' model. - TODO: type model description here. - Attributes: - customer_id (int): TODO: type description here. - payment_profile (SubscriptionGroupPaymentProfile): TODO: type - description here. + customer_id (int): The model property of type int. + payment_profile (SubscriptionGroupPaymentProfile): The model property + of type SubscriptionGroupPaymentProfile. payment_collection_method (CollectionMethod): The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For current Relationship Invoicing Architecture valid options are - `remittance`, `automatic`, `prepaid`. - subscription_ids (List[int]): TODO: type description here. - created_at (datetime): TODO: type description here. + subscription_ids (List[int]): The model property of type List[int]. + created_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -108,3 +106,21 @@ def from_dictionary(cls, subscription_ids, created_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'customer_id={self.customer_id!r}, ' + f'payment_profile={self.payment_profile!r}, ' + f'payment_collection_method={self.payment_collection_method!r}, ' + f'subscription_ids={self.subscription_ids!r}, ' + f'created_at={self.created_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'customer_id={self.customer_id!s}, ' + f'payment_profile={self.payment_profile!s}, ' + f'payment_collection_method={self.payment_collection_method!s}, ' + f'subscription_ids={self.subscription_ids!s}, ' + f'created_at={self.created_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_balances.py b/advancedbilling/models/subscription_group_balances.py index 447033b7..a207c0af 100644 --- a/advancedbilling/models/subscription_group_balances.py +++ b/advancedbilling/models/subscription_group_balances.py @@ -14,13 +14,15 @@ class SubscriptionGroupBalances(object): """Implementation of the 'Subscription Group Balances' model. - TODO: type model description here. - Attributes: - prepayments (AccountBalance): TODO: type description here. - service_credits (AccountBalance): TODO: type description here. - open_invoices (AccountBalance): TODO: type description here. - pending_discounts (AccountBalance): TODO: type description here. + prepayments (AccountBalance): The model property of type + AccountBalance. + service_credits (AccountBalance): The model property of type + AccountBalance. + open_invoices (AccountBalance): The model property of type + AccountBalance. + pending_discounts (AccountBalance): The model property of type + AccountBalance. additional_properties (Dict[str, object]): The additional properties for the model. @@ -95,3 +97,19 @@ def from_dictionary(cls, open_invoices, pending_discounts, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepayments={self.prepayments!r}, ' + f'service_credits={self.service_credits!r}, ' + f'open_invoices={self.open_invoices!r}, ' + f'pending_discounts={self.pending_discounts!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepayments={self.prepayments!s}, ' + f'service_credits={self.service_credits!s}, ' + f'open_invoices={self.open_invoices!s}, ' + f'pending_discounts={self.pending_discounts!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_bank_account.py b/advancedbilling/models/subscription_group_bank_account.py index ada0199b..4e470f31 100644 --- a/advancedbilling/models/subscription_group_bank_account.py +++ b/advancedbilling/models/subscription_group_bank_account.py @@ -13,8 +13,6 @@ class SubscriptionGroupBankAccount(object): """Implementation of the 'Subscription Group Bank Account' model. - TODO: type model description here. - Attributes: bank_name (str): (Required when creating a subscription with ACH or GoCardless) The name of the bank where the customer’s account @@ -33,16 +31,16 @@ class SubscriptionGroupBankAccount(object): GoCardless) Branch code. Alternatively, an IBAN can be provided bank_account_type (BankAccountType): Defaults to checking bank_account_holder_type (BankAccountHolderType): Defaults to personal - payment_type (PaymentType): TODO: type description here. - billing_address (str): TODO: type description here. - billing_city (str): TODO: type description here. - billing_state (str): TODO: type description here. - billing_zip (str): TODO: type description here. - billing_country (str): TODO: type description here. - chargify_token (str): TODO: type description here. + payment_type (PaymentType): The model property of type PaymentType. + billing_address (str): The model property of type str. + billing_city (str): The model property of type str. + billing_state (str): The model property of type str. + billing_zip (str): The model property of type str. + billing_country (str): The model property of type str. + chargify_token (str): The model property of type str. current_vault (BankAccountVault): The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. - gateway_handle (str): TODO: type description here. + gateway_handle (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -223,3 +221,43 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'bank_name={self.bank_name!r}, ' + f'bank_account_number={self.bank_account_number!r}, ' + f'bank_routing_number={self.bank_routing_number!r}, ' + f'bank_iban={self.bank_iban!r}, ' + f'bank_branch_code={self.bank_branch_code!r}, ' + f'bank_account_type={self.bank_account_type!r}, ' + f'bank_account_holder_type={self.bank_account_holder_type!r}, ' + f'payment_type={self.payment_type!r}, ' + f'billing_address={self.billing_address!r}, ' + f'billing_city={self.billing_city!r}, ' + f'billing_state={self.billing_state!r}, ' + f'billing_zip={self.billing_zip!r}, ' + f'billing_country={self.billing_country!r}, ' + f'chargify_token={self.chargify_token!r}, ' + f'current_vault={self.current_vault!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'bank_name={self.bank_name!s}, ' + f'bank_account_number={self.bank_account_number!s}, ' + f'bank_routing_number={self.bank_routing_number!s}, ' + f'bank_iban={self.bank_iban!s}, ' + f'bank_branch_code={self.bank_branch_code!s}, ' + f'bank_account_type={self.bank_account_type!s}, ' + f'bank_account_holder_type={self.bank_account_holder_type!s}, ' + f'payment_type={self.payment_type!s}, ' + f'billing_address={self.billing_address!s}, ' + f'billing_city={self.billing_city!s}, ' + f'billing_state={self.billing_state!s}, ' + f'billing_zip={self.billing_zip!s}, ' + f'billing_country={self.billing_country!s}, ' + f'chargify_token={self.chargify_token!s}, ' + f'current_vault={self.current_vault!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_component_custom_price.py b/advancedbilling/models/subscription_group_component_custom_price.py index e909a345..9d77951f 100644 --- a/advancedbilling/models/subscription_group_component_custom_price.py +++ b/advancedbilling/models/subscription_group_component_custom_price.py @@ -23,9 +23,9 @@ class SubscriptionGroupComponentCustomPrice(object): See [Product Components](https://help.chargify.com/products/product-components.h tml) for an overview of pricing schemes. - prices (List[Price]): TODO: type description here. - overage_pricing (List[ComponentCustomPrice]): TODO: type description - here. + prices (List[Price]): The model property of type List[Price]. + overage_pricing (List[ComponentCustomPrice]): The model property of + type List[ComponentCustomPrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -123,3 +123,17 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'overage_pricing={self.overage_pricing!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'overage_pricing={self.overage_pricing!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_credit_card.py b/advancedbilling/models/subscription_group_credit_card.py index 0d58ee78..3ceabf72 100644 --- a/advancedbilling/models/subscription_group_credit_card.py +++ b/advancedbilling/models/subscription_group_credit_card.py @@ -13,30 +13,31 @@ class SubscriptionGroupCreditCard(object): """Implementation of the 'Subscription Group Credit Card' model. - TODO: type model description here. - Attributes: - full_number (str | int | None): TODO: type description here. - expiration_month (str | int | None): TODO: type description here. - expiration_year (str | int | None): TODO: type description here. - chargify_token (str): TODO: type description here. - vault_token (str): TODO: type description here. + full_number (str | int | None): The model property of type str | int | + None. + expiration_month (str | int | None): The model property of type str | + int | None. + expiration_year (str | int | None): The model property of type str | + int | None. + chargify_token (str): The model property of type str. + vault_token (str): The model property of type str. current_vault (CreditCardVault): The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. - gateway_handle (str): TODO: type description here. - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - billing_address (str): TODO: type description here. - billing_address_2 (str): TODO: type description here. - billing_city (str): TODO: type description here. - billing_state (str): TODO: type description here. - billing_zip (str): TODO: type description here. - billing_country (str): TODO: type description here. - last_four (str): TODO: type description here. + gateway_handle (str): The model property of type str. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + billing_address (str): The model property of type str. + billing_address_2 (str): The model property of type str. + billing_city (str): The model property of type str. + billing_state (str): The model property of type str. + billing_zip (str): The model property of type str. + billing_country (str): The model property of type str. + last_four (str): The model property of type str. card_type (CardType): The type of card used. - customer_vault_token (str): TODO: type description here. - cvv (str): TODO: type description here. - payment_type (str): TODO: type description here. + customer_vault_token (str): The model property of type str. + cvv (str): The model property of type str. + payment_type (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -246,3 +247,51 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'full_number={self.full_number!r}, ' + f'expiration_month={self.expiration_month!r}, ' + f'expiration_year={self.expiration_year!r}, ' + f'chargify_token={self.chargify_token!r}, ' + f'vault_token={self.vault_token!r}, ' + f'current_vault={self.current_vault!r}, ' + f'gateway_handle={self.gateway_handle!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'billing_address={self.billing_address!r}, ' + f'billing_address_2={self.billing_address_2!r}, ' + f'billing_city={self.billing_city!r}, ' + f'billing_state={self.billing_state!r}, ' + f'billing_zip={self.billing_zip!r}, ' + f'billing_country={self.billing_country!r}, ' + f'last_four={self.last_four!r}, ' + f'card_type={self.card_type!r}, ' + f'customer_vault_token={self.customer_vault_token!r}, ' + f'cvv={self.cvv!r}, ' + f'payment_type={self.payment_type!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'full_number={self.full_number!s}, ' + f'expiration_month={self.expiration_month!s}, ' + f'expiration_year={self.expiration_year!s}, ' + f'chargify_token={self.chargify_token!s}, ' + f'vault_token={self.vault_token!s}, ' + f'current_vault={self.current_vault!s}, ' + f'gateway_handle={self.gateway_handle!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'billing_address={self.billing_address!s}, ' + f'billing_address_2={self.billing_address_2!s}, ' + f'billing_city={self.billing_city!s}, ' + f'billing_state={self.billing_state!s}, ' + f'billing_zip={self.billing_zip!s}, ' + f'billing_country={self.billing_country!s}, ' + f'last_four={self.last_four!s}, ' + f'card_type={self.card_type!s}, ' + f'customer_vault_token={self.customer_vault_token!s}, ' + f'cvv={self.cvv!s}, ' + f'payment_type={self.payment_type!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_customer.py b/advancedbilling/models/subscription_group_customer.py index 16629247..849cba8c 100644 --- a/advancedbilling/models/subscription_group_customer.py +++ b/advancedbilling/models/subscription_group_customer.py @@ -13,14 +13,12 @@ class SubscriptionGroupCustomer(object): """Implementation of the 'Subscription Group Customer' model. - TODO: type model description here. - Attributes: - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - organization (str): TODO: type description here. - email (str): TODO: type description here. - reference (str): TODO: type description here. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + organization (str): The model property of type str. + email (str): The model property of type str. + reference (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -102,3 +100,21 @@ def from_dictionary(cls, email, reference, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'organization={self.organization!r}, ' + f'email={self.email!r}, ' + f'reference={self.reference!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'organization={self.organization!s}, ' + f'email={self.email!s}, ' + f'reference={self.reference!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_include.py b/advancedbilling/models/subscription_group_include.py index 8b5229af..6f358cf7 100644 --- a/advancedbilling/models/subscription_group_include.py +++ b/advancedbilling/models/subscription_group_include.py @@ -12,10 +12,8 @@ class SubscriptionGroupInclude(object): """Implementation of the 'Subscription Group Include' enum. - TODO: type enum description here. - Attributes: - CURRENT_BILLING_AMOUNT_IN_CENTS: TODO: type description here. + CURRENT_BILLING_AMOUNT_IN_CENTS: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription_group_item.py b/advancedbilling/models/subscription_group_item.py index 60bbb954..fe6f3a4d 100644 --- a/advancedbilling/models/subscription_group_item.py +++ b/advancedbilling/models/subscription_group_item.py @@ -13,19 +13,17 @@ class SubscriptionGroupItem(object): """Implementation of the 'Subscription Group Item' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - reference (str): TODO: type description here. - product_id (int): TODO: type description here. - product_handle (str): TODO: type description here. - product_price_point_id (int): TODO: type description here. - product_price_point_handle (str): TODO: type description here. - currency (str): TODO: type description here. - coupon_code (str): TODO: type description here. - total_revenue_in_cents (long|int): TODO: type description here. - balance_in_cents (long|int): TODO: type description here. + id (int): The model property of type int. + reference (str): The model property of type str. + product_id (int): The model property of type int. + product_handle (str): The model property of type str. + product_price_point_id (int): The model property of type int. + product_price_point_handle (str): The model property of type str. + currency (str): The model property of type str. + coupon_code (str): The model property of type str. + total_revenue_in_cents (int): The model property of type int. + balance_in_cents (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -148,3 +146,31 @@ def from_dictionary(cls, total_revenue_in_cents, balance_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'reference={self.reference!r}, ' + f'product_id={self.product_id!r}, ' + f'product_handle={self.product_handle!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'product_price_point_handle={self.product_price_point_handle!r}, ' + f'currency={self.currency!r}, ' + f'coupon_code={self.coupon_code!r}, ' + f'total_revenue_in_cents={self.total_revenue_in_cents!r}, ' + f'balance_in_cents={self.balance_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'reference={self.reference!s}, ' + f'product_id={self.product_id!s}, ' + f'product_handle={self.product_handle!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'product_price_point_handle={self.product_price_point_handle!s}, ' + f'currency={self.currency!s}, ' + f'coupon_code={self.coupon_code!s}, ' + f'total_revenue_in_cents={self.total_revenue_in_cents!s}, ' + f'balance_in_cents={self.balance_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_members_array_error.py b/advancedbilling/models/subscription_group_members_array_error.py index 3cfbf5c0..c4175ae0 100644 --- a/advancedbilling/models/subscription_group_members_array_error.py +++ b/advancedbilling/models/subscription_group_members_array_error.py @@ -13,10 +13,8 @@ class SubscriptionGroupMembersArrayError(object): """Implementation of the 'Subscription Group Members Array Error' model. - TODO: type model description here. - Attributes: - members (List[str]): TODO: type description here. + members (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -89,3 +87,13 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('members'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'members={self.members!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'members={self.members!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_payment_profile.py b/advancedbilling/models/subscription_group_payment_profile.py index f7544c10..3f23b28c 100644 --- a/advancedbilling/models/subscription_group_payment_profile.py +++ b/advancedbilling/models/subscription_group_payment_profile.py @@ -13,13 +13,11 @@ class SubscriptionGroupPaymentProfile(object): """Implementation of the 'Subscription Group Payment Profile' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - masked_card_number (str): TODO: type description here. + id (int): The model property of type int. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + masked_card_number (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -94,3 +92,19 @@ def from_dictionary(cls, last_name, masked_card_number, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'masked_card_number={self.masked_card_number!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'masked_card_number={self.masked_card_number!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_prepayment.py b/advancedbilling/models/subscription_group_prepayment.py index 4b936081..c441e813 100644 --- a/advancedbilling/models/subscription_group_prepayment.py +++ b/advancedbilling/models/subscription_group_prepayment.py @@ -12,14 +12,12 @@ class SubscriptionGroupPrepayment(object): """Implementation of the 'Subscription Group Prepayment' model. - TODO: type model description here. - Attributes: - amount (int): TODO: type description here. - details (str): TODO: type description here. - memo (str): TODO: type description here. - method (SubscriptionGroupPrepaymentMethod): TODO: type description - here. + amount (int): The model property of type int. + details (str): The model property of type str. + memo (str): The model property of type str. + method (SubscriptionGroupPrepaymentMethod): The model property of type + SubscriptionGroupPrepaymentMethod. additional_properties (Dict[str, object]): The additional properties for the model. @@ -83,3 +81,19 @@ def from_dictionary(cls, memo, method, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!r}, ' + f'details={self.details!r}, ' + f'memo={self.memo!r}, ' + f'method={self.method!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'amount={self.amount!s}, ' + f'details={self.details!s}, ' + f'memo={self.memo!s}, ' + f'method={self.method!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_prepayment_method.py b/advancedbilling/models/subscription_group_prepayment_method.py index b6859093..246002c0 100644 --- a/advancedbilling/models/subscription_group_prepayment_method.py +++ b/advancedbilling/models/subscription_group_prepayment_method.py @@ -12,15 +12,13 @@ class SubscriptionGroupPrepaymentMethod(object): """Implementation of the 'Subscription Group Prepayment Method' enum. - TODO: type enum description here. - Attributes: - CHECK: TODO: type description here. - CASH: TODO: type description here. - MONEY_ORDER: TODO: type description here. - ACH: TODO: type description here. - PAYPAL_ACCOUNT: TODO: type description here. - OTHER: TODO: type description here. + CHECK: The enum member of type str. + CASH: The enum member of type str. + MONEY_ORDER: The enum member of type str. + ACH: The enum member of type str. + PAYPAL_ACCOUNT: The enum member of type str. + OTHER: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription_group_prepayment_request.py b/advancedbilling/models/subscription_group_prepayment_request.py index 32ef6125..a92ebb00 100644 --- a/advancedbilling/models/subscription_group_prepayment_request.py +++ b/advancedbilling/models/subscription_group_prepayment_request.py @@ -13,10 +13,9 @@ class SubscriptionGroupPrepaymentRequest(object): """Implementation of the 'Subscription Group Prepayment Request' model. - TODO: type model description here. - Attributes: - prepayment (SubscriptionGroupPrepayment): TODO: type description here. + prepayment (SubscriptionGroupPrepayment): The model property of type + SubscriptionGroupPrepayment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(prepayment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepayment={self.prepayment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepayment={self.prepayment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_prepayment_response.py b/advancedbilling/models/subscription_group_prepayment_response.py index bd72fd16..ab53ad21 100644 --- a/advancedbilling/models/subscription_group_prepayment_response.py +++ b/advancedbilling/models/subscription_group_prepayment_response.py @@ -13,12 +13,10 @@ class SubscriptionGroupPrepaymentResponse(object): """Implementation of the 'Subscription Group Prepayment Response' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - amount_in_cents (long|int): The amount in cents of the entry. - ending_balance_in_cents (long|int): The ending balance in cents of the + id (int): The model property of type int. + amount_in_cents (int): The amount in cents of the entry. + ending_balance_in_cents (int): The ending balance in cents of the account. entry_type (ServiceCreditType): The type of entry memo (str): A memo attached to the entry. @@ -107,3 +105,21 @@ def from_dictionary(cls, entry_type, memo, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'ending_balance_in_cents={self.ending_balance_in_cents!r}, ' + f'entry_type={self.entry_type!r}, ' + f'memo={self.memo!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'ending_balance_in_cents={self.ending_balance_in_cents!s}, ' + f'entry_type={self.entry_type!s}, ' + f'memo={self.memo!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_response.py b/advancedbilling/models/subscription_group_response.py index c713e8f2..2e7c12c1 100644 --- a/advancedbilling/models/subscription_group_response.py +++ b/advancedbilling/models/subscription_group_response.py @@ -13,10 +13,9 @@ class SubscriptionGroupResponse(object): """Implementation of the 'Subscription Group Response' model. - TODO: type model description here. - Attributes: - subscription_group (SubscriptionGroup): TODO: type description here. + subscription_group (SubscriptionGroup): The model property of type + SubscriptionGroup. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription_group, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_signup.py b/advancedbilling/models/subscription_group_signup.py index 7b11ac4e..7a907a06 100644 --- a/advancedbilling/models/subscription_group_signup.py +++ b/advancedbilling/models/subscription_group_signup.py @@ -17,24 +17,23 @@ class SubscriptionGroupSignup(object): """Implementation of the 'Subscription Group Signup' model. - TODO: type model description here. - Attributes: - payment_profile_id (int): TODO: type description here. - payer_id (int): TODO: type description here. - payer_reference (str): TODO: type description here. + payment_profile_id (int): The model property of type int. + payer_id (int): The model property of type int. + payer_reference (str): The model property of type str. payment_collection_method (CollectionMethod): The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For current Relationship Invoicing Architecture valid options are - `remittance`, `automatic`, `prepaid`. - payer_attributes (PayerAttributes): TODO: type description here. - credit_card_attributes (SubscriptionGroupCreditCard): TODO: type - description here. - bank_account_attributes (SubscriptionGroupBankAccount): TODO: type - description here. - subscriptions (List[SubscriptionGroupSignupItem]): TODO: type - description here. + payer_attributes (PayerAttributes): The model property of type + PayerAttributes. + credit_card_attributes (SubscriptionGroupCreditCard): The model + property of type SubscriptionGroupCreditCard. + bank_account_attributes (SubscriptionGroupBankAccount): The model + property of type SubscriptionGroupBankAccount. + subscriptions (List[SubscriptionGroupSignupItem]): The model property + of type List[SubscriptionGroupSignupItem]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -137,3 +136,27 @@ def from_dictionary(cls, credit_card_attributes, bank_account_attributes, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile_id={self.payment_profile_id!r}, ' + f'payer_id={self.payer_id!r}, ' + f'payer_reference={self.payer_reference!r}, ' + f'payment_collection_method={self.payment_collection_method!r}, ' + f'payer_attributes={self.payer_attributes!r}, ' + f'credit_card_attributes={self.credit_card_attributes!r}, ' + f'bank_account_attributes={self.bank_account_attributes!r}, ' + f'subscriptions={self.subscriptions!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile_id={self.payment_profile_id!s}, ' + f'payer_id={self.payer_id!s}, ' + f'payer_reference={self.payer_reference!s}, ' + f'payment_collection_method={self.payment_collection_method!s}, ' + f'payer_attributes={self.payer_attributes!s}, ' + f'credit_card_attributes={self.credit_card_attributes!s}, ' + f'bank_account_attributes={self.bank_account_attributes!s}, ' + f'subscriptions={self.subscriptions!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_signup_component.py b/advancedbilling/models/subscription_group_signup_component.py index b3b3878e..a8faeb7c 100644 --- a/advancedbilling/models/subscription_group_signup_component.py +++ b/advancedbilling/models/subscription_group_signup_component.py @@ -14,14 +14,15 @@ class SubscriptionGroupSignupComponent(object): """Implementation of the 'Subscription Group Signup Component' model. - TODO: type model description here. - Attributes: component_id (str | int | None): Required if passing any component to `components` attribute. - allocated_quantity (str | int | None): TODO: type description here. - unit_balance (str | int | None): TODO: type description here. - price_point_id (str | int | None): TODO: type description here. + allocated_quantity (str | int | None): The model property of type str + | int | None. + unit_balance (str | int | None): The model property of type str | int + | None. + price_point_id (str | int | None): The model property of type str | + int | None. custom_price (SubscriptionGroupComponentCustomPrice): Used in place of `price_point_id` to define a custom price point unique to the subscription. You still need to provide `component_id`. @@ -129,3 +130,21 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!r}, ' + f'allocated_quantity={self.allocated_quantity!r}, ' + f'unit_balance={self.unit_balance!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'custom_price={self.custom_price!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!s}, ' + f'allocated_quantity={self.allocated_quantity!s}, ' + f'unit_balance={self.unit_balance!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'custom_price={self.custom_price!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_signup_error.py b/advancedbilling/models/subscription_group_signup_error.py index 7740ae36..699987f7 100644 --- a/advancedbilling/models/subscription_group_signup_error.py +++ b/advancedbilling/models/subscription_group_signup_error.py @@ -15,17 +15,15 @@ class SubscriptionGroupSignupError(object): """Implementation of the 'Subscription Group Signup Error' model. - TODO: type model description here. - Attributes: subscriptions (Dict[str, SubscriptionGroupSubscriptionError]): Object that as key have subscription position in request subscriptions array and as value subscription errors object. - payer_reference (str): TODO: type description here. - payer (PayerError): TODO: type description here. - subscription_group (List[str]): TODO: type description here. - payment_profile_id (str): TODO: type description here. - payer_id (str): TODO: type description here. + payer_reference (str): The model property of type str. + payer (PayerError): The model property of type PayerError. + subscription_group (List[str]): The model property of type List[str]. + payment_profile_id (str): The model property of type str. + payer_id (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -114,3 +112,23 @@ def from_dictionary(cls, payment_profile_id, payer_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscriptions={self.subscriptions!r}, ' + f'payer_reference={self.payer_reference!r}, ' + f'payer={self.payer!r}, ' + f'subscription_group={self.subscription_group!r}, ' + f'payment_profile_id={self.payment_profile_id!r}, ' + f'payer_id={self.payer_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscriptions={self.subscriptions!s}, ' + f'payer_reference={self.payer_reference!s}, ' + f'payer={self.payer!s}, ' + f'subscription_group={self.subscription_group!s}, ' + f'payment_profile_id={self.payment_profile_id!s}, ' + f'payer_id={self.payer_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_signup_event_data.py b/advancedbilling/models/subscription_group_signup_event_data.py index da86b677..97725035 100644 --- a/advancedbilling/models/subscription_group_signup_event_data.py +++ b/advancedbilling/models/subscription_group_signup_event_data.py @@ -15,12 +15,10 @@ class SubscriptionGroupSignupEventData(object): """Implementation of the 'Subscription Group Signup Event Data' model. - TODO: type model description here. - Attributes: - subscription_group (SubscriptionGroupSignupFailureData): TODO: type - description here. - customer (Customer): TODO: type description here. + subscription_group (SubscriptionGroupSignupFailureData): The model + property of type SubscriptionGroupSignupFailureData. + customer (Customer): The model property of type Customer. additional_properties (Dict[str, object]): The additional properties for the model. @@ -112,3 +110,15 @@ def validate(cls, dictionary): type_callable=lambda value: Customer.validate(value), is_value_nullable=True, is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!r}, ' + f'customer={self.customer!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!s}, ' + f'customer={self.customer!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_signup_failure_data.py b/advancedbilling/models/subscription_group_signup_failure_data.py index b99ae1c8..e511a407 100644 --- a/advancedbilling/models/subscription_group_signup_failure_data.py +++ b/advancedbilling/models/subscription_group_signup_failure_data.py @@ -17,20 +17,19 @@ class SubscriptionGroupSignupFailureData(object): """Implementation of the 'Subscription Group Signup Failure Data' model. - TODO: type model description here. - Attributes: - payer_id (int): TODO: type description here. - payer_reference (str): TODO: type description here. - payment_profile_id (int): TODO: type description here. - payment_collection_method (str): TODO: type description here. - payer_attributes (PayerAttributes): TODO: type description here. - credit_card_attributes (SubscriptionGroupCreditCard): TODO: type - description here. - bank_account_attributes (SubscriptionGroupBankAccount): TODO: type - description here. - subscriptions (List[SubscriptionGroupSignupItem]): TODO: type - description here. + payer_id (int): The model property of type int. + payer_reference (str): The model property of type str. + payment_profile_id (int): The model property of type int. + payment_collection_method (str): The model property of type str. + payer_attributes (PayerAttributes): The model property of type + PayerAttributes. + credit_card_attributes (SubscriptionGroupCreditCard): The model + property of type SubscriptionGroupCreditCard. + bank_account_attributes (SubscriptionGroupBankAccount): The model + property of type SubscriptionGroupBankAccount. + subscriptions (List[SubscriptionGroupSignupItem]): The model property + of type List[SubscriptionGroupSignupItem]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -159,3 +158,27 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payer_id={self.payer_id!r}, ' + f'payer_reference={self.payer_reference!r}, ' + f'payment_profile_id={self.payment_profile_id!r}, ' + f'payment_collection_method={self.payment_collection_method!r}, ' + f'payer_attributes={self.payer_attributes!r}, ' + f'credit_card_attributes={self.credit_card_attributes!r}, ' + f'bank_account_attributes={self.bank_account_attributes!r}, ' + f'subscriptions={self.subscriptions!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payer_id={self.payer_id!s}, ' + f'payer_reference={self.payer_reference!s}, ' + f'payment_profile_id={self.payment_profile_id!s}, ' + f'payment_collection_method={self.payment_collection_method!s}, ' + f'payer_attributes={self.payer_attributes!s}, ' + f'credit_card_attributes={self.credit_card_attributes!s}, ' + f'bank_account_attributes={self.bank_account_attributes!s}, ' + f'subscriptions={self.subscriptions!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_signup_item.py b/advancedbilling/models/subscription_group_signup_item.py index f46e14c2..9cc2c573 100644 --- a/advancedbilling/models/subscription_group_signup_item.py +++ b/advancedbilling/models/subscription_group_signup_item.py @@ -16,8 +16,6 @@ class SubscriptionGroupSignupItem(object): """Implementation of the 'Subscription Group Signup Item' model. - TODO: type model description here. - Attributes: product_handle (str): The API Handle of the product for which you are creating a subscription. Required, unless a `product_id` is given @@ -43,8 +41,8 @@ class SubscriptionGroupSignupItem(object): update the currency of an existing subscription. coupon_codes (List[str]): An array for all the coupons attached to the subscription. - components (List[SubscriptionGroupSignupComponent]): TODO: type - description here. + components (List[SubscriptionGroupSignupComponent]): The model + property of type List[SubscriptionGroupSignupComponent]. custom_price (SubscriptionCustomPrice): (Optional) Used in place of `product_price_point_id` to define a custom price point unique to the subscription @@ -217,3 +215,37 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_handle={self.product_handle!r}, ' + f'product_id={self.product_id!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'product_price_point_handle={self.product_price_point_handle!r}, ' + f'offer_id={self.offer_id!r}, ' + f'reference={self.reference!r}, ' + f'primary={self.primary!r}, ' + f'currency={self.currency!r}, ' + f'coupon_codes={self.coupon_codes!r}, ' + f'components={self.components!r}, ' + f'custom_price={self.custom_price!r}, ' + f'calendar_billing={self.calendar_billing!r}, ' + f'metafields={self.metafields!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_handle={self.product_handle!s}, ' + f'product_id={self.product_id!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'product_price_point_handle={self.product_price_point_handle!s}, ' + f'offer_id={self.offer_id!s}, ' + f'reference={self.reference!s}, ' + f'primary={self.primary!s}, ' + f'currency={self.currency!s}, ' + f'coupon_codes={self.coupon_codes!s}, ' + f'components={self.components!s}, ' + f'custom_price={self.custom_price!s}, ' + f'calendar_billing={self.calendar_billing!s}, ' + f'metafields={self.metafields!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_signup_request.py b/advancedbilling/models/subscription_group_signup_request.py index 7d24b42d..96f8ef5f 100644 --- a/advancedbilling/models/subscription_group_signup_request.py +++ b/advancedbilling/models/subscription_group_signup_request.py @@ -13,11 +13,9 @@ class SubscriptionGroupSignupRequest(object): """Implementation of the 'Subscription Group Signup Request' model. - TODO: type model description here. - Attributes: - subscription_group (SubscriptionGroupSignup): TODO: type description - here. + subscription_group (SubscriptionGroupSignup): The model property of + type SubscriptionGroupSignup. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription_group, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_signup_response.py b/advancedbilling/models/subscription_group_signup_response.py index c2e31fba..517c249c 100644 --- a/advancedbilling/models/subscription_group_signup_response.py +++ b/advancedbilling/models/subscription_group_signup_response.py @@ -14,16 +14,14 @@ class SubscriptionGroupSignupResponse(object): """Implementation of the 'Subscription Group Signup Response' model. - TODO: type model description here. - Attributes: - uid (str): TODO: type description here. - scheme (int): TODO: type description here. - customer_id (int): TODO: type description here. - payment_profile_id (int): TODO: type description here. - subscription_ids (List[int]): TODO: type description here. - primary_subscription_id (int): TODO: type description here. - next_assessment_at (datetime): TODO: type description here. + uid (str): The model property of type str. + scheme (int): The model property of type int. + customer_id (int): The model property of type int. + payment_profile_id (int): The model property of type int. + subscription_ids (List[int]): The model property of type List[int]. + primary_subscription_id (int): The model property of type int. + next_assessment_at (datetime): The model property of type datetime. state (SubscriptionState): The state of a subscription. * **Live States** * `active` - A normal, active subscription. It is not in a trial and is paid and up to date. * `assessing` - An @@ -89,9 +87,9 @@ class SubscriptionGroupSignupResponse(object): States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853- Subscription-States) for more info about subscription states and state transitions. - cancel_at_end_of_period (bool): TODO: type description here. - subscriptions (List[SubscriptionGroupItem]): TODO: type description - here. + cancel_at_end_of_period (bool): The model property of type bool. + subscriptions (List[SubscriptionGroupItem]): The model property of + type List[SubscriptionGroupItem]. payment_collection_method (CollectionMethod): The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For @@ -224,3 +222,33 @@ def from_dictionary(cls, subscriptions, payment_collection_method, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!r}, ' + f'scheme={self.scheme!r}, ' + f'customer_id={self.customer_id!r}, ' + f'payment_profile_id={self.payment_profile_id!r}, ' + f'subscription_ids={self.subscription_ids!r}, ' + f'primary_subscription_id={self.primary_subscription_id!r}, ' + f'next_assessment_at={self.next_assessment_at!r}, ' + f'state={self.state!r}, ' + f'cancel_at_end_of_period={self.cancel_at_end_of_period!r}, ' + f'subscriptions={self.subscriptions!r}, ' + f'payment_collection_method={self.payment_collection_method!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'uid={self.uid!s}, ' + f'scheme={self.scheme!s}, ' + f'customer_id={self.customer_id!s}, ' + f'payment_profile_id={self.payment_profile_id!s}, ' + f'subscription_ids={self.subscription_ids!s}, ' + f'primary_subscription_id={self.primary_subscription_id!s}, ' + f'next_assessment_at={self.next_assessment_at!s}, ' + f'state={self.state!s}, ' + f'cancel_at_end_of_period={self.cancel_at_end_of_period!s}, ' + f'subscriptions={self.subscriptions!s}, ' + f'payment_collection_method={self.payment_collection_method!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_single_error.py b/advancedbilling/models/subscription_group_single_error.py index 067379cb..fa1f6f3e 100644 --- a/advancedbilling/models/subscription_group_single_error.py +++ b/advancedbilling/models/subscription_group_single_error.py @@ -13,10 +13,8 @@ class SubscriptionGroupSingleError(object): """Implementation of the 'Subscription Group Single Error' model. - TODO: type model description here. - Attributes: - subscription_group (str): TODO: type description here. + subscription_group (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -89,3 +87,13 @@ def validate(cls, dictionary): return APIHelper.is_valid_type(value=dictionary.get('subscription_group'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_subscription_error.py b/advancedbilling/models/subscription_group_subscription_error.py index b38ab3e6..7f3b6c15 100644 --- a/advancedbilling/models/subscription_group_subscription_error.py +++ b/advancedbilling/models/subscription_group_subscription_error.py @@ -16,17 +16,19 @@ class SubscriptionGroupSubscriptionError(object): Object which contains subscription errors. Attributes: - product (List[str]): TODO: type description here. - product_price_point_id (List[str]): TODO: type description here. - payment_profile (List[str]): TODO: type description here. - payment_profile_chargify_token (List[str]): TODO: type description - here. - base (List[str]): TODO: type description here. - payment_profile_expiration_month (List[str]): TODO: type description - here. - payment_profile_expiration_year (List[str]): TODO: type description - here. - payment_profile_full_number (List[str]): TODO: type description here. + product (List[str]): The model property of type List[str]. + product_price_point_id (List[str]): The model property of type + List[str]. + payment_profile (List[str]): The model property of type List[str]. + payment_profile_chargify_token (List[str]): The model property of type + List[str]. + base (List[str]): The model property of type List[str]. + payment_profile_expiration_month (List[str]): The model property of + type List[str]. + payment_profile_expiration_year (List[str]): The model property of + type List[str]. + payment_profile_full_number (List[str]): The model property of type + List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -129,3 +131,27 @@ def from_dictionary(cls, payment_profile_expiration_year, payment_profile_full_number, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product={self.product!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'payment_profile={self.payment_profile!r}, ' + f'payment_profile_chargify_token={self.payment_profile_chargify_token!r}, ' + f'base={self.base!r}, ' + f'payment_profile_expiration_month={self.payment_profile_expiration_month!r}, ' + f'payment_profile_expiration_year={self.payment_profile_expiration_year!r}, ' + f'payment_profile_full_number={self.payment_profile_full_number!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product={self.product!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'payment_profile={self.payment_profile!s}, ' + f'payment_profile_chargify_token={self.payment_profile_chargify_token!s}, ' + f'base={self.base!s}, ' + f'payment_profile_expiration_month={self.payment_profile_expiration_month!s}, ' + f'payment_profile_expiration_year={self.payment_profile_expiration_year!s}, ' + f'payment_profile_full_number={self.payment_profile_full_number!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_group_update_error.py b/advancedbilling/models/subscription_group_update_error.py index b80df3cc..a48f2400 100644 --- a/advancedbilling/models/subscription_group_update_error.py +++ b/advancedbilling/models/subscription_group_update_error.py @@ -13,10 +13,8 @@ class SubscriptionGroupUpdateError(object): """Implementation of the 'Subscription Group Update Error' model. - TODO: type model description here. - Attributes: - members (List[str]): TODO: type description here. + members (List[str]): The model property of type List[str]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(members, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'members={self.members!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'members={self.members!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_groups_list_include.py b/advancedbilling/models/subscription_groups_list_include.py index 9cd343c6..7a964727 100644 --- a/advancedbilling/models/subscription_groups_list_include.py +++ b/advancedbilling/models/subscription_groups_list_include.py @@ -12,10 +12,8 @@ class SubscriptionGroupsListInclude(object): """Implementation of the 'Subscription Groups List Include' enum. - TODO: type enum description here. - Attributes: - ACCOUNT_BALANCES: TODO: type description here. + ACCOUNT_BALANCES: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription_include.py b/advancedbilling/models/subscription_include.py index 9cb45403..ea494b9b 100644 --- a/advancedbilling/models/subscription_include.py +++ b/advancedbilling/models/subscription_include.py @@ -12,11 +12,9 @@ class SubscriptionInclude(object): """Implementation of the 'Subscription Include' enum. - TODO: type enum description here. - Attributes: - COUPONS: TODO: type description here. - SELF_SERVICE_PAGE_TOKEN: TODO: type description here. + COUPONS: The enum member of type str. + SELF_SERVICE_PAGE_TOKEN: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription_included_coupon.py b/advancedbilling/models/subscription_included_coupon.py index 5dc85e06..cb58f44d 100644 --- a/advancedbilling/models/subscription_included_coupon.py +++ b/advancedbilling/models/subscription_included_coupon.py @@ -13,16 +13,14 @@ class SubscriptionIncludedCoupon(object): """Implementation of the 'Subscription Included Coupon' model. - TODO: type model description here. - Attributes: - code (str): TODO: type description here. - use_count (int): TODO: type description here. - uses_allowed (int): TODO: type description here. - expires_at (str): TODO: type description here. - recurring (bool): TODO: type description here. - amount_in_cents (long|int): TODO: type description here. - percentage (str): TODO: type description here. + code (str): The model property of type str. + use_count (int): The model property of type int. + uses_allowed (int): The model property of type int. + expires_at (str): The model property of type str. + recurring (bool): The model property of type bool. + amount_in_cents (int): The model property of type int. + percentage (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -124,3 +122,25 @@ def from_dictionary(cls, amount_in_cents, percentage, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'code={self.code!r}, ' + f'use_count={self.use_count!r}, ' + f'uses_allowed={self.uses_allowed!r}, ' + f'expires_at={self.expires_at!r}, ' + f'recurring={self.recurring!r}, ' + f'amount_in_cents={self.amount_in_cents!r}, ' + f'percentage={self.percentage!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'code={self.code!s}, ' + f'use_count={self.use_count!s}, ' + f'uses_allowed={self.uses_allowed!s}, ' + f'expires_at={self.expires_at!s}, ' + f'recurring={self.recurring!s}, ' + f'amount_in_cents={self.amount_in_cents!s}, ' + f'percentage={self.percentage!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_list_date_field.py b/advancedbilling/models/subscription_list_date_field.py index 2005faf3..836f91c6 100644 --- a/advancedbilling/models/subscription_list_date_field.py +++ b/advancedbilling/models/subscription_list_date_field.py @@ -12,10 +12,8 @@ class SubscriptionListDateField(object): """Implementation of the 'Subscription List Date Field' enum. - TODO: type enum description here. - Attributes: - UPDATED_AT: TODO: type description here. + UPDATED_AT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription_list_include.py b/advancedbilling/models/subscription_list_include.py index 77f60cbb..3883a552 100644 --- a/advancedbilling/models/subscription_list_include.py +++ b/advancedbilling/models/subscription_list_include.py @@ -12,10 +12,8 @@ class SubscriptionListInclude(object): """Implementation of the 'Subscription List Include' enum. - TODO: type enum description here. - Attributes: - SELF_SERVICE_PAGE_TOKEN: TODO: type description here. + SELF_SERVICE_PAGE_TOKEN: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription_migration_preview.py b/advancedbilling/models/subscription_migration_preview.py index 323b7b87..5b1083db 100644 --- a/advancedbilling/models/subscription_migration_preview.py +++ b/advancedbilling/models/subscription_migration_preview.py @@ -13,18 +13,16 @@ class SubscriptionMigrationPreview(object): """Implementation of the 'Subscription Migration Preview' model. - TODO: type model description here. - Attributes: - prorated_adjustment_in_cents (long|int): The amount of the prorated + prorated_adjustment_in_cents (int): The amount of the prorated adjustment that would be issued for the current subscription. - charge_in_cents (long|int): The amount of the charge that would be - created for the new product. - payment_due_in_cents (long|int): The amount of the payment due in the - case of an upgrade. - credit_applied_in_cents (long|int): Represents a credit in cents that - is applied to your subscription as part of a migration process for - a specific product, which reduces the amount owed for the + charge_in_cents (int): The amount of the charge that would be created + for the new product. + payment_due_in_cents (int): The amount of the payment due in the case + of an upgrade. + credit_applied_in_cents (int): Represents a credit in cents that is + applied to your subscription as part of a migration process for a + specific product, which reduces the amount owed for the subscription. additional_properties (Dict[str, object]): The additional properties for the model. @@ -100,3 +98,19 @@ def from_dictionary(cls, payment_due_in_cents, credit_applied_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prorated_adjustment_in_cents={self.prorated_adjustment_in_cents!r}, ' + f'charge_in_cents={self.charge_in_cents!r}, ' + f'payment_due_in_cents={self.payment_due_in_cents!r}, ' + f'credit_applied_in_cents={self.credit_applied_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prorated_adjustment_in_cents={self.prorated_adjustment_in_cents!s}, ' + f'charge_in_cents={self.charge_in_cents!s}, ' + f'payment_due_in_cents={self.payment_due_in_cents!s}, ' + f'credit_applied_in_cents={self.credit_applied_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_migration_preview_options.py b/advancedbilling/models/subscription_migration_preview_options.py index 936235d1..cbaf4c57 100644 --- a/advancedbilling/models/subscription_migration_preview_options.py +++ b/advancedbilling/models/subscription_migration_preview_options.py @@ -14,8 +14,6 @@ class SubscriptionMigrationPreviewOptions(object): """Implementation of the 'Subscription Migration Preview Options' model. - TODO: type model description here. - Attributes: product_id (int): The ID of the target Product. Either a product_id or product_handle must be present. A Subscription can be migrated to @@ -47,7 +45,7 @@ class SubscriptionMigrationPreviewOptions(object): product_price_point_handle (str): The ID or handle of the specified product's price point. This can be passed to migrate to a non-default price point. - proration (Proration): TODO: type description here. + proration (Proration): The model property of type Proration. proration_date (datetime): The date that the proration is calculated from for the preview additional_properties (Dict[str, object]): The additional properties @@ -162,3 +160,31 @@ def from_dictionary(cls, proration, proration_date, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_id={self.product_id!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'include_trial={self.include_trial!r}, ' + f'include_initial_charge={self.include_initial_charge!r}, ' + f'include_coupons={self.include_coupons!r}, ' + f'preserve_period={self.preserve_period!r}, ' + f'product_handle={self.product_handle!r}, ' + f'product_price_point_handle={self.product_price_point_handle!r}, ' + f'proration={self.proration!r}, ' + f'proration_date={self.proration_date!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_id={self.product_id!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'include_trial={self.include_trial!s}, ' + f'include_initial_charge={self.include_initial_charge!s}, ' + f'include_coupons={self.include_coupons!s}, ' + f'preserve_period={self.preserve_period!s}, ' + f'product_handle={self.product_handle!s}, ' + f'product_price_point_handle={self.product_price_point_handle!s}, ' + f'proration={self.proration!s}, ' + f'proration_date={self.proration_date!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_migration_preview_request.py b/advancedbilling/models/subscription_migration_preview_request.py index 750a1cbc..520ef521 100644 --- a/advancedbilling/models/subscription_migration_preview_request.py +++ b/advancedbilling/models/subscription_migration_preview_request.py @@ -13,11 +13,9 @@ class SubscriptionMigrationPreviewRequest(object): """Implementation of the 'Subscription Migration Preview Request' model. - TODO: type model description here. - Attributes: - migration (SubscriptionMigrationPreviewOptions): TODO: type - description here. + migration (SubscriptionMigrationPreviewOptions): The model property of + type SubscriptionMigrationPreviewOptions. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(migration, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'migration={self.migration!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'migration={self.migration!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_migration_preview_response.py b/advancedbilling/models/subscription_migration_preview_response.py index cbd73226..1a8c16c6 100644 --- a/advancedbilling/models/subscription_migration_preview_response.py +++ b/advancedbilling/models/subscription_migration_preview_response.py @@ -13,10 +13,9 @@ class SubscriptionMigrationPreviewResponse(object): """Implementation of the 'Subscription Migration Preview Response' model. - TODO: type model description here. - Attributes: - migration (SubscriptionMigrationPreview): TODO: type description here. + migration (SubscriptionMigrationPreview): The model property of type + SubscriptionMigrationPreview. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(migration, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'migration={self.migration!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'migration={self.migration!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_mrr.py b/advancedbilling/models/subscription_mrr.py index 66b02f49..55b7f807 100644 --- a/advancedbilling/models/subscription_mrr.py +++ b/advancedbilling/models/subscription_mrr.py @@ -14,12 +14,11 @@ class SubscriptionMRR(object): """Implementation of the 'Subscription MRR' model. - TODO: type model description here. - Attributes: - subscription_id (int): TODO: type description here. - mrr_amount_in_cents (long|int): TODO: type description here. - breakouts (SubscriptionMRRBreakout): TODO: type description here. + subscription_id (int): The model property of type int. + mrr_amount_in_cents (int): The model property of type int. + breakouts (SubscriptionMRRBreakout): The model property of type + SubscriptionMRRBreakout. additional_properties (Dict[str, object]): The additional properties for the model. @@ -83,3 +82,17 @@ def from_dictionary(cls, mrr_amount_in_cents, breakouts, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_id={self.subscription_id!r}, ' + f'mrr_amount_in_cents={self.mrr_amount_in_cents!r}, ' + f'breakouts={self.breakouts!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_id={self.subscription_id!s}, ' + f'mrr_amount_in_cents={self.mrr_amount_in_cents!s}, ' + f'breakouts={self.breakouts!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_mrr_breakout.py b/advancedbilling/models/subscription_mrr_breakout.py index 4d56f28f..8c7aad69 100644 --- a/advancedbilling/models/subscription_mrr_breakout.py +++ b/advancedbilling/models/subscription_mrr_breakout.py @@ -12,11 +12,9 @@ class SubscriptionMRRBreakout(object): """Implementation of the 'Subscription MRR Breakout' model. - TODO: type model description here. - Attributes: - plan_amount_in_cents (long|int): TODO: type description here. - usage_amount_in_cents (long|int): TODO: type description here. + plan_amount_in_cents (int): The model property of type int. + usage_amount_in_cents (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,15 @@ def from_dictionary(cls, return cls(plan_amount_in_cents, usage_amount_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'plan_amount_in_cents={self.plan_amount_in_cents!r}, ' + f'usage_amount_in_cents={self.usage_amount_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'plan_amount_in_cents={self.plan_amount_in_cents!s}, ' + f'usage_amount_in_cents={self.usage_amount_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_mrr_response.py b/advancedbilling/models/subscription_mrr_response.py index cf17369d..30b0fd73 100644 --- a/advancedbilling/models/subscription_mrr_response.py +++ b/advancedbilling/models/subscription_mrr_response.py @@ -13,10 +13,9 @@ class SubscriptionMRRResponse(object): """Implementation of the 'Subscription MRR Response' model. - TODO: type model description here. - Attributes: - subscriptions_mrr (List[SubscriptionMRR]): TODO: type description here. + subscriptions_mrr (List[SubscriptionMRR]): The model property of type + List[SubscriptionMRR]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -67,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscriptions_mrr, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscriptions_mrr={self.subscriptions_mrr!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscriptions_mrr={self.subscriptions_mrr!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_note.py b/advancedbilling/models/subscription_note.py index df796f01..5eb40f92 100644 --- a/advancedbilling/models/subscription_note.py +++ b/advancedbilling/models/subscription_note.py @@ -13,15 +13,13 @@ class SubscriptionNote(object): """Implementation of the 'Subscription Note' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - body (str): TODO: type description here. - subscription_id (int): TODO: type description here. - created_at (datetime): TODO: type description here. - updated_at (datetime): TODO: type description here. - sticky (bool): TODO: type description here. + id (int): The model property of type int. + body (str): The model property of type str. + subscription_id (int): The model property of type int. + created_at (datetime): The model property of type datetime. + updated_at (datetime): The model property of type datetime. + sticky (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -110,3 +108,23 @@ def from_dictionary(cls, updated_at, sticky, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'body={self.body!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'created_at={self.created_at!r}, ' + f'updated_at={self.updated_at!r}, ' + f'sticky={self.sticky!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'body={self.body!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'created_at={self.created_at!s}, ' + f'updated_at={self.updated_at!s}, ' + f'sticky={self.sticky!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_note_response.py b/advancedbilling/models/subscription_note_response.py index 1eb6e790..ae6d2670 100644 --- a/advancedbilling/models/subscription_note_response.py +++ b/advancedbilling/models/subscription_note_response.py @@ -13,10 +13,8 @@ class SubscriptionNoteResponse(object): """Implementation of the 'Subscription Note Response' model. - TODO: type model description here. - Attributes: - note (SubscriptionNote): TODO: type description here. + note (SubscriptionNote): The model property of type SubscriptionNote. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(note, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'note={self.note!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'note={self.note!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_preview.py b/advancedbilling/models/subscription_preview.py index b0fd248f..6b1b9e74 100644 --- a/advancedbilling/models/subscription_preview.py +++ b/advancedbilling/models/subscription_preview.py @@ -14,12 +14,11 @@ class SubscriptionPreview(object): """Implementation of the 'Subscription Preview' model. - TODO: type model description here. - Attributes: - current_billing_manifest (BillingManifest): TODO: type description - here. - next_billing_manifest (BillingManifest): TODO: type description here. + current_billing_manifest (BillingManifest): The model property of type + BillingManifest. + next_billing_manifest (BillingManifest): The model property of type + BillingManifest. additional_properties (Dict[str, object]): The additional properties for the model. @@ -80,3 +79,15 @@ def from_dictionary(cls, return cls(current_billing_manifest, next_billing_manifest, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'current_billing_manifest={self.current_billing_manifest!r}, ' + f'next_billing_manifest={self.next_billing_manifest!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'current_billing_manifest={self.current_billing_manifest!s}, ' + f'next_billing_manifest={self.next_billing_manifest!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_preview_response.py b/advancedbilling/models/subscription_preview_response.py index 4ae90968..609a61ce 100644 --- a/advancedbilling/models/subscription_preview_response.py +++ b/advancedbilling/models/subscription_preview_response.py @@ -13,11 +13,9 @@ class SubscriptionPreviewResponse(object): """Implementation of the 'Subscription Preview Response' model. - TODO: type model description here. - Attributes: - subscription_preview (SubscriptionPreview): TODO: type description - here. + subscription_preview (SubscriptionPreview): The model property of type + SubscriptionPreview. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription_preview, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_preview={self.subscription_preview!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_preview={self.subscription_preview!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_product_change.py b/advancedbilling/models/subscription_product_change.py index a4b9463c..845b7f8f 100644 --- a/advancedbilling/models/subscription_product_change.py +++ b/advancedbilling/models/subscription_product_change.py @@ -13,11 +13,9 @@ class SubscriptionProductChange(object): """Implementation of the 'Subscription Product Change' model. - TODO: type model description here. - Attributes: - previous_product_id (int): TODO: type description here. - new_product_id (int): TODO: type description here. + previous_product_id (int): The model property of type int. + new_product_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -99,3 +97,15 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, int)) \ and APIHelper.is_valid_type(value=dictionary.get('new_product_id'), type_callable=lambda value: isinstance(value, int)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'previous_product_id={self.previous_product_id!r}, ' + f'new_product_id={self.new_product_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'previous_product_id={self.previous_product_id!s}, ' + f'new_product_id={self.new_product_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_product_migration.py b/advancedbilling/models/subscription_product_migration.py index 40a9ffec..6dfcae42 100644 --- a/advancedbilling/models/subscription_product_migration.py +++ b/advancedbilling/models/subscription_product_migration.py @@ -14,8 +14,6 @@ class SubscriptionProductMigration(object): """Implementation of the 'Subscription Product Migration' model. - TODO: type model description here. - Attributes: product_id (int): The ID of the target Product. Either a product_id or product_handle must be present. A Subscription can be migrated to @@ -47,7 +45,7 @@ class SubscriptionProductMigration(object): product_price_point_handle (str): The ID or handle of the specified product's price point. This can be passed to migrate to a non-default price point. - proration (Proration): TODO: type description here. + proration (Proration): The model property of type Proration. additional_properties (Dict[str, object]): The additional properties for the model. @@ -153,3 +151,29 @@ def from_dictionary(cls, product_price_point_handle, proration, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_id={self.product_id!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'include_trial={self.include_trial!r}, ' + f'include_initial_charge={self.include_initial_charge!r}, ' + f'include_coupons={self.include_coupons!r}, ' + f'preserve_period={self.preserve_period!r}, ' + f'product_handle={self.product_handle!r}, ' + f'product_price_point_handle={self.product_price_point_handle!r}, ' + f'proration={self.proration!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_id={self.product_id!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'include_trial={self.include_trial!s}, ' + f'include_initial_charge={self.include_initial_charge!s}, ' + f'include_coupons={self.include_coupons!s}, ' + f'preserve_period={self.preserve_period!s}, ' + f'product_handle={self.product_handle!s}, ' + f'product_price_point_handle={self.product_price_point_handle!s}, ' + f'proration={self.proration!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_product_migration_request.py b/advancedbilling/models/subscription_product_migration_request.py index 6949ed31..0b1ca7c2 100644 --- a/advancedbilling/models/subscription_product_migration_request.py +++ b/advancedbilling/models/subscription_product_migration_request.py @@ -13,10 +13,9 @@ class SubscriptionProductMigrationRequest(object): """Implementation of the 'Subscription Product Migration Request' model. - TODO: type model description here. - Attributes: - migration (SubscriptionProductMigration): TODO: type description here. + migration (SubscriptionProductMigration): The model property of type + SubscriptionProductMigration. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(migration, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'migration={self.migration!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'migration={self.migration!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_purge_type.py b/advancedbilling/models/subscription_purge_type.py index f04c74b6..4f88038d 100644 --- a/advancedbilling/models/subscription_purge_type.py +++ b/advancedbilling/models/subscription_purge_type.py @@ -12,11 +12,9 @@ class SubscriptionPurgeType(object): """Implementation of the 'Subscription Purge Type' enum. - TODO: type enum description here. - Attributes: - CUSTOMER: TODO: type description here. - PAYMENT_PROFILE: TODO: type description here. + CUSTOMER: The enum member of type str. + PAYMENT_PROFILE: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription_response.py b/advancedbilling/models/subscription_response.py index 84f613f4..430253da 100644 --- a/advancedbilling/models/subscription_response.py +++ b/advancedbilling/models/subscription_response.py @@ -14,10 +14,8 @@ class SubscriptionResponse(object): """Implementation of the 'Subscription Response' model. - TODO: type model description here. - Attributes: - subscription (Subscription): TODO: type description here. + subscription (Subscription): The model property of type Subscription. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_sort.py b/advancedbilling/models/subscription_sort.py index 6f206528..e0786afd 100644 --- a/advancedbilling/models/subscription_sort.py +++ b/advancedbilling/models/subscription_sort.py @@ -12,15 +12,13 @@ class SubscriptionSort(object): """Implementation of the 'Subscription Sort' enum. - TODO: type enum description here. - Attributes: - SIGNUP_DATE: TODO: type description here. - PERIOD_START: TODO: type description here. - PERIOD_END: TODO: type description here. - NEXT_ASSESSMENT: TODO: type description here. - UPDATED_AT: TODO: type description here. - CREATED_AT: TODO: type description here. + SIGNUP_DATE: The enum member of type str. + PERIOD_START: The enum member of type str. + PERIOD_END: The enum member of type str. + NEXT_ASSESSMENT: The enum member of type str. + UPDATED_AT: The enum member of type str. + CREATED_AT: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription_state.py b/advancedbilling/models/subscription_state.py index 0a9fee93..d7065485 100644 --- a/advancedbilling/models/subscription_state.py +++ b/advancedbilling/models/subscription_state.py @@ -85,21 +85,21 @@ class SubscriptionState(object): tion-States) for more info about subscription states and state transitions. Attributes: - PENDING: TODO: type description here. - FAILED_TO_CREATE: TODO: type description here. - TRIALING: TODO: type description here. - ASSESSING: TODO: type description here. - ACTIVE: TODO: type description here. - SOFT_FAILURE: TODO: type description here. - PAST_DUE: TODO: type description here. - SUSPENDED: TODO: type description here. - CANCELED: TODO: type description here. - EXPIRED: TODO: type description here. - PAUSED: TODO: type description here. - UNPAID: TODO: type description here. - TRIAL_ENDED: TODO: type description here. - ON_HOLD: TODO: type description here. - AWAITING_SIGNUP: TODO: type description here. + PENDING: The enum member of type str. + FAILED_TO_CREATE: The enum member of type str. + TRIALING: The enum member of type str. + ASSESSING: The enum member of type str. + ACTIVE: The enum member of type str. + SOFT_FAILURE: The enum member of type str. + PAST_DUE: The enum member of type str. + SUSPENDED: The enum member of type str. + CANCELED: The enum member of type str. + EXPIRED: The enum member of type str. + PAUSED: The enum member of type str. + UNPAID: The enum member of type str. + TRIAL_ENDED: The enum member of type str. + ON_HOLD: The enum member of type str. + AWAITING_SIGNUP: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/subscription_state_change.py b/advancedbilling/models/subscription_state_change.py index 5faf1235..e916ed93 100644 --- a/advancedbilling/models/subscription_state_change.py +++ b/advancedbilling/models/subscription_state_change.py @@ -13,11 +13,9 @@ class SubscriptionStateChange(object): """Implementation of the 'Subscription State Change' model. - TODO: type model description here. - Attributes: - previous_subscription_state (str): TODO: type description here. - new_subscription_state (str): TODO: type description here. + previous_subscription_state (str): The model property of type str. + new_subscription_state (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -99,3 +97,15 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('new_subscription_state'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'previous_subscription_state={self.previous_subscription_state!r}, ' + f'new_subscription_state={self.new_subscription_state!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'previous_subscription_state={self.previous_subscription_state!s}, ' + f'new_subscription_state={self.new_subscription_state!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/subscription_state_filter.py b/advancedbilling/models/subscription_state_filter.py index 63003ce0..481b22ea 100644 --- a/advancedbilling/models/subscription_state_filter.py +++ b/advancedbilling/models/subscription_state_filter.py @@ -15,18 +15,18 @@ class SubscriptionStateFilter(object): Allowed values for filtering by the current state of the subscription. Attributes: - ACTIVE: TODO: type description here. - CANCELED: TODO: type description here. - EXPIRED: TODO: type description here. - EXPIRED_CARDS: TODO: type description here. - ON_HOLD: TODO: type description here. - PAST_DUE: TODO: type description here. - PENDING_CANCELLATION: TODO: type description here. - PENDING_RENEWAL: TODO: type description here. - SUSPENDED: TODO: type description here. - TRIAL_ENDED: TODO: type description here. - TRIALING: TODO: type description here. - UNPAID: TODO: type description here. + ACTIVE: The enum member of type str. + CANCELED: The enum member of type str. + EXPIRED: The enum member of type str. + EXPIRED_CARDS: The enum member of type str. + ON_HOLD: The enum member of type str. + PAST_DUE: The enum member of type str. + PENDING_CANCELLATION: The enum member of type str. + PENDING_RENEWAL: The enum member of type str. + SUSPENDED: The enum member of type str. + TRIAL_ENDED: The enum member of type str. + TRIALING: The enum member of type str. + UNPAID: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/tax_configuration.py b/advancedbilling/models/tax_configuration.py index 3fd8e691..0a6c6950 100644 --- a/advancedbilling/models/tax_configuration.py +++ b/advancedbilling/models/tax_configuration.py @@ -13,12 +13,11 @@ class TaxConfiguration(object): """Implementation of the 'Tax Configuration' model. - TODO: type model description here. - Attributes: - kind (TaxConfigurationKind): TODO: type description here. - destination_address (TaxDestinationAddress): TODO: type description - here. + kind (TaxConfigurationKind): The model property of type + TaxConfigurationKind. + destination_address (TaxDestinationAddress): The model property of + type TaxDestinationAddress. fully_configured (bool): Returns `true` when Chargify has been properly configured to charge tax using the specified tax system. More details about taxes: @@ -89,3 +88,17 @@ def from_dictionary(cls, destination_address, fully_configured, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'kind={self.kind!r}, ' + f'destination_address={self.destination_address!r}, ' + f'fully_configured={self.fully_configured!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'kind={self.kind!s}, ' + f'destination_address={self.destination_address!s}, ' + f'fully_configured={self.fully_configured!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/tax_configuration_kind.py b/advancedbilling/models/tax_configuration_kind.py index d346fbdf..abb4af56 100644 --- a/advancedbilling/models/tax_configuration_kind.py +++ b/advancedbilling/models/tax_configuration_kind.py @@ -12,13 +12,11 @@ class TaxConfigurationKind(object): """Implementation of the 'Tax Configuration Kind' enum. - TODO: type enum description here. - Attributes: - CUSTOM: TODO: type description here. - ENUM_MANAGED AVALARA: TODO: type description here. - ENUM_LINKED AVALARA: TODO: type description here. - ENUM_DIGITAL RIVER: TODO: type description here. + CUSTOM: The enum member of type str. + ENUM_MANAGED AVALARA: The enum member of type str. + ENUM_LINKED AVALARA: The enum member of type str. + ENUM_DIGITAL RIVER: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/tax_destination_address.py b/advancedbilling/models/tax_destination_address.py index 595d141f..1cb04bb9 100644 --- a/advancedbilling/models/tax_destination_address.py +++ b/advancedbilling/models/tax_destination_address.py @@ -12,13 +12,11 @@ class TaxDestinationAddress(object): """Implementation of the 'Tax Destination Address' enum. - TODO: type enum description here. - Attributes: - SHIPPING_THEN_BILLING: TODO: type description here. - BILLING_THEN_SHIPPING: TODO: type description here. - SHIPPING_ONLY: TODO: type description here. - BILLING_ONLY: TODO: type description here. + SHIPPING_THEN_BILLING: The enum member of type str. + BILLING_THEN_SHIPPING: The enum member of type str. + SHIPPING_ONLY: The enum member of type str. + BILLING_ONLY: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/too_many_management_link_requests.py b/advancedbilling/models/too_many_management_link_requests.py index 2906c0f8..0d4fdb3c 100644 --- a/advancedbilling/models/too_many_management_link_requests.py +++ b/advancedbilling/models/too_many_management_link_requests.py @@ -13,11 +13,9 @@ class TooManyManagementLinkRequests(object): """Implementation of the 'Too Many Management Link Requests' model. - TODO: type model description here. - Attributes: - error (str): TODO: type description here. - new_link_available_at (datetime): TODO: type description here. + error (str): The model property of type str. + new_link_available_at (datetime): The model property of type datetime. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,15 @@ def from_dictionary(cls, return cls(error, new_link_available_at, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'error={self.error!r}, ' + f'new_link_available_at={self.new_link_available_at!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'error={self.error!s}, ' + f'new_link_available_at={self.new_link_available_at!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_allocation_expiration_date.py b/advancedbilling/models/update_allocation_expiration_date.py index 4c6879b5..30a9057e 100644 --- a/advancedbilling/models/update_allocation_expiration_date.py +++ b/advancedbilling/models/update_allocation_expiration_date.py @@ -14,10 +14,9 @@ class UpdateAllocationExpirationDate(object): """Implementation of the 'Update Allocation Expiration Date' model. - TODO: type model description here. - Attributes: - allocation (AllocationExpirationDate): TODO: type description here. + allocation (AllocationExpirationDate): The model property of type + AllocationExpirationDate. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +70,13 @@ def from_dictionary(cls, # Return an object of this model return cls(allocation, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'allocation={self.allocation!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'allocation={self.allocation!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_component.py b/advancedbilling/models/update_component.py index 2ad2c378..ae6b5b5a 100644 --- a/advancedbilling/models/update_component.py +++ b/advancedbilling/models/update_component.py @@ -13,14 +13,12 @@ class UpdateComponent(object): """Implementation of the 'Update Component' model. - TODO: type model description here. - Attributes: - handle (str): TODO: type description here. + handle (str): The model property of type str. name (str): The name of the Component, suitable for display on statements. i.e. Text Messages. description (str): The description of the component. - accounting_code (str): TODO: type description here. + accounting_code (str): The model property of type str. taxable (bool): Boolean flag describing whether a component is taxable or not. tax_code (str): A string representing the tax code related to the @@ -29,7 +27,7 @@ class UpdateComponent(object): length of 10 characters. item_category (ItemCategory): One of the following: Business Software, Consumer Software, Digital Services, Physical Goods, Other - display_on_hosted_page (bool): TODO: type description here. + display_on_hosted_page (bool): The model property of type bool. upgrade_charge (CreditType): The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: `full`, @@ -151,3 +149,29 @@ def from_dictionary(cls, display_on_hosted_page, upgrade_charge, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'handle={self.handle!r}, ' + f'name={self.name!r}, ' + f'description={self.description!r}, ' + f'accounting_code={self.accounting_code!r}, ' + f'taxable={self.taxable!r}, ' + f'tax_code={self.tax_code!r}, ' + f'item_category={self.item_category!r}, ' + f'display_on_hosted_page={self.display_on_hosted_page!r}, ' + f'upgrade_charge={self.upgrade_charge!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'handle={self.handle!s}, ' + f'name={self.name!s}, ' + f'description={self.description!s}, ' + f'accounting_code={self.accounting_code!s}, ' + f'taxable={self.taxable!s}, ' + f'tax_code={self.tax_code!s}, ' + f'item_category={self.item_category!s}, ' + f'display_on_hosted_page={self.display_on_hosted_page!s}, ' + f'upgrade_charge={self.upgrade_charge!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_component_price_point.py b/advancedbilling/models/update_component_price_point.py index b02b71ae..9ce073a2 100644 --- a/advancedbilling/models/update_component_price_point.py +++ b/advancedbilling/models/update_component_price_point.py @@ -14,11 +14,9 @@ class UpdateComponentPricePoint(object): """Implementation of the 'Update Component Price Point' model. - TODO: type model description here. - Attributes: - name (str): TODO: type description here. - handle (str): TODO: type description here. + name (str): The model property of type str. + handle (str): The model property of type str. pricing_scheme (PricingScheme): The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.h @@ -34,7 +32,8 @@ class UpdateComponentPricePoint(object): interval_unit (IntervalUnit): A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. - prices (List[UpdatePrice]): TODO: type description here. + prices (List[UpdatePrice]): The model property of type + List[UpdatePrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -145,3 +144,27 @@ def from_dictionary(cls, interval_unit, prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!r}, ' + f'handle={self.handle!r}, ' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!r}, ' + f'tax_included={self.tax_included!r}, ' + f'interval={self.interval!r}, ' + f'interval_unit={self.interval_unit!r}, ' + f'prices={self.prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={self.name!s}, ' + f'handle={self.handle!s}, ' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'use_site_exchange_rate={self.use_site_exchange_rate!s}, ' + f'tax_included={self.tax_included!s}, ' + f'interval={self.interval!s}, ' + f'interval_unit={self.interval_unit!s}, ' + f'prices={self.prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_component_price_point_request.py b/advancedbilling/models/update_component_price_point_request.py index e4e32f7f..f00afb72 100644 --- a/advancedbilling/models/update_component_price_point_request.py +++ b/advancedbilling/models/update_component_price_point_request.py @@ -14,10 +14,9 @@ class UpdateComponentPricePointRequest(object): """Implementation of the 'Update Component Price Point Request' model. - TODO: type model description here. - Attributes: - price_point (UpdateComponentPricePoint): TODO: type description here. + price_point (UpdateComponentPricePoint): The model property of type + UpdateComponentPricePoint. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +70,13 @@ def from_dictionary(cls, # Return an object of this model return cls(price_point, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_component_request.py b/advancedbilling/models/update_component_request.py index 533fc20b..d01404f4 100644 --- a/advancedbilling/models/update_component_request.py +++ b/advancedbilling/models/update_component_request.py @@ -13,10 +13,9 @@ class UpdateComponentRequest(object): """Implementation of the 'Update Component Request' model. - TODO: type model description here. - Attributes: - component (UpdateComponent): TODO: type description here. + component (UpdateComponent): The model property of type + UpdateComponent. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(component, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component={self.component!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component={self.component!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_coupon_currency.py b/advancedbilling/models/update_coupon_currency.py index 6d368fdd..33dfdec9 100644 --- a/advancedbilling/models/update_coupon_currency.py +++ b/advancedbilling/models/update_coupon_currency.py @@ -12,8 +12,6 @@ class UpdateCouponCurrency(object): """Implementation of the 'Update Coupon Currency' model. - TODO: type model description here. - Attributes: currency (str): ISO code for the site defined currency. price (int): Price for the given currency. @@ -70,3 +68,15 @@ def from_dictionary(cls, return cls(currency, price, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currency={self.currency!r}, ' + f'price={self.price!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currency={self.currency!s}, ' + f'price={self.price!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_currency_price.py b/advancedbilling/models/update_currency_price.py index 0aa473c4..a8f29973 100644 --- a/advancedbilling/models/update_currency_price.py +++ b/advancedbilling/models/update_currency_price.py @@ -12,8 +12,6 @@ class UpdateCurrencyPrice(object): """Implementation of the 'Update Currency Price' model. - TODO: type model description here. - Attributes: id (int): ID of the currency price record being updated price (float): New price for the given currency @@ -70,3 +68,15 @@ def from_dictionary(cls, return cls(id, price, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'price={self.price!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'price={self.price!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_currency_prices_request.py b/advancedbilling/models/update_currency_prices_request.py index a0bcd9c0..27473b1f 100644 --- a/advancedbilling/models/update_currency_prices_request.py +++ b/advancedbilling/models/update_currency_prices_request.py @@ -13,11 +13,9 @@ class UpdateCurrencyPricesRequest(object): """Implementation of the 'Update Currency Prices Request' model. - TODO: type model description here. - Attributes: - currency_prices (List[UpdateCurrencyPrice]): TODO: type description - here. + currency_prices (List[UpdateCurrencyPrice]): The model property of + type List[UpdateCurrencyPrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -68,3 +66,13 @@ def from_dictionary(cls, # Return an object of this model return cls(currency_prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'currency_prices={self.currency_prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_customer.py b/advancedbilling/models/update_customer.py index 15e607fb..372f1ea6 100644 --- a/advancedbilling/models/update_customer.py +++ b/advancedbilling/models/update_customer.py @@ -13,27 +13,25 @@ class UpdateCustomer(object): """Implementation of the 'Update Customer' model. - TODO: type model description here. - Attributes: - first_name (str): TODO: type description here. - last_name (str): TODO: type description here. - email (str): TODO: type description here. - cc_emails (str): TODO: type description here. - organization (str): TODO: type description here. - reference (str): TODO: type description here. - address (str): TODO: type description here. - address_2 (str): TODO: type description here. - city (str): TODO: type description here. - state (str): TODO: type description here. - zip (str): TODO: type description here. - country (str): TODO: type description here. - phone (str): TODO: type description here. + first_name (str): The model property of type str. + last_name (str): The model property of type str. + email (str): The model property of type str. + cc_emails (str): The model property of type str. + organization (str): The model property of type str. + reference (str): The model property of type str. + address (str): The model property of type str. + address_2 (str): The model property of type str. + city (str): The model property of type str. + state (str): The model property of type str. + zip (str): The model property of type str. + country (str): The model property of type str. + phone (str): The model property of type str. locale (str): Set a specific language on a customer record. - vat_number (str): TODO: type description here. - tax_exempt (bool): TODO: type description here. - tax_exempt_reason (str): TODO: type description here. - parent_id (int): TODO: type description here. + vat_number (str): The model property of type str. + tax_exempt (bool): The model property of type bool. + tax_exempt_reason (str): The model property of type str. + parent_id (int): The model property of type int. verified (bool): Is the customer verified to use ACH as a payment method. Available only on Authorize.Net gateway salesforce_id (str): The Salesforce ID of the customer @@ -229,3 +227,51 @@ def from_dictionary(cls, verified, salesforce_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'email={self.email!r}, ' + f'cc_emails={self.cc_emails!r}, ' + f'organization={self.organization!r}, ' + f'reference={self.reference!r}, ' + f'address={self.address!r}, ' + f'address_2={self.address_2!r}, ' + f'city={self.city!r}, ' + f'state={self.state!r}, ' + f'zip={self.zip!r}, ' + f'country={self.country!r}, ' + f'phone={self.phone!r}, ' + f'locale={self.locale!r}, ' + f'vat_number={self.vat_number!r}, ' + f'tax_exempt={self.tax_exempt!r}, ' + f'tax_exempt_reason={self.tax_exempt_reason!r}, ' + f'parent_id={self.parent_id!r}, ' + f'verified={self.verified!r}, ' + f'salesforce_id={self.salesforce_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'email={self.email!s}, ' + f'cc_emails={self.cc_emails!s}, ' + f'organization={self.organization!s}, ' + f'reference={self.reference!s}, ' + f'address={self.address!s}, ' + f'address_2={self.address_2!s}, ' + f'city={self.city!s}, ' + f'state={self.state!s}, ' + f'zip={self.zip!s}, ' + f'country={self.country!s}, ' + f'phone={self.phone!s}, ' + f'locale={self.locale!s}, ' + f'vat_number={self.vat_number!s}, ' + f'tax_exempt={self.tax_exempt!s}, ' + f'tax_exempt_reason={self.tax_exempt_reason!s}, ' + f'parent_id={self.parent_id!s}, ' + f'verified={self.verified!s}, ' + f'salesforce_id={self.salesforce_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_customer_request.py b/advancedbilling/models/update_customer_request.py index 0d418a8a..28836ef7 100644 --- a/advancedbilling/models/update_customer_request.py +++ b/advancedbilling/models/update_customer_request.py @@ -13,10 +13,8 @@ class UpdateCustomerRequest(object): """Implementation of the 'Update Customer Request' model. - TODO: type model description here. - Attributes: - customer (UpdateCustomer): TODO: type description here. + customer (UpdateCustomer): The model property of type UpdateCustomer. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(customer, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'customer={self.customer!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'customer={self.customer!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_metadata.py b/advancedbilling/models/update_metadata.py index 435faa66..0e5dbab5 100644 --- a/advancedbilling/models/update_metadata.py +++ b/advancedbilling/models/update_metadata.py @@ -13,12 +13,10 @@ class UpdateMetadata(object): """Implementation of the 'Update Metadata' model. - TODO: type model description here. - Attributes: - current_name (str): TODO: type description here. - name (str): TODO: type description here. - value (str): TODO: type description here. + current_name (str): The model property of type str. + name (str): The model property of type str. + value (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -86,3 +84,17 @@ def from_dictionary(cls, name, value, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'current_name={self.current_name!r}, ' + f'name={self.name!r}, ' + f'value={self.value!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'current_name={self.current_name!s}, ' + f'name={self.name!s}, ' + f'value={self.value!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_metadata_request.py b/advancedbilling/models/update_metadata_request.py index 0e24cdd6..9cb17766 100644 --- a/advancedbilling/models/update_metadata_request.py +++ b/advancedbilling/models/update_metadata_request.py @@ -14,10 +14,8 @@ class UpdateMetadataRequest(object): """Implementation of the 'Update Metadata Request' model. - TODO: type model description here. - Attributes: - metadata (UpdateMetadata): TODO: type description here. + metadata (UpdateMetadata): The model property of type UpdateMetadata. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(metadata, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'metadata={self.metadata!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'metadata={self.metadata!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_metafield.py b/advancedbilling/models/update_metafield.py index d7e8638c..9ba4fbb4 100644 --- a/advancedbilling/models/update_metafield.py +++ b/advancedbilling/models/update_metafield.py @@ -14,11 +14,9 @@ class UpdateMetafield(object): """Implementation of the 'Update Metafield' model. - TODO: type model description here. - Attributes: - current_name (str): TODO: type description here. - name (str): TODO: type description here. + current_name (str): The model property of type str. + name (str): The model property of type str. scope (MetafieldScope): Warning: When updating a metafield's scope attribute, all scope attributes must be passed. Partially complete scope attributes will override the existing settings. @@ -132,3 +130,21 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'current_name={self.current_name!r}, ' + f'name={self.name!r}, ' + f'scope={self.scope!r}, ' + f'input_type={self.input_type!r}, ' + f'enum={self.enum!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'current_name={self.current_name!s}, ' + f'name={self.name!s}, ' + f'scope={self.scope!s}, ' + f'input_type={self.input_type!s}, ' + f'enum={self.enum!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_metafields_request.py b/advancedbilling/models/update_metafields_request.py index 7a8daff9..487b497c 100644 --- a/advancedbilling/models/update_metafields_request.py +++ b/advancedbilling/models/update_metafields_request.py @@ -13,11 +13,9 @@ class UpdateMetafieldsRequest(object): """Implementation of the 'Update Metafields Request' model. - TODO: type model description here. - Attributes: - metafields (UpdateMetafield | List[UpdateMetafield] | None): TODO: - type description here. + metafields (UpdateMetafield | List[UpdateMetafield] | None): The model + property of type UpdateMetafield | List[UpdateMetafield] | None. additional_properties (Dict[str, object]): The additional properties for the model. @@ -72,3 +70,13 @@ def from_dictionary(cls, # Return an object of this model return cls(metafields, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'metafields={self.metafields!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'metafields={self.metafields!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_payment_profile.py b/advancedbilling/models/update_payment_profile.py index 02004b18..a58ebfc1 100644 --- a/advancedbilling/models/update_payment_profile.py +++ b/advancedbilling/models/update_payment_profile.py @@ -13,8 +13,6 @@ class UpdatePaymentProfile(object): """Implementation of the 'Update Payment Profile' model. - TODO: type model description here. - Attributes: first_name (str): The first name of the card holder. last_name (str): The last name of the card holder. @@ -192,3 +190,37 @@ def from_dictionary(cls, billing_country, billing_address_2, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!r}, ' + f'last_name={self.last_name!r}, ' + f'full_number={self.full_number!r}, ' + f'card_type={self.card_type!r}, ' + f'expiration_month={self.expiration_month!r}, ' + f'expiration_year={self.expiration_year!r}, ' + f'current_vault={self.current_vault!r}, ' + f'billing_address={self.billing_address!r}, ' + f'billing_city={self.billing_city!r}, ' + f'billing_state={self.billing_state!r}, ' + f'billing_zip={self.billing_zip!r}, ' + f'billing_country={self.billing_country!r}, ' + f'billing_address_2={self.billing_address_2!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'first_name={self.first_name!s}, ' + f'last_name={self.last_name!s}, ' + f'full_number={self.full_number!s}, ' + f'card_type={self.card_type!s}, ' + f'expiration_month={self.expiration_month!s}, ' + f'expiration_year={self.expiration_year!s}, ' + f'current_vault={self.current_vault!s}, ' + f'billing_address={self.billing_address!s}, ' + f'billing_city={self.billing_city!s}, ' + f'billing_state={self.billing_state!s}, ' + f'billing_zip={self.billing_zip!s}, ' + f'billing_country={self.billing_country!s}, ' + f'billing_address_2={self.billing_address_2!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_payment_profile_request.py b/advancedbilling/models/update_payment_profile_request.py index 17f2e235..ac8ba88e 100644 --- a/advancedbilling/models/update_payment_profile_request.py +++ b/advancedbilling/models/update_payment_profile_request.py @@ -13,10 +13,9 @@ class UpdatePaymentProfileRequest(object): """Implementation of the 'Update Payment Profile Request' model. - TODO: type model description here. - Attributes: - payment_profile (UpdatePaymentProfile): TODO: type description here. + payment_profile (UpdatePaymentProfile): The model property of type + UpdatePaymentProfile. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(payment_profile, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile={self.payment_profile!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'payment_profile={self.payment_profile!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_price.py b/advancedbilling/models/update_price.py index 28be3f8a..4176809f 100644 --- a/advancedbilling/models/update_price.py +++ b/advancedbilling/models/update_price.py @@ -13,15 +13,15 @@ class UpdatePrice(object): """Implementation of the 'Update Price' model. - TODO: type model description here. - Attributes: - id (int): TODO: type description here. - ending_quantity (int | str | None): TODO: type description here. + id (int): The model property of type int. + ending_quantity (int | str | None): The model property of type int | + str | None. unit_price (float | str | None): The price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or 0.00000065 - destroy (bool): TODO: type description here. - starting_quantity (int | str | None): TODO: type description here. + destroy (bool): The model property of type bool. + starting_quantity (int | str | None): The model property of type int | + str | None. additional_properties (Dict[str, object]): The additional properties for the model. @@ -104,3 +104,21 @@ def from_dictionary(cls, destroy, starting_quantity, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'ending_quantity={self.ending_quantity!r}, ' + f'unit_price={self.unit_price!r}, ' + f'destroy={self.destroy!r}, ' + f'starting_quantity={self.starting_quantity!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'ending_quantity={self.ending_quantity!s}, ' + f'unit_price={self.unit_price!s}, ' + f'destroy={self.destroy!s}, ' + f'starting_quantity={self.starting_quantity!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_product_price_point.py b/advancedbilling/models/update_product_price_point.py index 9381f6e9..b2c98c1a 100644 --- a/advancedbilling/models/update_product_price_point.py +++ b/advancedbilling/models/update_product_price_point.py @@ -13,11 +13,9 @@ class UpdateProductPricePoint(object): """Implementation of the 'Update Product Price Point' model. - TODO: type model description here. - Attributes: - handle (str): TODO: type description here. - price_in_cents (long|int): TODO: type description here. + handle (str): The model property of type str. + price_in_cents (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -78,3 +76,15 @@ def from_dictionary(cls, return cls(handle, price_in_cents, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'handle={self.handle!r}, ' + f'price_in_cents={self.price_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'handle={self.handle!s}, ' + f'price_in_cents={self.price_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_product_price_point_request.py b/advancedbilling/models/update_product_price_point_request.py index 1a69db3f..ada580c2 100644 --- a/advancedbilling/models/update_product_price_point_request.py +++ b/advancedbilling/models/update_product_price_point_request.py @@ -13,10 +13,9 @@ class UpdateProductPricePointRequest(object): """Implementation of the 'Update Product Price Point Request' model. - TODO: type model description here. - Attributes: - price_point (UpdateProductPricePoint): TODO: type description here. + price_point (UpdateProductPricePoint): The model property of type + UpdateProductPricePoint. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(price_point, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'price_point={self.price_point!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_reason_code.py b/advancedbilling/models/update_reason_code.py index feba6f5d..752e9835 100644 --- a/advancedbilling/models/update_reason_code.py +++ b/advancedbilling/models/update_reason_code.py @@ -13,8 +13,6 @@ class UpdateReasonCode(object): """Implementation of the 'Update Reason Code' model. - TODO: type model description here. - Attributes: code (str): The unique identifier for the ReasonCode description (str): The friendly summary of what the code signifies @@ -86,3 +84,17 @@ def from_dictionary(cls, description, position, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'code={self.code!r}, ' + f'description={self.description!r}, ' + f'position={self.position!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'code={self.code!s}, ' + f'description={self.description!s}, ' + f'position={self.position!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_reason_code_request.py b/advancedbilling/models/update_reason_code_request.py index 81bce4a2..0f81cdbc 100644 --- a/advancedbilling/models/update_reason_code_request.py +++ b/advancedbilling/models/update_reason_code_request.py @@ -13,10 +13,9 @@ class UpdateReasonCodeRequest(object): """Implementation of the 'Update Reason Code Request' model. - TODO: type model description here. - Attributes: - reason_code (UpdateReasonCode): TODO: type description here. + reason_code (UpdateReasonCode): The model property of type + UpdateReasonCode. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(reason_code, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'reason_code={self.reason_code!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'reason_code={self.reason_code!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_segment.py b/advancedbilling/models/update_segment.py index 4747f0b7..be64042f 100644 --- a/advancedbilling/models/update_segment.py +++ b/advancedbilling/models/update_segment.py @@ -14,14 +14,13 @@ class UpdateSegment(object): """Implementation of the 'Update Segment' model. - TODO: type model description here. - Attributes: pricing_scheme (PricingScheme): The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.h tml) for an overview of pricing schemes. - prices (List[CreateOrUpdateSegmentPrice]): TODO: type description here. + prices (List[CreateOrUpdateSegmentPrice]): The model property of type + List[CreateOrUpdateSegmentPrice]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -84,3 +83,15 @@ def from_dictionary(cls, return cls(pricing_scheme, prices, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'pricing_scheme={self.pricing_scheme!r}, ' + f'prices={self.prices!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'pricing_scheme={self.pricing_scheme!s}, ' + f'prices={self.prices!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_segment_request.py b/advancedbilling/models/update_segment_request.py index 253edc2a..ea733ba2 100644 --- a/advancedbilling/models/update_segment_request.py +++ b/advancedbilling/models/update_segment_request.py @@ -13,10 +13,8 @@ class UpdateSegmentRequest(object): """Implementation of the 'Update Segment Request' model. - TODO: type model description here. - Attributes: - segment (UpdateSegment): TODO: type description here. + segment (UpdateSegment): The model property of type UpdateSegment. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(segment, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'segment={self.segment!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'segment={self.segment!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_subscription.py b/advancedbilling/models/update_subscription.py index 5748fa07..fec821a8 100644 --- a/advancedbilling/models/update_subscription.py +++ b/advancedbilling/models/update_subscription.py @@ -16,27 +16,26 @@ class UpdateSubscription(object): """Implementation of the 'Update Subscription' model. - TODO: type model description here. - Attributes: - credit_card_attributes (CreditCardAttributes): TODO: type description - here. + credit_card_attributes (CreditCardAttributes): The model property of + type CreditCardAttributes. product_handle (str): Set to the handle of a different product to change the subscription's product product_id (int): Set to the id of a different product to change the subscription's product - product_change_delayed (bool): TODO: type description here. + product_change_delayed (bool): The model property of type bool. next_product_id (str): Set to an empty string to cancel a delayed product change. - next_product_price_point_id (str): TODO: type description here. + next_product_price_point_id (str): The model property of type str. snap_day (SnapDay | int | None): Use for subscriptions with product eligible for calendar billing only. Value can be 1-28 or 'end'. - next_billing_at (datetime): TODO: type description here. - payment_collection_method (str): TODO: type description here. - receives_invoice_emails (bool): TODO: type description here. - net_terms (str | int | None): TODO: type description here. - stored_credential_transaction_id (int): TODO: type description here. - reference (str): TODO: type description here. + next_billing_at (datetime): The model property of type datetime. + payment_collection_method (str): The model property of type str. + receives_invoice_emails (bool): The model property of type bool. + net_terms (str | int | None): The model property of type str | int | + None. + stored_credential_transaction_id (int): The model property of type int. + reference (str): The model property of type str. custom_price (SubscriptionCustomPrice): (Optional) Used in place of `product_price_point_id` to define a custom price point unique to the subscription @@ -240,3 +239,49 @@ def from_dictionary(cls, product_price_point_id, product_price_point_handle, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'credit_card_attributes={self.credit_card_attributes!r}, ' + f'product_handle={self.product_handle!r}, ' + f'product_id={self.product_id!r}, ' + f'product_change_delayed={self.product_change_delayed!r}, ' + f'next_product_id={self.next_product_id!r}, ' + f'next_product_price_point_id={self.next_product_price_point_id!r}, ' + f'snap_day={self.snap_day!r}, ' + f'next_billing_at={self.next_billing_at!r}, ' + f'payment_collection_method={self.payment_collection_method!r}, ' + f'receives_invoice_emails={self.receives_invoice_emails!r}, ' + f'net_terms={self.net_terms!r}, ' + f'stored_credential_transaction_id={self.stored_credential_transaction_id!r}, ' + f'reference={self.reference!r}, ' + f'custom_price={self.custom_price!r}, ' + f'components={self.components!r}, ' + f'dunning_communication_delay_enabled={self.dunning_communication_delay_enabled!r}, ' + f'dunning_communication_delay_time_zone={self.dunning_communication_delay_time_zone!r}, ' + f'product_price_point_id={self.product_price_point_id!r}, ' + f'product_price_point_handle={self.product_price_point_handle!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'credit_card_attributes={self.credit_card_attributes!s}, ' + f'product_handle={self.product_handle!s}, ' + f'product_id={self.product_id!s}, ' + f'product_change_delayed={self.product_change_delayed!s}, ' + f'next_product_id={self.next_product_id!s}, ' + f'next_product_price_point_id={self.next_product_price_point_id!s}, ' + f'snap_day={self.snap_day!s}, ' + f'next_billing_at={self.next_billing_at!s}, ' + f'payment_collection_method={self.payment_collection_method!s}, ' + f'receives_invoice_emails={self.receives_invoice_emails!s}, ' + f'net_terms={self.net_terms!s}, ' + f'stored_credential_transaction_id={self.stored_credential_transaction_id!s}, ' + f'reference={self.reference!s}, ' + f'custom_price={self.custom_price!s}, ' + f'components={self.components!s}, ' + f'dunning_communication_delay_enabled={self.dunning_communication_delay_enabled!s}, ' + f'dunning_communication_delay_time_zone={self.dunning_communication_delay_time_zone!s}, ' + f'product_price_point_id={self.product_price_point_id!s}, ' + f'product_price_point_handle={self.product_price_point_handle!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_subscription_component.py b/advancedbilling/models/update_subscription_component.py index 3a501541..5ef81fa3 100644 --- a/advancedbilling/models/update_subscription_component.py +++ b/advancedbilling/models/update_subscription_component.py @@ -14,10 +14,8 @@ class UpdateSubscriptionComponent(object): """Implementation of the 'Update Subscription Component' model. - TODO: type model description here. - Attributes: - component_id (int): TODO: type description here. + component_id (int): The model property of type int. custom_price (ComponentCustomPrice): Create or update custom pricing unique to the subscription. Used in place of `price_point_id`. additional_properties (Dict[str, object]): The additional properties @@ -102,3 +100,15 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!r}, ' + f'custom_price={self.custom_price!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'component_id={self.component_id!s}, ' + f'custom_price={self.custom_price!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_subscription_group.py b/advancedbilling/models/update_subscription_group.py index f5348904..e1aa9439 100644 --- a/advancedbilling/models/update_subscription_group.py +++ b/advancedbilling/models/update_subscription_group.py @@ -13,10 +13,8 @@ class UpdateSubscriptionGroup(object): """Implementation of the 'Update Subscription Group' model. - TODO: type model description here. - Attributes: - member_ids (List[int]): TODO: type description here. + member_ids (List[int]): The model property of type List[int]. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +68,13 @@ def from_dictionary(cls, # Return an object of this model return cls(member_ids, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'member_ids={self.member_ids!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'member_ids={self.member_ids!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_subscription_group_request.py b/advancedbilling/models/update_subscription_group_request.py index ececf67f..fe00640f 100644 --- a/advancedbilling/models/update_subscription_group_request.py +++ b/advancedbilling/models/update_subscription_group_request.py @@ -13,11 +13,9 @@ class UpdateSubscriptionGroupRequest(object): """Implementation of the 'Update Subscription Group Request' model. - TODO: type model description here. - Attributes: - subscription_group (UpdateSubscriptionGroup): TODO: type description - here. + subscription_group (UpdateSubscriptionGroup): The model property of + type UpdateSubscriptionGroup. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription_group, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription_group={self.subscription_group!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_subscription_note.py b/advancedbilling/models/update_subscription_note.py index f1865140..8fc515c0 100644 --- a/advancedbilling/models/update_subscription_note.py +++ b/advancedbilling/models/update_subscription_note.py @@ -15,8 +15,8 @@ class UpdateSubscriptionNote(object): Updatable fields for Subscription Note Attributes: - body (str): TODO: type description here. - sticky (bool): TODO: type description here. + body (str): The model property of type str. + sticky (bool): The model property of type bool. additional_properties (Dict[str, object]): The additional properties for the model. @@ -70,3 +70,15 @@ def from_dictionary(cls, return cls(body, sticky, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'body={self.body!r}, ' + f'sticky={self.sticky!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'body={self.body!s}, ' + f'sticky={self.sticky!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_subscription_note_request.py b/advancedbilling/models/update_subscription_note_request.py index 0b7bee9a..c7e0ea31 100644 --- a/advancedbilling/models/update_subscription_note_request.py +++ b/advancedbilling/models/update_subscription_note_request.py @@ -65,3 +65,13 @@ def from_dictionary(cls, # Return an object of this model return cls(note, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'note={self.note!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'note={self.note!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/update_subscription_request.py b/advancedbilling/models/update_subscription_request.py index bfcd491c..02fb45bc 100644 --- a/advancedbilling/models/update_subscription_request.py +++ b/advancedbilling/models/update_subscription_request.py @@ -13,10 +13,9 @@ class UpdateSubscriptionRequest(object): """Implementation of the 'Update Subscription Request' model. - TODO: type model description here. - Attributes: - subscription (UpdateSubscription): TODO: type description here. + subscription (UpdateSubscription): The model property of type + UpdateSubscription. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(subscription, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscription={self.subscription!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/upsert_prepaid_configuration.py b/advancedbilling/models/upsert_prepaid_configuration.py index d216d110..00612278 100644 --- a/advancedbilling/models/upsert_prepaid_configuration.py +++ b/advancedbilling/models/upsert_prepaid_configuration.py @@ -13,15 +13,12 @@ class UpsertPrepaidConfiguration(object): """Implementation of the 'Upsert Prepaid Configuration' model. - TODO: type model description here. - Attributes: - initial_funding_amount_in_cents (long|int): TODO: type description - here. - replenish_to_amount_in_cents (long|int): TODO: type description here. - auto_replenish (bool): TODO: type description here. - replenish_threshold_amount_in_cents (long|int): TODO: type description - here. + initial_funding_amount_in_cents (int): The model property of type int. + replenish_to_amount_in_cents (int): The model property of type int. + auto_replenish (bool): The model property of type bool. + replenish_threshold_amount_in_cents (int): The model property of type + int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -118,3 +115,19 @@ def validate(cls, dictionary): return False return True + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'initial_funding_amount_in_cents={self.initial_funding_amount_in_cents!r}, ' + f'replenish_to_amount_in_cents={self.replenish_to_amount_in_cents!r}, ' + f'auto_replenish={self.auto_replenish!r}, ' + f'replenish_threshold_amount_in_cents={self.replenish_threshold_amount_in_cents!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'initial_funding_amount_in_cents={self.initial_funding_amount_in_cents!s}, ' + f'replenish_to_amount_in_cents={self.replenish_to_amount_in_cents!s}, ' + f'auto_replenish={self.auto_replenish!s}, ' + f'replenish_threshold_amount_in_cents={self.replenish_threshold_amount_in_cents!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/upsert_prepaid_configuration_request.py b/advancedbilling/models/upsert_prepaid_configuration_request.py index 698d0b9b..062bae09 100644 --- a/advancedbilling/models/upsert_prepaid_configuration_request.py +++ b/advancedbilling/models/upsert_prepaid_configuration_request.py @@ -13,11 +13,9 @@ class UpsertPrepaidConfigurationRequest(object): """Implementation of the 'Upsert Prepaid Configuration Request' model. - TODO: type model description here. - Attributes: - prepaid_configuration (UpsertPrepaidConfiguration): TODO: type - description here. + prepaid_configuration (UpsertPrepaidConfiguration): The model property + of type UpsertPrepaidConfiguration. additional_properties (Dict[str, object]): The additional properties for the model. @@ -66,3 +64,13 @@ def from_dictionary(cls, # Return an object of this model return cls(prepaid_configuration, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prepaid_configuration={self.prepaid_configuration!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prepaid_configuration={self.prepaid_configuration!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/usage.py b/advancedbilling/models/usage.py index 3d13d936..ef8d8112 100644 --- a/advancedbilling/models/usage.py +++ b/advancedbilling/models/usage.py @@ -13,18 +13,17 @@ class Usage(object): """Implementation of the 'Usage' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - memo (str): TODO: type description here. - created_at (datetime): TODO: type description here. - price_point_id (int): TODO: type description here. - quantity (int | str | None): TODO: type description here. - overage_quantity (int): TODO: type description here. - component_id (int): TODO: type description here. - component_handle (str): TODO: type description here. - subscription_id (int): TODO: type description here. + id (int): The model property of type int. + memo (str): The model property of type str. + created_at (datetime): The model property of type datetime. + price_point_id (int): The model property of type int. + quantity (int | str | None): The model property of type int | str | + None. + overage_quantity (int): The model property of type int. + component_id (int): The model property of type int. + component_handle (str): The model property of type str. + subscription_id (int): The model property of type int. additional_properties (Dict[str, object]): The additional properties for the model. @@ -139,3 +138,29 @@ def from_dictionary(cls, component_handle, subscription_id, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'memo={self.memo!r}, ' + f'created_at={self.created_at!r}, ' + f'price_point_id={self.price_point_id!r}, ' + f'quantity={self.quantity!r}, ' + f'overage_quantity={self.overage_quantity!r}, ' + f'component_id={self.component_id!r}, ' + f'component_handle={self.component_handle!r}, ' + f'subscription_id={self.subscription_id!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'memo={self.memo!s}, ' + f'created_at={self.created_at!s}, ' + f'price_point_id={self.price_point_id!s}, ' + f'quantity={self.quantity!s}, ' + f'overage_quantity={self.overage_quantity!s}, ' + f'component_id={self.component_id!s}, ' + f'component_handle={self.component_handle!s}, ' + f'subscription_id={self.subscription_id!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/usage_response.py b/advancedbilling/models/usage_response.py index 18f108dd..d7c3de6e 100644 --- a/advancedbilling/models/usage_response.py +++ b/advancedbilling/models/usage_response.py @@ -13,10 +13,8 @@ class UsageResponse(object): """Implementation of the 'Usage Response' model. - TODO: type model description here. - Attributes: - usage (Usage): TODO: type description here. + usage (Usage): The model property of type Usage. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(usage, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'usage={self.usage!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'usage={self.usage!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/void_invoice.py b/advancedbilling/models/void_invoice.py index a028adec..551a8ba0 100644 --- a/advancedbilling/models/void_invoice.py +++ b/advancedbilling/models/void_invoice.py @@ -12,10 +12,8 @@ class VoidInvoice(object): """Implementation of the 'Void Invoice' model. - TODO: type model description here. - Attributes: - reason (str): TODO: type description here. + reason (str): The model property of type str. additional_properties (Dict[str, object]): The additional properties for the model. @@ -64,3 +62,13 @@ def from_dictionary(cls, # Return an object of this model return cls(reason, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'reason={self.reason!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'reason={self.reason!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/void_invoice_event.py b/advancedbilling/models/void_invoice_event.py index e3e68448..17698162 100644 --- a/advancedbilling/models/void_invoice_event.py +++ b/advancedbilling/models/void_invoice_event.py @@ -16,13 +16,12 @@ class VoidInvoiceEvent(object): """Implementation of the 'Void Invoice Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (VoidInvoiceEventData): Example schema for an `void_invoice` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: VoidInvoiceEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/void_invoice_event_data.py b/advancedbilling/models/void_invoice_event_data.py index 6ff9dd25..afe42990 100644 --- a/advancedbilling/models/void_invoice_event_data.py +++ b/advancedbilling/models/void_invoice_event_data.py @@ -17,7 +17,8 @@ class VoidInvoiceEventData(object): Example schema for an `void_invoice` event Attributes: - credit_note_attributes (CreditNote): TODO: type description here. + credit_note_attributes (CreditNote): The model property of type + CreditNote. memo (str): The memo provided during invoice voiding. applied_amount (str): The amount of the void. transaction_time (datetime): The time the refund was applied, in ISO @@ -158,3 +159,23 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, bool)) \ and APIHelper.is_valid_type(value=dictionary.get('reason'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'credit_note_attributes={self.credit_note_attributes!r}, ' + f'memo={self.memo!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'is_advance_invoice={self.is_advance_invoice!r}, ' + f'reason={self.reason!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'credit_note_attributes={self.credit_note_attributes!s}, ' + f'memo={self.memo!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'is_advance_invoice={self.is_advance_invoice!s}, ' + f'reason={self.reason!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/void_invoice_request.py b/advancedbilling/models/void_invoice_request.py index a55fdba6..56d550e3 100644 --- a/advancedbilling/models/void_invoice_request.py +++ b/advancedbilling/models/void_invoice_request.py @@ -13,10 +13,8 @@ class VoidInvoiceRequest(object): """Implementation of the 'Void Invoice Request' model. - TODO: type model description here. - Attributes: - void (VoidInvoice): TODO: type description here. + void (VoidInvoice): The model property of type VoidInvoice. additional_properties (Dict[str, object]): The additional properties for the model. @@ -65,3 +63,13 @@ def from_dictionary(cls, # Return an object of this model return cls(void, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'void={self.void!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'void={self.void!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/void_remainder_event.py b/advancedbilling/models/void_remainder_event.py index 0695e5e4..55a01d88 100644 --- a/advancedbilling/models/void_remainder_event.py +++ b/advancedbilling/models/void_remainder_event.py @@ -16,13 +16,12 @@ class VoidRemainderEvent(object): """Implementation of the 'Void Remainder Event' model. - TODO: type model description here. - Attributes: - id (long|int): TODO: type description here. - timestamp (datetime): TODO: type description here. - invoice (Invoice): TODO: type description here. - event_type (InvoiceEventType): TODO: type description here. + id (int): The model property of type int. + timestamp (datetime): The model property of type datetime. + invoice (Invoice): The model property of type Invoice. + event_type (InvoiceEventType): The model property of type + InvoiceEventType. event_data (VoidRemainderEventData): Example schema for an `void_remainder` event additional_properties (Dict[str, object]): The additional properties @@ -137,3 +136,21 @@ def validate(cls, dictionary): and APIHelper.is_valid_type(value=dictionary.get('event_data'), type_callable=lambda value: VoidRemainderEventData.validate(value), is_model_dict=True) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!r}, ' + f'timestamp={self.timestamp!r}, ' + f'invoice={self.invoice!r}, ' + f'event_type={self.event_type!r}, ' + f'event_data={self.event_data!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={self.id!s}, ' + f'timestamp={self.timestamp!s}, ' + f'invoice={self.invoice!s}, ' + f'event_type={self.event_type!s}, ' + f'event_data={self.event_data!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/void_remainder_event_data.py b/advancedbilling/models/void_remainder_event_data.py index c03b39c4..c886a64b 100644 --- a/advancedbilling/models/void_remainder_event_data.py +++ b/advancedbilling/models/void_remainder_event_data.py @@ -17,7 +17,8 @@ class VoidRemainderEventData(object): Example schema for an `void_remainder` event Attributes: - credit_note_attributes (CreditNote): TODO: type description here. + credit_note_attributes (CreditNote): The model property of type + CreditNote. memo (str): The memo provided during invoice remainder voiding. applied_amount (str): The amount of the void. transaction_time (datetime): The time the refund was applied, in ISO @@ -123,3 +124,19 @@ def validate(cls, dictionary): type_callable=lambda value: isinstance(value, str)) \ and APIHelper.is_valid_type(value=dictionary.get('transaction_time'), type_callable=lambda value: isinstance(value, str)) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'credit_note_attributes={self.credit_note_attributes!r}, ' + f'memo={self.memo!r}, ' + f'applied_amount={self.applied_amount!r}, ' + f'transaction_time={self.transaction_time!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'credit_note_attributes={self.credit_note_attributes!s}, ' + f'memo={self.memo!s}, ' + f'applied_amount={self.applied_amount!s}, ' + f'transaction_time={self.transaction_time!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/webhook.py b/advancedbilling/models/webhook.py index 9affa76a..c1d92579 100644 --- a/advancedbilling/models/webhook.py +++ b/advancedbilling/models/webhook.py @@ -13,15 +13,13 @@ class Webhook(object): """Implementation of the 'Webhook' model. - TODO: type model description here. - Attributes: event (str): A string describing which event type produced the given webhook - id (long|int): The unique identifier for the webhooks (unique across - all of Chargify). This is not changed on a retry/replay of the - same webhook, so it may be used to avoid duplicate action for the - same event. + id (int): The unique identifier for the webhooks (unique across all of + Chargify). This is not changed on a retry/replay of the same + webhook, so it may be used to avoid duplicate action for the same + event. created_at (datetime): Timestamp indicating when the webhook was created last_error (str): Text describing the status code and/or error from @@ -182,3 +180,35 @@ def from_dictionary(cls, signature, signature_hmac_sha_256, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'event={self.event!r}, ' + f'id={self.id!r}, ' + f'created_at={self.created_at!r}, ' + f'last_error={self.last_error!r}, ' + f'last_error_at={self.last_error_at!r}, ' + f'accepted_at={self.accepted_at!r}, ' + f'last_sent_at={self.last_sent_at!r}, ' + f'last_sent_url={self.last_sent_url!r}, ' + f'successful={self.successful!r}, ' + f'body={self.body!r}, ' + f'signature={self.signature!r}, ' + f'signature_hmac_sha_256={self.signature_hmac_sha_256!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'event={self.event!s}, ' + f'id={self.id!s}, ' + f'created_at={self.created_at!s}, ' + f'last_error={self.last_error!s}, ' + f'last_error_at={self.last_error_at!s}, ' + f'accepted_at={self.accepted_at!s}, ' + f'last_sent_at={self.last_sent_at!s}, ' + f'last_sent_url={self.last_sent_url!s}, ' + f'successful={self.successful!s}, ' + f'body={self.body!s}, ' + f'signature={self.signature!s}, ' + f'signature_hmac_sha_256={self.signature_hmac_sha_256!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/webhook_order.py b/advancedbilling/models/webhook_order.py index a07eaa1f..c446516c 100644 --- a/advancedbilling/models/webhook_order.py +++ b/advancedbilling/models/webhook_order.py @@ -12,11 +12,9 @@ class WebhookOrder(object): """Implementation of the 'Webhook Order' enum. - TODO: type enum description here. - Attributes: - NEWEST_FIRST: TODO: type description here. - OLDEST_FIRST: TODO: type description here. + NEWEST_FIRST: The enum member of type str. + OLDEST_FIRST: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/webhook_response.py b/advancedbilling/models/webhook_response.py index 20c91226..215f5e5a 100644 --- a/advancedbilling/models/webhook_response.py +++ b/advancedbilling/models/webhook_response.py @@ -14,10 +14,8 @@ class WebhookResponse(object): """Implementation of the 'Webhook Response' model. - TODO: type model description here. - Attributes: - webhook (Webhook): TODO: type description here. + webhook (Webhook): The model property of type Webhook. additional_properties (Dict[str, object]): The additional properties for the model. @@ -71,3 +69,13 @@ def from_dictionary(cls, # Return an object of this model return cls(webhook, additional_properties) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'webhook={self.webhook!r}, ' + f'additional_properties={self.additional_properties!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'webhook={self.webhook!s}, ' + f'additional_properties={self.additional_properties!s})') diff --git a/advancedbilling/models/webhook_status.py b/advancedbilling/models/webhook_status.py index 89e70701..9ceceabd 100644 --- a/advancedbilling/models/webhook_status.py +++ b/advancedbilling/models/webhook_status.py @@ -12,13 +12,11 @@ class WebhookStatus(object): """Implementation of the 'Webhook Status' enum. - TODO: type enum description here. - Attributes: - SUCCESSFUL: TODO: type description here. - FAILED: TODO: type description here. - PENDING: TODO: type description here. - PAUSED: TODO: type description here. + SUCCESSFUL: The enum member of type str. + FAILED: The enum member of type str. + PENDING: The enum member of type str. + PAUSED: The enum member of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/models/webhook_subscription.py b/advancedbilling/models/webhook_subscription.py index d52e46a3..0a1ec188 100644 --- a/advancedbilling/models/webhook_subscription.py +++ b/advancedbilling/models/webhook_subscription.py @@ -12,46 +12,44 @@ class WebhookSubscription(object): """Implementation of the 'Webhook Subscription' enum. - TODO: type enum description here. - Attributes: - BILLING_DATE_CHANGE: TODO: type description here. - COMPONENT_ALLOCATION_CHANGE: TODO: type description here. - CUSTOMER_CREATE: TODO: type description here. - CUSTOMER_UPDATE: TODO: type description here. - DUNNING_STEP_REACHED: TODO: type description here. - EXPIRING_CARD: TODO: type description here. - EXPIRATION_DATE_CHANGE: TODO: type description here. - INVOICE_ISSUED: TODO: type description here. - METERED_USAGE: TODO: type description here. - PAYMENT_FAILURE: TODO: type description here. - PAYMENT_SUCCESS: TODO: type description here. - DIRECT_DEBIT_PAYMENT_PENDING: TODO: type description here. - DIRECT_DEBIT_PAYMENT_PAID_OUT: TODO: type description here. - DIRECT_DEBIT_PAYMENT_REJECTED: TODO: type description here. - PREPAID_SUBSCRIPTION_BALANCE_CHANGED: TODO: type description here. - PREPAID_USAGE: TODO: type description here. - REFUND_FAILURE: TODO: type description here. - REFUND_SUCCESS: TODO: type description here. - RENEWAL_FAILURE: TODO: type description here. - RENEWAL_SUCCESS: TODO: type description here. - SIGNUP_FAILURE: TODO: type description here. - SIGNUP_SUCCESS: TODO: type description here. - STATEMENT_CLOSED: TODO: type description here. - STATEMENT_SETTLED: TODO: type description here. - SUBSCRIPTION_CARD_UPDATE: TODO: type description here. - SUBSCRIPTION_GROUP_CARD_UPDATE: TODO: type description here. - SUBSCRIPTION_PRODUCT_CHANGE: TODO: type description here. - SUBSCRIPTION_STATE_CHANGE: TODO: type description here. - TRIAL_END_NOTICE: TODO: type description here. - UPCOMING_RENEWAL_NOTICE: TODO: type description here. - UPGRADE_DOWNGRADE_FAILURE: TODO: type description here. - UPGRADE_DOWNGRADE_SUCCESS: TODO: type description here. - PENDING_CANCELLATION_CHANGE: TODO: type description here. - SUBSCRIPTION_PREPAYMENT_ACCOUNT_BALANCE_CHANGED: TODO: type - description here. - SUBSCRIPTION_SERVICE_CREDIT_ACCOUNT_BALANCE_CHANGED: TODO: type - description here. + BILLING_DATE_CHANGE: The enum member of type str. + COMPONENT_ALLOCATION_CHANGE: The enum member of type str. + CUSTOMER_CREATE: The enum member of type str. + CUSTOMER_UPDATE: The enum member of type str. + DUNNING_STEP_REACHED: The enum member of type str. + EXPIRING_CARD: The enum member of type str. + EXPIRATION_DATE_CHANGE: The enum member of type str. + INVOICE_ISSUED: The enum member of type str. + METERED_USAGE: The enum member of type str. + PAYMENT_FAILURE: The enum member of type str. + PAYMENT_SUCCESS: The enum member of type str. + DIRECT_DEBIT_PAYMENT_PENDING: The enum member of type str. + DIRECT_DEBIT_PAYMENT_PAID_OUT: The enum member of type str. + DIRECT_DEBIT_PAYMENT_REJECTED: The enum member of type str. + PREPAID_SUBSCRIPTION_BALANCE_CHANGED: The enum member of type str. + PREPAID_USAGE: The enum member of type str. + REFUND_FAILURE: The enum member of type str. + REFUND_SUCCESS: The enum member of type str. + RENEWAL_FAILURE: The enum member of type str. + RENEWAL_SUCCESS: The enum member of type str. + SIGNUP_FAILURE: The enum member of type str. + SIGNUP_SUCCESS: The enum member of type str. + STATEMENT_CLOSED: The enum member of type str. + STATEMENT_SETTLED: The enum member of type str. + SUBSCRIPTION_CARD_UPDATE: The enum member of type str. + SUBSCRIPTION_GROUP_CARD_UPDATE: The enum member of type str. + SUBSCRIPTION_PRODUCT_CHANGE: The enum member of type str. + SUBSCRIPTION_STATE_CHANGE: The enum member of type str. + TRIAL_END_NOTICE: The enum member of type str. + UPCOMING_RENEWAL_NOTICE: The enum member of type str. + UPGRADE_DOWNGRADE_FAILURE: The enum member of type str. + UPGRADE_DOWNGRADE_SUCCESS: The enum member of type str. + PENDING_CANCELLATION_CHANGE: The enum member of type str. + SUBSCRIPTION_PREPAYMENT_ACCOUNT_BALANCE_CHANGED: The enum member of + type str. + SUBSCRIPTION_SERVICE_CREDIT_ACCOUNT_BALANCE_CHANGED: The enum member + of type str. additional_properties (Dict[str, object]): The additional properties for the model. diff --git a/advancedbilling/utilities/file_wrapper.py b/advancedbilling/utilities/file_wrapper.py index 9076c460..bbad69a1 100644 --- a/advancedbilling/utilities/file_wrapper.py +++ b/advancedbilling/utilities/file_wrapper.py @@ -7,11 +7,21 @@ https://www.apimatic.io ). """ -from apimatic_core.types.file_wrapper import FileWrapper +from apimatic_core.types.file_wrapper import FileWrapper as CoreFileWrapper -class FileWrapper(FileWrapper): +class FileWrapper(CoreFileWrapper): """A wrapper to allow passing in content type for file uploads.""" def __init__(self, file, content_type='application/octet-stream'): super().__init__(file, content_type) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'file={self._file_stream!r}, ' + f'content_type={self.content_type!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'file={self._file_stream!s}, ' + f'content_type={self.content_type!s})') diff --git a/doc/controllers/events.md b/doc/controllers/events.md index 17187649..a2cd1803 100644 --- a/doc/controllers/events.md +++ b/doc/controllers/events.md @@ -97,8 +97,8 @@ def list_events(self, | --- | --- | --- | --- | | `page` | `int` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` | | `per_page` | `int` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` | -| `since_id` | `long\|int` | Query, Optional | Returns events with an id greater than or equal to the one specified | -| `max_id` | `long\|int` | Query, Optional | Returns events with an id less than or equal to the one specified | +| `since_id` | `int` | Query, Optional | Returns events with an id greater than or equal to the one specified | +| `max_id` | `int` | Query, Optional | Returns events with an id less than or equal to the one specified | | `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned events.
**Default**: `'desc'` | | `filter` | [`List[EventKey]`](../../doc/models/event-key.md) | Query, Optional | You can pass multiple event keys after comma.
Use in query `filter=signup_success,payment_success`. | | `date_field` | [`ListEventsDateField`](../../doc/models/list-events-date-field.md) | Query, Optional | The type of filter you would like to apply to your search. | @@ -216,8 +216,8 @@ def list_subscription_events(self, | `subscription_id` | `int` | Template, Required | The Chargify id of the subscription | | `page` | `int` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` | | `per_page` | `int` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` | -| `since_id` | `long\|int` | Query, Optional | Returns events with an id greater than or equal to the one specified | -| `max_id` | `long\|int` | Query, Optional | Returns events with an id less than or equal to the one specified | +| `since_id` | `int` | Query, Optional | Returns events with an id greater than or equal to the one specified | +| `max_id` | `int` | Query, Optional | Returns events with an id less than or equal to the one specified | | `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned events.
**Default**: `'desc'` | | `filter` | [`List[EventKey]`](../../doc/models/event-key.md) | Query, Optional | You can pass multiple event keys after comma.
Use in query `filter=signup_success,payment_success`. | @@ -300,8 +300,8 @@ def read_events_count(self, | --- | --- | --- | --- | | `page` | `int` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` | | `per_page` | `int` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` | -| `since_id` | `long\|int` | Query, Optional | Returns events with an id greater than or equal to the one specified | -| `max_id` | `long\|int` | Query, Optional | Returns events with an id less than or equal to the one specified | +| `since_id` | `int` | Query, Optional | Returns events with an id greater than or equal to the one specified | +| `max_id` | `int` | Query, Optional | Returns events with an id less than or equal to the one specified | | `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned events.
**Default**: `'desc'` | | `filter` | [`List[EventKey]`](../../doc/models/event-key.md) | Query, Optional | You can pass multiple event keys after comma.
Use in query `filter=signup_success,payment_success`. | diff --git a/doc/controllers/invoices.md b/doc/controllers/invoices.md index 2437a609..f6617dc1 100644 --- a/doc/controllers/invoices.md +++ b/doc/controllers/invoices.md @@ -618,7 +618,7 @@ def list_invoice_events(self, | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `since_date` | `str` | Query, Optional | The timestamp in a format `YYYY-MM-DD T HH:MM:SS Z`, or `YYYY-MM-DD`(in this case, it returns data from the beginning of the day). of the event from which you want to start the search. All the events before the `since_date` timestamp are not returned in the response. | -| `since_id` | `long\|int` | Query, Optional | The ID of the event from which you want to start the search(ID is not included. e.g. if ID is set to 2, then all events with ID 3 and more will be shown) This parameter is not used if since_date is defined. | +| `since_id` | `int` | Query, Optional | The ID of the event from which you want to start the search(ID is not included. e.g. if ID is set to 2, then all events with ID 3 and more will be shown) This parameter is not used if since_date is defined. | | `page` | `int` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` | | `per_page` | `int` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 100. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
**Default**: `100` | | `invoice_uid` | `str` | Query, Optional | Providing an invoice_uid allows for scoping of the invoice events to a single invoice or credit note. | diff --git a/doc/controllers/sites.md b/doc/controllers/sites.md index 74c18660..75c8a91d 100644 --- a/doc/controllers/sites.md +++ b/doc/controllers/sites.md @@ -62,6 +62,7 @@ result = sites_controller.read_site() "string" ], "relationship_invoicing_enabled": true, + "schedule_subscription_cancellation_enabled": true, "customer_hierarchy_enabled": true, "whopays_enabled": true, "whopays_default_payer": "string", diff --git a/doc/controllers/subscription-components.md b/doc/controllers/subscription-components.md index 01011991..372cc755 100644 --- a/doc/controllers/subscription-components.md +++ b/doc/controllers/subscription-components.md @@ -1176,8 +1176,8 @@ def list_usages(self, | --- | --- | --- | --- | | `subscription_id` | `int` | Template, Required | The Chargify id of the subscription | | `component_id` | int \| str | Template, Required | This is a container for one-of cases. | -| `since_id` | `long\|int` | Query, Optional | Returns usages with an id greater than or equal to the one specified | -| `max_id` | `long\|int` | Query, Optional | Returns usages with an id less than or equal to the one specified | +| `since_id` | `int` | Query, Optional | Returns usages with an id greater than or equal to the one specified | +| `max_id` | `int` | Query, Optional | Returns usages with an id less than or equal to the one specified | | `since_date` | `date` | Query, Optional | Returns usages with a created_at date greater than or equal to midnight (12:00 AM) on the date specified. | | `until_date` | `date` | Query, Optional | Returns usages with a created_at date less than or equal to midnight (12:00 AM) on the date specified. | | `page` | `int` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` | diff --git a/doc/controllers/subscription-invoice-account.md b/doc/controllers/subscription-invoice-account.md index 588a467d..2a727835 100644 --- a/doc/controllers/subscription-invoice-account.md +++ b/doc/controllers/subscription-invoice-account.md @@ -303,7 +303,7 @@ def refund_prepayment(self, | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `subscription_id` | `int` | Template, Required | The Chargify id of the subscription | -| `prepayment_id` | `long\|int` | Template, Required | id of prepayment | +| `prepayment_id` | `int` | Template, Required | id of prepayment | | `body` | [`RefundPrepaymentRequest`](../../doc/models/refund-prepayment-request.md) | Body, Optional | - | ## Response Type diff --git a/doc/models/account-balance.md b/doc/models/account-balance.md index 8018846c..24f50796 100644 --- a/doc/models/account-balance.md +++ b/doc/models/account-balance.md @@ -9,9 +9,9 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `balance_in_cents` | `long\|int` | Optional | The balance in cents. | -| `automatic_balance_in_cents` | `long\|int` | Optional | The automatic balance in cents. | -| `remittance_balance_in_cents` | `long\|int` | Optional | The remittance balance in cents. | +| `balance_in_cents` | `int` | Optional | The balance in cents. | +| `automatic_balance_in_cents` | `int` | Optional | The automatic balance in cents. | +| `remittance_balance_in_cents` | `int` | Optional | The remittance balance in cents. | ## Example (as JSON) diff --git a/doc/models/allocation-preview-line-item.md b/doc/models/allocation-preview-line-item.md index cdca0acf..88c8dee9 100644 --- a/doc/models/allocation-preview-line-item.md +++ b/doc/models/allocation-preview-line-item.md @@ -11,10 +11,10 @@ | --- | --- | --- | --- | | `transaction_type` | [`LineItemTransactionType`](../../doc/models/line-item-transaction-type.md) | Optional | A handle for the line item transaction type | | `kind` | [`AllocationPreviewLineItemKind`](../../doc/models/allocation-preview-line-item-kind.md) | Optional | A handle for the line item kind for allocation preview | -| `amount_in_cents` | `long\|int` | Optional | - | +| `amount_in_cents` | `int` | Optional | - | | `memo` | `str` | Optional | - | -| `discount_amount_in_cents` | `long\|int` | Optional | - | -| `taxable_amount_in_cents` | `long\|int` | Optional | - | +| `discount_amount_in_cents` | `int` | Optional | - | +| `taxable_amount_in_cents` | `int` | Optional | - | | `component_id` | `int` | Optional | - | | `component_handle` | `str` | Optional | - | | `direction` | [`AllocationPreviewDirection`](../../doc/models/allocation-preview-direction.md) | Optional | Visible when using Fine-grained Component Control | diff --git a/doc/models/allocation-preview.md b/doc/models/allocation-preview.md index 2ff49084..7931ff55 100644 --- a/doc/models/allocation-preview.md +++ b/doc/models/allocation-preview.md @@ -11,17 +11,17 @@ | --- | --- | --- | --- | | `start_date` | `datetime` | Optional | - | | `end_date` | `datetime` | Optional | - | -| `subtotal_in_cents` | `long\|int` | Optional | - | -| `total_tax_in_cents` | `long\|int` | Optional | - | -| `total_discount_in_cents` | `long\|int` | Optional | - | -| `total_in_cents` | `long\|int` | Optional | - | +| `subtotal_in_cents` | `int` | Optional | - | +| `total_tax_in_cents` | `int` | Optional | - | +| `total_discount_in_cents` | `int` | Optional | - | +| `total_in_cents` | `int` | Optional | - | | `direction` | [`AllocationPreviewDirection`](../../doc/models/allocation-preview-direction.md) | Optional | - | | `proration_scheme` | `str` | Optional | - | | `line_items` | [`List[AllocationPreviewLineItem]`](../../doc/models/allocation-preview-line-item.md) | Optional | - | | `accrue_charge` | `bool` | Optional | - | | `allocations` | [`List[AllocationPreviewItem]`](../../doc/models/allocation-preview-item.md) | Optional | - | | `period_type` | `str` | Optional | - | -| `existing_balance_in_cents` | `long\|int` | Optional | An integer representing the amount of the subscription's current balance | +| `existing_balance_in_cents` | `int` | Optional | An integer representing the amount of the subscription's current balance | ## Example (as JSON) diff --git a/doc/models/allocation.md b/doc/models/allocation.md index 157ed25c..deb8421e 100644 --- a/doc/models/allocation.md +++ b/doc/models/allocation.md @@ -32,8 +32,8 @@ | `downgrade_credit` | [`CreditType`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | | `payment` | [`PaymentForAllocation`](../../doc/models/payment-for-allocation.md) | Optional | - | | `expires_at` | `datetime` | Optional | - | -| `used_quantity` | `long\|int` | Optional | - | -| `charge_id` | `long\|int` | Optional | - | +| `used_quantity` | `int` | Optional | - | +| `charge_id` | `int` | Optional | - | ## Example (as JSON) diff --git a/doc/models/apply-credit-note-event.md b/doc/models/apply-credit-note-event.md index 2908fa00..8714576b 100644 --- a/doc/models/apply-credit-note-event.md +++ b/doc/models/apply-credit-note-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'apply_credit_note'` | diff --git a/doc/models/apply-debit-note-event.md b/doc/models/apply-debit-note-event.md index 7e384efe..98585372 100644 --- a/doc/models/apply-debit-note-event.md +++ b/doc/models/apply-debit-note-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'apply_debit_note'` | diff --git a/doc/models/apply-payment-event.md b/doc/models/apply-payment-event.md index d6c65039..11a3d71c 100644 --- a/doc/models/apply-payment-event.md +++ b/doc/models/apply-payment-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'apply_payment'` | diff --git a/doc/models/backport-invoice-event.md b/doc/models/backport-invoice-event.md index ec98dc92..d9899c32 100644 --- a/doc/models/backport-invoice-event.md +++ b/doc/models/backport-invoice-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'backport_invoice'` | diff --git a/doc/models/bank-account-verification.md b/doc/models/bank-account-verification.md index d1e394a1..290d21ba 100644 --- a/doc/models/bank-account-verification.md +++ b/doc/models/bank-account-verification.md @@ -9,8 +9,8 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `deposit_1_in_cents` | `long\|int` | Optional | - | -| `deposit_2_in_cents` | `long\|int` | Optional | - | +| `deposit_1_in_cents` | `int` | Optional | - | +| `deposit_2_in_cents` | `int` | Optional | - | ## Example (as JSON) diff --git a/doc/models/billing-manifest-item.md b/doc/models/billing-manifest-item.md index abc2505c..2b8bc37f 100644 --- a/doc/models/billing-manifest-item.md +++ b/doc/models/billing-manifest-item.md @@ -11,10 +11,10 @@ | --- | --- | --- | --- | | `transaction_type` | [`LineItemTransactionType`](../../doc/models/line-item-transaction-type.md) | Optional | A handle for the line item transaction type | | `kind` | [`BillingManifestLineItemKind`](../../doc/models/billing-manifest-line-item-kind.md) | Optional | A handle for the billing manifest line item kind | -| `amount_in_cents` | `long\|int` | Optional | - | +| `amount_in_cents` | `int` | Optional | - | | `memo` | `str` | Optional | - | -| `discount_amount_in_cents` | `long\|int` | Optional | - | -| `taxable_amount_in_cents` | `long\|int` | Optional | - | +| `discount_amount_in_cents` | `int` | Optional | - | +| `taxable_amount_in_cents` | `int` | Optional | - | | `component_id` | `int` | Optional | - | | `component_handle` | `str` | Optional | - | | `component_name` | `str` | Optional | - | diff --git a/doc/models/billing-manifest.md b/doc/models/billing-manifest.md index 91250360..a47a83c3 100644 --- a/doc/models/billing-manifest.md +++ b/doc/models/billing-manifest.md @@ -10,14 +10,14 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `line_items` | [`List[BillingManifestItem]`](../../doc/models/billing-manifest-item.md) | Optional | - | -| `total_in_cents` | `long\|int` | Optional | - | -| `total_discount_in_cents` | `long\|int` | Optional | - | -| `total_tax_in_cents` | `long\|int` | Optional | - | -| `subtotal_in_cents` | `long\|int` | Optional | - | +| `total_in_cents` | `int` | Optional | - | +| `total_discount_in_cents` | `int` | Optional | - | +| `total_tax_in_cents` | `int` | Optional | - | +| `subtotal_in_cents` | `int` | Optional | - | | `start_date` | `datetime` | Optional | - | | `end_date` | `datetime` | Optional | - | | `period_type` | `str` | Optional | - | -| `existing_balance_in_cents` | `long\|int` | Optional | - | +| `existing_balance_in_cents` | `int` | Optional | - | ## Example (as JSON) diff --git a/doc/models/breakouts.md b/doc/models/breakouts.md index 555af231..20795702 100644 --- a/doc/models/breakouts.md +++ b/doc/models/breakouts.md @@ -9,9 +9,9 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `plan_amount_in_cents` | `long\|int` | Optional | - | +| `plan_amount_in_cents` | `int` | Optional | - | | `plan_amount_formatted` | `str` | Optional | - | -| `usage_amount_in_cents` | `long\|int` | Optional | - | +| `usage_amount_in_cents` | `int` | Optional | - | | `usage_amount_formatted` | `str` | Optional | - | ## Example (as JSON) diff --git a/doc/models/change-chargeback-status-event.md b/doc/models/change-chargeback-status-event.md index 2278f63d..4d4a8909 100644 --- a/doc/models/change-chargeback-status-event.md +++ b/doc/models/change-chargeback-status-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'change_chargeback_status'` | diff --git a/doc/models/change-invoice-collection-method-event.md b/doc/models/change-invoice-collection-method-event.md index a646b4b6..41043264 100644 --- a/doc/models/change-invoice-collection-method-event.md +++ b/doc/models/change-invoice-collection-method-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'change_invoice_collection_method'` | diff --git a/doc/models/change-invoice-status-event.md b/doc/models/change-invoice-status-event.md index d8276289..d14b45e2 100644 --- a/doc/models/change-invoice-status-event.md +++ b/doc/models/change-invoice-status-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'change_invoice_status'` | diff --git a/doc/models/component.md b/doc/models/component.md index ae95b26a..933bf15e 100644 --- a/doc/models/component.md +++ b/doc/models/component.md @@ -17,7 +17,7 @@ | `unit_price` | `str` | Optional | The amount the customer will be charged per unit. This field is only populated for ‘per_unit’ pricing schemes, otherwise it may be null. | | `product_family_id` | `int` | Optional | The id of the Product Family to which the Component belongs | | `product_family_name` | `str` | Optional | The name of the Product Family to which the Component belongs | -| `price_per_unit_in_cents` | `long\|int` | Optional | deprecated - use unit_price instead | +| `price_per_unit_in_cents` | `int` | Optional | deprecated - use unit_price instead | | `kind` | [`ComponentKind`](../../doc/models/component-kind.md) | Optional | A handle for the component type | | `archived` | `bool` | Optional | Boolean flag describing whether a component is archived or not. | | `taxable` | `bool` | Optional | Boolean flag describing whether a component is taxable or not. | diff --git a/doc/models/containers/subscription-custom-price-initial-charge-in-cents.md b/doc/models/containers/subscription-custom-price-initial-charge-in-cents.md index 87ab9d12..f3793721 100644 --- a/doc/models/containers/subscription-custom-price-initial-charge-in-cents.md +++ b/doc/models/containers/subscription-custom-price-initial-charge-in-cents.md @@ -3,12 +3,12 @@ ## Data Type -`str | long | int` +`str | int` ## Cases | Type | | --- | | `str` | -| `long\|int` | +| `int` | diff --git a/doc/models/containers/subscription-custom-price-price-in-cents.md b/doc/models/containers/subscription-custom-price-price-in-cents.md index 1a77bcac..9eb49903 100644 --- a/doc/models/containers/subscription-custom-price-price-in-cents.md +++ b/doc/models/containers/subscription-custom-price-price-in-cents.md @@ -3,12 +3,12 @@ ## Data Type -`str | long | int` +`str | int` ## Cases | Type | | --- | | `str` | -| `long\|int` | +| `int` | diff --git a/doc/models/containers/subscription-custom-price-trial-price-in-cents.md b/doc/models/containers/subscription-custom-price-trial-price-in-cents.md index f369dad5..524b09f9 100644 --- a/doc/models/containers/subscription-custom-price-trial-price-in-cents.md +++ b/doc/models/containers/subscription-custom-price-trial-price-in-cents.md @@ -3,12 +3,12 @@ ## Data Type -`str | long | int` +`str | int` ## Cases | Type | | --- | | `str` | -| `long\|int` | +| `int` | diff --git a/doc/models/coupon-payload.md b/doc/models/coupon-payload.md index 6b93d518..23b4c07e 100644 --- a/doc/models/coupon-payload.md +++ b/doc/models/coupon-payload.md @@ -13,7 +13,7 @@ | `code` | `str` | Optional | Required when creating a new coupon. The code is limited to 255 characters. May contain uppercase alphanumeric characters and these special characters (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and “.” | | `description` | `str` | Optional | Required when creating a new coupon. A description of the coupon that can be displayed to customers in transactions and on statements. The description is limited to 255 characters. | | `percentage` | str \| float \| None | Optional | This is a container for one-of cases. | -| `amount_in_cents` | `long\|int` | Optional | Required when creating a new flat amount coupon. Can't be used together with percentage. Flat USD discount | +| `amount_in_cents` | `int` | Optional | Required when creating a new flat amount coupon. Can't be used together with percentage. Flat USD discount | | `allow_negative_balance` | `bool` | Optional | If set to true, discount is not limited (credits will carry forward to next billing). Can't be used together with restrictions. | | `recurring` | `bool` | Optional | - | | `end_date` | `date` | Optional | After the end of the given day, this coupon code will be invalid for new signups. Recurring discounts started before this date will continue to recur even after this date. | diff --git a/doc/models/coupon-usage.md b/doc/models/coupon-usage.md index a995d67b..31c5aaf8 100644 --- a/doc/models/coupon-usage.md +++ b/doc/models/coupon-usage.md @@ -13,9 +13,9 @@ | `name` | `str` | Optional | Name of the product | | `signups` | `int` | Optional | Number of times the coupon has been applied | | `savings` | `int` | Optional | Dollar amount of customer savings as a result of the coupon. | -| `savings_in_cents` | `long\|int` | Optional | Dollar amount of customer savings as a result of the coupon. | +| `savings_in_cents` | `int` | Optional | Dollar amount of customer savings as a result of the coupon. | | `revenue` | `int` | Optional | Total revenue of the all subscriptions that have received a discount from this coupon. | -| `revenue_in_cents` | `long\|int` | Optional | Total revenue of the all subscriptions that have received a discount from this coupon. | +| `revenue_in_cents` | `int` | Optional | Total revenue of the all subscriptions that have received a discount from this coupon. | ## Example (as JSON) diff --git a/doc/models/coupon.md b/doc/models/coupon.md index ad8432cb..3e5caf06 100644 --- a/doc/models/coupon.md +++ b/doc/models/coupon.md @@ -14,7 +14,7 @@ | `code` | `str` | Optional | - | | `description` | `str` | Optional | - | | `amount` | `float` | Optional | - | -| `amount_in_cents` | `long\|int` | Optional | - | +| `amount_in_cents` | `int` | Optional | - | | `product_family_id` | `int` | Optional | - | | `product_family_name` | `str` | Optional | - | | `start_date` | `datetime` | Optional | - | diff --git a/doc/models/create-credit-note-event.md b/doc/models/create-credit-note-event.md index 39e01324..a98171cd 100644 --- a/doc/models/create-credit-note-event.md +++ b/doc/models/create-credit-note-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'create_credit_note'` | diff --git a/doc/models/create-debit-note-event.md b/doc/models/create-debit-note-event.md index 65ddf108..e24870b0 100644 --- a/doc/models/create-debit-note-event.md +++ b/doc/models/create-debit-note-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'create_debit_note'` | diff --git a/doc/models/create-or-update-product.md b/doc/models/create-or-update-product.md index ef0aaf89..3b1f4ff7 100644 --- a/doc/models/create-or-update-product.md +++ b/doc/models/create-or-update-product.md @@ -14,10 +14,10 @@ | `description` | `str` | Required | The product description | | `accounting_code` | `str` | Optional | E.g. Internal ID or SKU Number | | `require_credit_card` | `bool` | Optional | Deprecated value that can be ignored unless you have legacy hosted pages. For Public Signup Page users, please read this attribute from under the signup page. | -| `price_in_cents` | `long\|int` | Required | The product price, in integer cents | +| `price_in_cents` | `int` | Required | The product price, in integer cents | | `interval` | `int` | Required | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this product would renew every 30 days | | `interval_unit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Required | A string representing the interval unit for this product, either month or day | -| `trial_price_in_cents` | `long\|int` | Optional | The product trial price, in integer cents | +| `trial_price_in_cents` | `int` | Optional | The product trial price, in integer cents | | `trial_interval` | `int` | Optional | The numerical trial interval. i.e. an interval of ‘30’ coupled with a trial_interval_unit of day would mean this product trial would last 30 days. | | `trial_interval_unit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Optional | A string representing the trial interval unit for this product, either month or day | | `trial_type` | `str` | Optional | - | diff --git a/doc/models/create-product-price-point.md b/doc/models/create-product-price-point.md index 8e1e7c92..43dd114b 100644 --- a/doc/models/create-product-price-point.md +++ b/doc/models/create-product-price-point.md @@ -11,14 +11,14 @@ | --- | --- | --- | --- | | `name` | `str` | Required | The product price point name | | `handle` | `str` | Optional | The product price point API handle | -| `price_in_cents` | `long\|int` | Required | The product price point price, in integer cents | +| `price_in_cents` | `int` | Required | The product price point price, in integer cents | | `interval` | `int` | Required | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this product price point would renew every 30 days | | `interval_unit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Required | A string representing the interval unit for this product price point, either month or day | -| `trial_price_in_cents` | `long\|int` | Optional | The product price point trial price, in integer cents | +| `trial_price_in_cents` | `int` | Optional | The product price point trial price, in integer cents | | `trial_interval` | `int` | Optional | The numerical trial interval. i.e. an interval of ‘30’ coupled with a trial_interval_unit of day would mean this product price point trial would last 30 days. | | `trial_interval_unit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Optional | A string representing the trial interval unit for this product price point, either month or day | | `trial_type` | `str` | Optional | - | -| `initial_charge_in_cents` | `long\|int` | Optional | The product price point initial charge, in integer cents | +| `initial_charge_in_cents` | `int` | Optional | The product price point initial charge, in integer cents | | `initial_charge_after_trial` | `bool` | Optional | - | | `expiration_interval` | `int` | Optional | The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product price point would expire after 30 days. | | `expiration_interval_unit` | [`ExpirationIntervalUnit`](../../doc/models/expiration-interval-unit.md) | Optional | A string representing the expiration interval unit for this product price point, either month, day or never | diff --git a/doc/models/created-prepayment.md b/doc/models/created-prepayment.md index 0d3dfe0e..1ebdac9a 100644 --- a/doc/models/created-prepayment.md +++ b/doc/models/created-prepayment.md @@ -9,13 +9,13 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Optional | **Constraints**: `>= 1` | +| `id` | `int` | Optional | **Constraints**: `>= 1` | | `subscription_id` | `int` | Optional | **Constraints**: `>= 1` | -| `amount_in_cents` | `long\|int` | Optional | **Constraints**: `>= 0.01` | +| `amount_in_cents` | `int` | Optional | **Constraints**: `>= 0.01` | | `memo` | `str` | Optional | - | | `created_at` | `datetime` | Optional | - | -| `starting_balance_in_cents` | `long\|int` | Optional | **Constraints**: `>= 0` | -| `ending_balance_in_cents` | `long\|int` | Optional | - | +| `starting_balance_in_cents` | `int` | Optional | **Constraints**: `>= 0` | +| `ending_balance_in_cents` | `int` | Optional | - | ## Example (as JSON) diff --git a/doc/models/credit-account-balance-changed.md b/doc/models/credit-account-balance-changed.md index d1c37e1d..8eb2384c 100644 --- a/doc/models/credit-account-balance-changed.md +++ b/doc/models/credit-account-balance-changed.md @@ -10,8 +10,8 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `reason` | `str` | Required | - | -| `service_credit_account_balance_in_cents` | `long\|int` | Required | - | -| `service_credit_balance_change_in_cents` | `long\|int` | Required | - | +| `service_credit_account_balance_in_cents` | `int` | Required | - | +| `service_credit_balance_change_in_cents` | `int` | Required | - | | `currency_code` | `str` | Required | - | | `at_time` | `datetime` | Required | - | diff --git a/doc/models/dunner-data.md b/doc/models/dunner-data.md index 893931b7..3f797eaa 100644 --- a/doc/models/dunner-data.md +++ b/doc/models/dunner-data.md @@ -11,7 +11,7 @@ | --- | --- | --- | --- | | `state` | `str` | Required | - | | `subscription_id` | `int` | Required | - | -| `revenue_at_risk_in_cents` | `long\|int` | Required | - | +| `revenue_at_risk_in_cents` | `int` | Required | - | | `created_at` | `datetime` | Required | - | | `attempts` | `int` | Required | - | | `last_attempted_at` | `datetime` | Required | - | diff --git a/doc/models/event.md b/doc/models/event.md index 36798eb0..07f21b65 100644 --- a/doc/models/event.md +++ b/doc/models/event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `key` | [`EventKey`](../../doc/models/event-key.md) | Required | - | | `message` | `str` | Required | **Constraints**: *Minimum Length*: `1` | | `subscription_id` | `int` | Required | - | diff --git a/doc/models/failed-payment-event.md b/doc/models/failed-payment-event.md index e7cbf69a..e0ff2bd4 100644 --- a/doc/models/failed-payment-event.md +++ b/doc/models/failed-payment-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'failed_payment'` | diff --git a/doc/models/full-subscription-group-response.md b/doc/models/full-subscription-group-response.md index a6086016..0799d8d0 100644 --- a/doc/models/full-subscription-group-response.md +++ b/doc/models/full-subscription-group-response.md @@ -18,7 +18,7 @@ | `next_assessment_at` | `datetime` | Optional | - | | `state` | [`SubscriptionState`](../../doc/models/subscription-state.md) | Optional | The state of a subscription.

* **Live States**
* `active` - A normal, active subscription. It is not in a trial and is paid and up to date.
* `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
* `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.
* **Problem States**
* `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
* `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.
* `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) settings to have a Final Action of `mark the subscription unpaid`.
* **End of Life States**
* `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.
* `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.
* `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)
* `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.
* `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.
* `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing) for more details.

See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscription-States) for more info about subscription states and state transitions. | | `cancel_at_end_of_period` | `bool` | Optional | - | -| `current_billing_amount_in_cents` | `long\|int` | Optional | - | +| `current_billing_amount_in_cents` | `int` | Optional | - | | `customer` | [`SubscriptionGroupCustomer`](../../doc/models/subscription-group-customer.md) | Optional | - | | `account_balances` | [`SubscriptionGroupBalances`](../../doc/models/subscription-group-balances.md) | Optional | - | diff --git a/doc/models/invoice-avatax-details.md b/doc/models/invoice-avatax-details.md index 4b42eb8e..2324f74f 100644 --- a/doc/models/invoice-avatax-details.md +++ b/doc/models/invoice-avatax-details.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Optional | - | +| `id` | `int` | Optional | - | | `status` | `str` | Optional | - | | `document_code` | `str` | Optional | - | | `commit_date` | `datetime` | Optional | - | diff --git a/doc/models/invoice-pre-payment.md b/doc/models/invoice-pre-payment.md index 5da09272..16a07b0c 100644 --- a/doc/models/invoice-pre-payment.md +++ b/doc/models/invoice-pre-payment.md @@ -10,8 +10,8 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `subscription_id` | `int` | Optional | The subscription id for the prepayment account | -| `amount_in_cents` | `long\|int` | Optional | The amount in cents of the prepayment that was created as a result of this payment. | -| `ending_balance_in_cents` | `long\|int` | Optional | The total balance of the prepayment account for this subscription including any prior prepayments | +| `amount_in_cents` | `int` | Optional | The amount in cents of the prepayment that was created as a result of this payment. | +| `ending_balance_in_cents` | `int` | Optional | The total balance of the prepayment account for this subscription including any prior prepayments | ## Example (as JSON) diff --git a/doc/models/invoice.md b/doc/models/invoice.md index 7d88514d..a2740033 100644 --- a/doc/models/invoice.md +++ b/doc/models/invoice.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Optional | - | +| `id` | `int` | Optional | - | | `uid` | `str` | Optional | Unique identifier for the invoice. It is generated automatically by Chargify and has the prefix "inv_" followed by alphanumeric characters. | | `site_id` | `int` | Optional | ID of the site to which the invoice belongs. | | `customer_id` | `int` | Optional | ID of the customer to which the invoice belongs. | diff --git a/doc/models/issue-invoice-event.md b/doc/models/issue-invoice-event.md index d1328933..6f0054bf 100644 --- a/doc/models/issue-invoice-event.md +++ b/doc/models/issue-invoice-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'issue_invoice'` | diff --git a/doc/models/list-subcription-group-prepayment-item.md b/doc/models/list-subcription-group-prepayment-item.md index 8e75b619..a29ab45c 100644 --- a/doc/models/list-subcription-group-prepayment-item.md +++ b/doc/models/list-subcription-group-prepayment-item.md @@ -11,8 +11,8 @@ | --- | --- | --- | --- | | `id` | `int` | Optional | - | | `subscription_group_uid` | `str` | Optional | - | -| `amount_in_cents` | `long\|int` | Optional | - | -| `remaining_amount_in_cents` | `long\|int` | Optional | - | +| `amount_in_cents` | `int` | Optional | - | +| `remaining_amount_in_cents` | `int` | Optional | - | | `details` | `str` | Optional | - | | `external` | `bool` | Optional | - | | `memo` | `str` | Optional | - | diff --git a/doc/models/movement.md b/doc/models/movement.md index 35955a92..c6f5daa0 100644 --- a/doc/models/movement.md +++ b/doc/models/movement.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `timestamp` | `datetime` | Optional | - | -| `amount_in_cents` | `long\|int` | Optional | - | +| `amount_in_cents` | `int` | Optional | - | | `amount_formatted` | `str` | Optional | - | | `description` | `str` | Optional | - | | `category` | `str` | Optional | - | diff --git a/doc/models/mrr.md b/doc/models/mrr.md index 7a81ab4d..8294207c 100644 --- a/doc/models/mrr.md +++ b/doc/models/mrr.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `amount_in_cents` | `long\|int` | Optional | - | +| `amount_in_cents` | `int` | Optional | - | | `amount_formatted` | `str` | Optional | - | | `currency` | `str` | Optional | - | | `currency_symbol` | `str` | Optional | - | diff --git a/doc/models/offer.md b/doc/models/offer.md index bbedfc07..38a2676a 100644 --- a/doc/models/offer.md +++ b/doc/models/offer.md @@ -26,7 +26,7 @@ | `product_family_name` | `str` | Optional | - | | `product_name` | `str` | Optional | - | | `product_price_point_name` | `str` | Optional | - | -| `product_price_in_cents` | `long\|int` | Optional | - | +| `product_price_in_cents` | `int` | Optional | - | | `offer_signup_pages` | [`List[OfferSignupPage]`](../../doc/models/offer-signup-page.md) | Optional | - | ## Example (as JSON) diff --git a/doc/models/payment-for-allocation.md b/doc/models/payment-for-allocation.md index fa2ffc31..24f7f298 100644 --- a/doc/models/payment-for-allocation.md +++ b/doc/models/payment-for-allocation.md @@ -12,7 +12,7 @@ Information for captured payment, if applicable | Name | Type | Tags | Description | | --- | --- | --- | --- | | `id` | `int` | Optional | - | -| `amount_in_cents` | `long\|int` | Optional | - | +| `amount_in_cents` | `int` | Optional | - | | `success` | `bool` | Optional | - | | `memo` | `str` | Optional | - | diff --git a/doc/models/prepaid-configuration.md b/doc/models/prepaid-configuration.md index f6bd79c7..f74657e5 100644 --- a/doc/models/prepaid-configuration.md +++ b/doc/models/prepaid-configuration.md @@ -10,10 +10,10 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `id` | `int` | Optional | - | -| `initial_funding_amount_in_cents` | `long\|int` | Optional | - | -| `replenish_to_amount_in_cents` | `long\|int` | Optional | - | +| `initial_funding_amount_in_cents` | `int` | Optional | - | +| `replenish_to_amount_in_cents` | `int` | Optional | - | | `auto_replenish` | `bool` | Optional | - | -| `replenish_threshold_amount_in_cents` | `long\|int` | Optional | - | +| `replenish_threshold_amount_in_cents` | `int` | Optional | - | ## Example (as JSON) diff --git a/doc/models/prepaid-product-price-point-filter.md b/doc/models/prepaid-product-price-point-filter.md index 4a9cd134..757f11b7 100644 --- a/doc/models/prepaid-product-price-point-filter.md +++ b/doc/models/prepaid-product-price-point-filter.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `product_price_point_id` | `str` | Required, Constant | Passed as a parameter to list methods to return only non null values.
**Default**: `'not_null'` | +| `product_price_point_id` | `str` | Required, Constant | Passed as a parameter to list methods to return only non null values.
**Value**: `'not_null'` | ## Example (as JSON) diff --git a/doc/models/prepaid-subscription-balance-changed.md b/doc/models/prepaid-subscription-balance-changed.md index ac506912..923a2c03 100644 --- a/doc/models/prepaid-subscription-balance-changed.md +++ b/doc/models/prepaid-subscription-balance-changed.md @@ -10,9 +10,9 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `reason` | `str` | Required | - | -| `current_account_balance_in_cents` | `long\|int` | Required | - | -| `prepayment_account_balance_in_cents` | `long\|int` | Required | - | -| `current_usage_amount_in_cents` | `long\|int` | Required | - | +| `current_account_balance_in_cents` | `int` | Required | - | +| `prepayment_account_balance_in_cents` | `int` | Required | - | +| `current_usage_amount_in_cents` | `int` | Required | - | ## Example (as JSON) diff --git a/doc/models/prepayment-account-balance-changed.md b/doc/models/prepayment-account-balance-changed.md index 344dc96d..4343e35e 100644 --- a/doc/models/prepayment-account-balance-changed.md +++ b/doc/models/prepayment-account-balance-changed.md @@ -10,8 +10,8 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `reason` | `str` | Required | - | -| `prepayment_account_balance_in_cents` | `long\|int` | Required | - | -| `prepayment_balance_change_in_cents` | `long\|int` | Required | - | +| `prepayment_account_balance_in_cents` | `int` | Required | - | +| `prepayment_balance_change_in_cents` | `int` | Required | - | | `currency_code` | `str` | Required | - | ## Example (as JSON) diff --git a/doc/models/prepayment.md b/doc/models/prepayment.md index a4560a43..dabe5d3d 100644 --- a/doc/models/prepayment.md +++ b/doc/models/prepayment.md @@ -11,9 +11,9 @@ | --- | --- | --- | --- | | `id` | `int` | Required | - | | `subscription_id` | `int` | Required | - | -| `amount_in_cents` | `long\|int` | Required | - | -| `remaining_amount_in_cents` | `long\|int` | Required | - | -| `refunded_amount_in_cents` | `long\|int` | Optional | - | +| `amount_in_cents` | `int` | Required | - | +| `remaining_amount_in_cents` | `int` | Required | - | +| `refunded_amount_in_cents` | `int` | Optional | - | | `details` | `str` | Optional | **Constraints**: *Minimum Length*: `1` | | `external` | `bool` | Required | - | | `memo` | `str` | Required | **Constraints**: *Minimum Length*: `1` | diff --git a/doc/models/product-price-point.md b/doc/models/product-price-point.md index 5d2407cc..6ac82941 100644 --- a/doc/models/product-price-point.md +++ b/doc/models/product-price-point.md @@ -12,15 +12,15 @@ | `id` | `int` | Optional | - | | `name` | `str` | Optional | The product price point name | | `handle` | `str` | Optional | The product price point API handle | -| `price_in_cents` | `long\|int` | Optional | The product price point price, in integer cents | +| `price_in_cents` | `int` | Optional | The product price point price, in integer cents | | `interval` | `int` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this product price point would renew every 30 days | | `interval_unit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this product price point, either month or day | -| `trial_price_in_cents` | `long\|int` | Optional | The product price point trial price, in integer cents | +| `trial_price_in_cents` | `int` | Optional | The product price point trial price, in integer cents | | `trial_interval` | `int` | Optional | The numerical trial interval. i.e. an interval of ‘30’ coupled with a trial_interval_unit of day would mean this product price point trial would last 30 days | | `trial_interval_unit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Optional | A string representing the trial interval unit for this product price point, either month or day | | `trial_type` | `str` | Optional | - | | `introductory_offer` | `bool` | Optional | reserved for future use | -| `initial_charge_in_cents` | `long\|int` | Optional | The product price point initial charge, in integer cents | +| `initial_charge_in_cents` | `int` | Optional | The product price point initial charge, in integer cents | | `initial_charge_after_trial` | `bool` | Optional | - | | `expiration_interval` | `int` | Optional | The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product price point would expire after 30 days | | `expiration_interval_unit` | [`ExpirationIntervalUnit`](../../doc/models/expiration-interval-unit.md) | Optional | A string representing the expiration interval unit for this product price point, either month, day or never | diff --git a/doc/models/product.md b/doc/models/product.md index 0dfdddca..557c8b03 100644 --- a/doc/models/product.md +++ b/doc/models/product.md @@ -19,11 +19,11 @@ | `expiration_interval_unit` | [`ExpirationIntervalUnit`](../../doc/models/expiration-interval-unit.md) | Optional | A string representing the expiration interval unit for this product, either month, day or never | | `created_at` | `datetime` | Optional | Timestamp indicating when this product was created | | `updated_at` | `datetime` | Optional | Timestamp indicating when this product was last updated | -| `price_in_cents` | `long\|int` | Optional | The product price, in integer cents | +| `price_in_cents` | `int` | Optional | The product price, in integer cents | | `interval` | `int` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this product would renew every 30 days | | `interval_unit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this product, either month or day | -| `initial_charge_in_cents` | `long\|int` | Optional | The up front charge you have specified. | -| `trial_price_in_cents` | `long\|int` | Optional | The price of the trial period for a subscription to this product, in integer cents. | +| `initial_charge_in_cents` | `int` | Optional | The up front charge you have specified. | +| `trial_price_in_cents` | `int` | Optional | The price of the trial period for a subscription to this product, in integer cents. | | `trial_interval` | `int` | Optional | A numerical interval for the length of the trial period of a subscription to this product. See the description of interval for a description of how this value is coupled with an interval unit to calculate the full interval | | `trial_interval_unit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Optional | A string representing the trial interval unit for this product, either month or day | | `archived_at` | `datetime` | Optional | Timestamp indicating when this product was archived | diff --git a/doc/models/refund-invoice-event.md b/doc/models/refund-invoice-event.md index 21b5b23e..cad9d2bb 100644 --- a/doc/models/refund-invoice-event.md +++ b/doc/models/refund-invoice-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'refund_invoice'` | diff --git a/doc/models/refund-prepayment.md b/doc/models/refund-prepayment.md index 745766ec..08d76c5a 100644 --- a/doc/models/refund-prepayment.md +++ b/doc/models/refund-prepayment.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `amount_in_cents` | `long\|int` | Required | `amount` is not required if you pass `amount_in_cents`. | +| `amount_in_cents` | `int` | Required | `amount` is not required if you pass `amount_in_cents`. | | `amount` | str \| float | Required | This is a container for one-of cases. | | `memo` | `str` | Required | **Constraints**: *Minimum Length*: `1` | | `external` | `bool` | Optional | Specify the type of refund you wish to initiate. When the prepayment is external, the `external` flag is optional. But if the prepayment was made through a payment profile, the `external` flag is required. | diff --git a/doc/models/remove-payment-event.md b/doc/models/remove-payment-event.md index d54ca7d1..bc4db9e6 100644 --- a/doc/models/remove-payment-event.md +++ b/doc/models/remove-payment-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'remove_payment'` | diff --git a/doc/models/renewal-preview-line-item.md b/doc/models/renewal-preview-line-item.md index 4bad4136..c8469a7e 100644 --- a/doc/models/renewal-preview-line-item.md +++ b/doc/models/renewal-preview-line-item.md @@ -11,10 +11,10 @@ | --- | --- | --- | --- | | `transaction_type` | [`LineItemTransactionType`](../../doc/models/line-item-transaction-type.md) | Optional | A handle for the line item transaction type | | `kind` | [`LineItemKind`](../../doc/models/line-item-kind.md) | Optional | A handle for the line item kind | -| `amount_in_cents` | `long\|int` | Optional | - | +| `amount_in_cents` | `int` | Optional | - | | `memo` | `str` | Optional | - | -| `discount_amount_in_cents` | `long\|int` | Optional | - | -| `taxable_amount_in_cents` | `long\|int` | Optional | - | +| `discount_amount_in_cents` | `int` | Optional | - | +| `taxable_amount_in_cents` | `int` | Optional | - | | `product_id` | `int` | Optional | - | | `product_name` | `str` | Optional | - | | `component_id` | `int` | Optional | - | diff --git a/doc/models/renewal-preview.md b/doc/models/renewal-preview.md index 634b9f72..73d54a04 100644 --- a/doc/models/renewal-preview.md +++ b/doc/models/renewal-preview.md @@ -10,12 +10,12 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `next_assessment_at` | `datetime` | Optional | The timestamp for the subscription’s next renewal | -| `subtotal_in_cents` | `long\|int` | Optional | An integer representing the amount of the total pre-tax, pre-discount charges that will be assessed at the next renewal | -| `total_tax_in_cents` | `long\|int` | Optional | An integer representing the total tax charges that will be assessed at the next renewal | -| `total_discount_in_cents` | `long\|int` | Optional | An integer representing the amount of the coupon discounts that will be applied to the next renewal | -| `total_in_cents` | `long\|int` | Optional | An integer representing the total amount owed, less any discounts, that will be assessed at the next renewal | -| `existing_balance_in_cents` | `long\|int` | Optional | An integer representing the amount of the subscription’s current balance | -| `total_amount_due_in_cents` | `long\|int` | Optional | An integer representing the existing_balance_in_cents plus the total_in_cents | +| `subtotal_in_cents` | `int` | Optional | An integer representing the amount of the total pre-tax, pre-discount charges that will be assessed at the next renewal | +| `total_tax_in_cents` | `int` | Optional | An integer representing the total tax charges that will be assessed at the next renewal | +| `total_discount_in_cents` | `int` | Optional | An integer representing the amount of the coupon discounts that will be applied to the next renewal | +| `total_in_cents` | `int` | Optional | An integer representing the total amount owed, less any discounts, that will be assessed at the next renewal | +| `existing_balance_in_cents` | `int` | Optional | An integer representing the amount of the subscription’s current balance | +| `total_amount_due_in_cents` | `int` | Optional | An integer representing the existing_balance_in_cents plus the total_in_cents | | `uncalculated_taxes` | `bool` | Optional | A boolean indicating whether or not additional taxes will be calculated at the time of renewal. This will be true if you are using Avalara and the address of the subscription is in one of your defined taxable regions. | | `line_items` | [`List[RenewalPreviewLineItem]`](../../doc/models/renewal-preview-line-item.md) | Optional | An array of objects representing the individual transactions that will be created at the next renewal | diff --git a/doc/models/replay-webhooks-request.md b/doc/models/replay-webhooks-request.md index 403dfa85..c13fcfb6 100644 --- a/doc/models/replay-webhooks-request.md +++ b/doc/models/replay-webhooks-request.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `ids` | `List[long\|int]` | Required | - | +| `ids` | `List[int]` | Required | - | ## Example (as JSON) diff --git a/doc/models/service-credit.md b/doc/models/service-credit.md index 17eb99b2..d1241d38 100644 --- a/doc/models/service-credit.md +++ b/doc/models/service-credit.md @@ -10,8 +10,8 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `id` | `int` | Optional | - | -| `amount_in_cents` | `long\|int` | Optional | The amount in cents of the entry | -| `ending_balance_in_cents` | `long\|int` | Optional | The new balance for the credit account | +| `amount_in_cents` | `int` | Optional | The amount in cents of the entry | +| `ending_balance_in_cents` | `int` | Optional | The new balance for the credit account | | `entry_type` | [`ServiceCreditType`](../../doc/models/service-credit-type.md) | Optional | The type of entry | | `memo` | `str` | Optional | The memo attached to the entry | diff --git a/doc/models/site.md b/doc/models/site.md index 63508d69..83f4e74f 100644 --- a/doc/models/site.md +++ b/doc/models/site.md @@ -16,6 +16,7 @@ | `seller_id` | `int` | Optional | - | | `non_primary_currencies` | `List[str]` | Optional | - | | `relationship_invoicing_enabled` | `bool` | Optional | - | +| `schedule_subscription_cancellation_enabled` | `bool` | Optional | - | | `customer_hierarchy_enabled` | `bool` | Optional | - | | `whopays_enabled` | `bool` | Optional | - | | `whopays_default_payer` | `str` | Optional | - | diff --git a/doc/models/subscription-custom-price.md b/doc/models/subscription-custom-price.md index 373547c9..bb85bdf9 100644 --- a/doc/models/subscription-custom-price.md +++ b/doc/models/subscription-custom-price.md @@ -13,13 +13,13 @@ | --- | --- | --- | --- | | `name` | `str` | Optional | (Optional) | | `handle` | `str` | Optional | (Optional) | -| `price_in_cents` | str \| long \| int | Required | This is a container for one-of cases. | +| `price_in_cents` | str \| int | Required | This is a container for one-of cases. | | `interval` | str \| int | Required | This is a container for one-of cases. | | `interval_unit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Required | Required if using `custom_price` attribute. | -| `trial_price_in_cents` | str \| long \| int \| None | Optional | This is a container for one-of cases. | +| `trial_price_in_cents` | str \| int \| None | Optional | This is a container for one-of cases. | | `trial_interval` | str \| int \| None | Optional | This is a container for one-of cases. | | `trial_interval_unit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Optional | (Optional) | -| `initial_charge_in_cents` | str \| long \| int \| None | Optional | This is a container for one-of cases. | +| `initial_charge_in_cents` | str \| int \| None | Optional | This is a container for one-of cases. | | `initial_charge_after_trial` | `bool` | Optional | (Optional) | | `expiration_interval` | str \| int \| None | Optional | This is a container for one-of cases. | | `expiration_interval_unit` | [`ExpirationIntervalUnit`](../../doc/models/expiration-interval-unit.md) | Optional | (Optional) | diff --git a/doc/models/subscription-group-item.md b/doc/models/subscription-group-item.md index 21d72ef3..70cf329e 100644 --- a/doc/models/subscription-group-item.md +++ b/doc/models/subscription-group-item.md @@ -17,8 +17,8 @@ | `product_price_point_handle` | `str` | Optional | - | | `currency` | `str` | Optional | - | | `coupon_code` | `str` | Optional | - | -| `total_revenue_in_cents` | `long\|int` | Optional | - | -| `balance_in_cents` | `long\|int` | Optional | - | +| `total_revenue_in_cents` | `int` | Optional | - | +| `balance_in_cents` | `int` | Optional | - | ## Example (as JSON) diff --git a/doc/models/subscription-group-prepayment-response.md b/doc/models/subscription-group-prepayment-response.md index 4f2d81f0..0fe1cbe5 100644 --- a/doc/models/subscription-group-prepayment-response.md +++ b/doc/models/subscription-group-prepayment-response.md @@ -10,8 +10,8 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `id` | `int` | Optional | - | -| `amount_in_cents` | `long\|int` | Optional | The amount in cents of the entry. | -| `ending_balance_in_cents` | `long\|int` | Optional | The ending balance in cents of the account. | +| `amount_in_cents` | `int` | Optional | The amount in cents of the entry. | +| `ending_balance_in_cents` | `int` | Optional | The ending balance in cents of the account. | | `entry_type` | [`ServiceCreditType`](../../doc/models/service-credit-type.md) | Optional | The type of entry | | `memo` | `str` | Optional | A memo attached to the entry. | diff --git a/doc/models/subscription-included-coupon.md b/doc/models/subscription-included-coupon.md index 884e3b4b..c2d0f5e2 100644 --- a/doc/models/subscription-included-coupon.md +++ b/doc/models/subscription-included-coupon.md @@ -14,7 +14,7 @@ | `uses_allowed` | `int` | Optional | - | | `expires_at` | `str` | Optional | - | | `recurring` | `bool` | Optional | - | -| `amount_in_cents` | `long\|int` | Optional | **Constraints**: `>= 0` | +| `amount_in_cents` | `int` | Optional | **Constraints**: `>= 0` | | `percentage` | `str` | Optional | - | ## Example (as JSON) diff --git a/doc/models/subscription-migration-preview.md b/doc/models/subscription-migration-preview.md index 7d9d1807..20bfb681 100644 --- a/doc/models/subscription-migration-preview.md +++ b/doc/models/subscription-migration-preview.md @@ -9,10 +9,10 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `prorated_adjustment_in_cents` | `long\|int` | Optional | The amount of the prorated adjustment that would be issued for the current subscription. | -| `charge_in_cents` | `long\|int` | Optional | The amount of the charge that would be created for the new product. | -| `payment_due_in_cents` | `long\|int` | Optional | The amount of the payment due in the case of an upgrade. | -| `credit_applied_in_cents` | `long\|int` | Optional | Represents a credit in cents that is applied to your subscription as part of a migration process for a specific product, which reduces the amount owed for the subscription. | +| `prorated_adjustment_in_cents` | `int` | Optional | The amount of the prorated adjustment that would be issued for the current subscription. | +| `charge_in_cents` | `int` | Optional | The amount of the charge that would be created for the new product. | +| `payment_due_in_cents` | `int` | Optional | The amount of the payment due in the case of an upgrade. | +| `credit_applied_in_cents` | `int` | Optional | Represents a credit in cents that is applied to your subscription as part of a migration process for a specific product, which reduces the amount owed for the subscription. | ## Example (as JSON) diff --git a/doc/models/subscription-mrr-breakout.md b/doc/models/subscription-mrr-breakout.md index 78df4cb4..6c8ce5a4 100644 --- a/doc/models/subscription-mrr-breakout.md +++ b/doc/models/subscription-mrr-breakout.md @@ -9,8 +9,8 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `plan_amount_in_cents` | `long\|int` | Required | - | -| `usage_amount_in_cents` | `long\|int` | Required | - | +| `plan_amount_in_cents` | `int` | Required | - | +| `usage_amount_in_cents` | `int` | Required | - | ## Example (as JSON) diff --git a/doc/models/subscription-mrr.md b/doc/models/subscription-mrr.md index 74e90053..5c77dccd 100644 --- a/doc/models/subscription-mrr.md +++ b/doc/models/subscription-mrr.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `subscription_id` | `int` | Required | - | -| `mrr_amount_in_cents` | `long\|int` | Required | - | +| `mrr_amount_in_cents` | `int` | Required | - | | `breakouts` | [`SubscriptionMRRBreakout`](../../doc/models/subscription-mrr-breakout.md) | Optional | - | ## Example (as JSON) diff --git a/doc/models/subscription.md b/doc/models/subscription.md index 994eeeba..774164d1 100644 --- a/doc/models/subscription.md +++ b/doc/models/subscription.md @@ -11,9 +11,9 @@ | --- | --- | --- | --- | | `id` | `int` | Optional | The subscription unique id within Chargify. | | `state` | [`SubscriptionState`](../../doc/models/subscription-state.md) | Optional | The state of a subscription.

* **Live States**
* `active` - A normal, active subscription. It is not in a trial and is paid and up to date.
* `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
* `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.
* **Problem States**
* `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
* `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.
* `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) settings to have a Final Action of `mark the subscription unpaid`.
* **End of Life States**
* `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.
* `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.
* `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)
* `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.
* `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.
* `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing) for more details.

See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscription-States) for more info about subscription states and state transitions. | -| `balance_in_cents` | `long\|int` | Optional | Gives the current outstanding subscription balance in the number of cents. | -| `total_revenue_in_cents` | `long\|int` | Optional | Gives the total revenue from the subscription in the number of cents. | -| `product_price_in_cents` | `long\|int` | Optional | (Added Nov 5 2013) The recurring amount of the product (and version),currently subscribed. NOTE: this may differ from the current price of,the product, if you’ve changed the price of the product but haven’t,moved this subscription to a newer version. | +| `balance_in_cents` | `int` | Optional | Gives the current outstanding subscription balance in the number of cents. | +| `total_revenue_in_cents` | `int` | Optional | Gives the total revenue from the subscription in the number of cents. | +| `product_price_in_cents` | `int` | Optional | (Added Nov 5 2013) The recurring amount of the product (and version),currently subscribed. NOTE: this may differ from the current price of,the product, if you’ve changed the price of the product but haven’t,moved this subscription to a newer version. | | `product_version_number` | `int` | Optional | The version of the product for the subscription. Note that this is a deprecated field kept for backwards-compatibility. | | `current_period_ends_at` | `datetime` | Optional | Timestamp relating to the end of the current (recurring) period (i.e.,when the next regularly scheduled attempted charge will occur) | | `next_assessment_at` | `datetime` | Optional | Timestamp that indicates when capture of payment will be tried or,retried. This value will usually track the current_period_ends_at, but,will diverge if a renewal payment fails and must be retried. In that,case, the current_period_ends_at will advance to the end of the next,period (time doesn’t stop because a payment was missed) but the,next_assessment_at will be scheduled for the auto-retry time (i.e. 24,hours in the future, in some cases) | @@ -51,7 +51,7 @@ | `coupon_codes` | `List[str]` | Optional | An array for all the coupons attached to the subscription. | | `offer_id` | `int` | Optional | The ID of the offer associated with the subscription. | | `payer_id` | `int` | Optional | On Relationship Invoicing, the ID of the individual paying for the subscription. Defaults to the Customer ID unless the 'Customer Hierarchies & WhoPays' feature is enabled. | -| `current_billing_amount_in_cents` | `long\|int` | Optional | The balance in cents plus the estimated renewal amount in cents. Returned ONLY for readSubscription operation as it's compute intensive operation. | +| `current_billing_amount_in_cents` | `int` | Optional | The balance in cents plus the estimated renewal amount in cents. Returned ONLY for readSubscription operation as it's compute intensive operation. | | `product_price_point_id` | `int` | Optional | The product price point currently subscribed to. | | `product_price_point_type` | [`PricePointType`](../../doc/models/price-point-type.md) | Optional | Price point type. We expose the following types:

1. **default**: a price point that is marked as a default price for a certain product.
2. **custom**: a custom price point.
3. **catalog**: a price point that is **not** marked as a default price for a certain product and is **not** a custom one. | | `next_product_price_point_id` | `int` | Optional | If a delayed product change is scheduled, the ID of the product price point that the subscription will be changed to at the next renewal. | @@ -67,8 +67,8 @@ | `locale` | `str` | Optional | - | | `currency` | `str` | Optional | - | | `scheduled_cancellation_at` | `datetime` | Optional | - | -| `credit_balance_in_cents` | `long\|int` | Optional | - | -| `prepayment_balance_in_cents` | `long\|int` | Optional | - | +| `credit_balance_in_cents` | `int` | Optional | - | +| `prepayment_balance_in_cents` | `int` | Optional | - | | `prepaid_configuration` | [`PrepaidConfiguration`](../../doc/models/prepaid-configuration.md) | Optional | - | | `self_service_page_token` | `str` | Optional | Returned only for list/read Subscription operation when `include[]=self_service_page_token` parameter is provided. | diff --git a/doc/models/update-product-price-point.md b/doc/models/update-product-price-point.md index 88b73363..2bf3d4cd 100644 --- a/doc/models/update-product-price-point.md +++ b/doc/models/update-product-price-point.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `handle` | `str` | Optional | - | -| `price_in_cents` | `long\|int` | Optional | - | +| `price_in_cents` | `int` | Optional | - | ## Example (as JSON) diff --git a/doc/models/upsert-prepaid-configuration.md b/doc/models/upsert-prepaid-configuration.md index d432ebbd..0acbf78e 100644 --- a/doc/models/upsert-prepaid-configuration.md +++ b/doc/models/upsert-prepaid-configuration.md @@ -9,10 +9,10 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `initial_funding_amount_in_cents` | `long\|int` | Optional | - | -| `replenish_to_amount_in_cents` | `long\|int` | Optional | - | +| `initial_funding_amount_in_cents` | `int` | Optional | - | +| `replenish_to_amount_in_cents` | `int` | Optional | - | | `auto_replenish` | `bool` | Optional | - | -| `replenish_threshold_amount_in_cents` | `long\|int` | Optional | - | +| `replenish_threshold_amount_in_cents` | `int` | Optional | - | ## Example (as JSON) diff --git a/doc/models/usage.md b/doc/models/usage.md index 613172e7..36e87684 100644 --- a/doc/models/usage.md +++ b/doc/models/usage.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Optional | **Constraints**: `>= 0` | +| `id` | `int` | Optional | **Constraints**: `>= 0` | | `memo` | `str` | Optional | - | | `created_at` | `datetime` | Optional | - | | `price_point_id` | `int` | Optional | - | diff --git a/doc/models/void-invoice-event.md b/doc/models/void-invoice-event.md index 418f4e8d..8296d93f 100644 --- a/doc/models/void-invoice-event.md +++ b/doc/models/void-invoice-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'void_invoice'` | diff --git a/doc/models/void-remainder-event.md b/doc/models/void-remainder-event.md index 0ad1e12f..2d4d838f 100644 --- a/doc/models/void-remainder-event.md +++ b/doc/models/void-remainder-event.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `long\|int` | Required | - | +| `id` | `int` | Required | - | | `timestamp` | `datetime` | Required | - | | `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | - | | `event_type` | [`InvoiceEventType`](../../doc/models/invoice-event-type.md) | Required | **Default**: `'void_remainder'` | diff --git a/doc/models/webhook.md b/doc/models/webhook.md index 4dab4522..0834b31b 100644 --- a/doc/models/webhook.md +++ b/doc/models/webhook.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `event` | `str` | Optional | A string describing which event type produced the given webhook | -| `id` | `long\|int` | Optional | The unique identifier for the webhooks (unique across all of Chargify). This is not changed on a retry/replay of the same webhook, so it may be used to avoid duplicate action for the same event. | +| `id` | `int` | Optional | The unique identifier for the webhooks (unique across all of Chargify). This is not changed on a retry/replay of the same webhook, so it may be used to avoid duplicate action for the same event. | | `created_at` | `datetime` | Optional | Timestamp indicating when the webhook was created | | `last_error` | `str` | Optional | Text describing the status code and/or error from the last failed attempt to send the Webhook. When a webhook is retried and accepted, this field will be cleared. | | `last_error_at` | `datetime` | Optional | Timestamp indicating when the last non-acceptance occurred. If a webhook is later resent and accepted, this field will be cleared. | diff --git a/pyproject.toml b/pyproject.toml index bb7f7693..85dcd4a9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ requires = ["setuptools>=61.0"] [project] name = "maxio-advanced-billing-sdk" description = "Ultimate billing and pricing flexibility for B2B SaaS.\nMaxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments." -version = "6.0.0" +version = "6.1.0" readme = "README.md" requires-python = ">=3.7" keywords = ["Maxio", "Advaced Billing", "Payments", "Subscription"]