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

solvimon_python_sdk/api/payment_schedules_api.py

@@ -0,0 +1,2641 @@
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from solvimon_python_sdk.models.payment_schedule import PaymentSchedule
+from solvimon_python_sdk.models.payment_schedule_create_request import PaymentScheduleCreateRequest
+from solvimon_python_sdk.models.payment_schedule_init import PaymentScheduleInit
+from solvimon_python_sdk.models.payment_schedule_init_create_request import PaymentScheduleInitCreateRequest
+from solvimon_python_sdk.models.payment_schedule_response_wrapper import PaymentScheduleResponseWrapper
+from solvimon_python_sdk.models.payment_schedule_update_request import PaymentScheduleUpdateRequest
+
+from solvimon_python_sdk.api_client import ApiClient, RequestSerialized
+from solvimon_python_sdk.api_response import ApiResponse
+from solvimon_python_sdk.rest import RESTResponseType
+
+
+class PaymentSchedulesApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_payment_schedules(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
+        expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
+        limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
+        order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
+        order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PaymentScheduleResponseWrapper:
+        """Get a list of payment schedules
+
+        Requires the PAYMENT_SCHEDULE.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param customer_id: Filter based of customer ID
+        :type customer_id: str
+        :param expand: The id fields of the resources that are going to be expanded.
+        :type expand: List[str]
+        :param limit: The amount of records shown in the list
+        :type limit: int
+        :param page: The page which is going to be shown
+        :type page: int
+        :param order_by: The parameter by which the response is ordered.
+        :type order_by: str
+        :param order_direction: The order direction by which the response is ordered.
+        :type order_direction: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_payment_schedules_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            customer_id=customer_id,
+            expand=expand,
+            limit=limit,
+            page=page,
+            order_by=order_by,
+            order_direction=order_direction,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentScheduleResponseWrapper",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_payment_schedules_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
+        expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
+        limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
+        order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
+        order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PaymentScheduleResponseWrapper]:
+        """Get a list of payment schedules
+
+        Requires the PAYMENT_SCHEDULE.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param customer_id: Filter based of customer ID
+        :type customer_id: str
+        :param expand: The id fields of the resources that are going to be expanded.
+        :type expand: List[str]
+        :param limit: The amount of records shown in the list
+        :type limit: int
+        :param page: The page which is going to be shown
+        :type page: int
+        :param order_by: The parameter by which the response is ordered.
+        :type order_by: str
+        :param order_direction: The order direction by which the response is ordered.
+        :type order_direction: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_payment_schedules_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            customer_id=customer_id,
+            expand=expand,
+            limit=limit,
+            page=page,
+            order_by=order_by,
+            order_direction=order_direction,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentScheduleResponseWrapper",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_payment_schedules_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
+        expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
+        limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
+        order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
+        order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get a list of payment schedules
+
+        Requires the PAYMENT_SCHEDULE.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param customer_id: Filter based of customer ID
+        :type customer_id: str
+        :param expand: The id fields of the resources that are going to be expanded.
+        :type expand: List[str]
+        :param limit: The amount of records shown in the list
+        :type limit: int
+        :param page: The page which is going to be shown
+        :type page: int
+        :param order_by: The parameter by which the response is ordered.
+        :type order_by: str
+        :param order_direction: The order direction by which the response is ordered.
+        :type order_direction: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_payment_schedules_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            customer_id=customer_id,
+            expand=expand,
+            limit=limit,
+            page=page,
+            order_by=order_by,
+            order_direction=order_direction,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentScheduleResponseWrapper",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_payment_schedules_serialize(
+        self,
+        version,
+        x_platform_id,
+        customer_id,
+        expand,
+        limit,
+        page,
+        order_by,
+        order_direction,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+            'expand[]': 'multi',
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if version is not None:
+            _path_params['version'] = version
+        # process the query parameters
+        if customer_id is not None:
+            
+            _query_params.append(('customer_id', customer_id))
+            
+        if expand is not None:
+            
+            _query_params.append(('expand[]', expand))
+            
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if page is not None:
+            
+            _query_params.append(('page', page))
+            
+        if order_by is not None:
+            
+            _query_params.append(('order_by', order_by))
+            
+        if order_direction is not None:
+            
+            _query_params.append(('order_direction', order_direction))
+            
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v{version}/payment-schedules',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_payment_schedules_by_resource_id_or_reference(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PaymentSchedule:
+        """Get a payment schedule by ID or reference
+
+        Requires the PAYMENT_SCHEDULE.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param expand: The id fields of the resources that are going to be expanded.
+        :type expand: List[str]
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_payment_schedules_by_resource_id_or_reference_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            expand=expand,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_payment_schedules_by_resource_id_or_reference_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PaymentSchedule]:
+        """Get a payment schedule by ID or reference
+
+        Requires the PAYMENT_SCHEDULE.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param expand: The id fields of the resources that are going to be expanded.
+        :type expand: List[str]
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_payment_schedules_by_resource_id_or_reference_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            expand=expand,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_payment_schedules_by_resource_id_or_reference_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get a payment schedule by ID or reference
+
+        Requires the PAYMENT_SCHEDULE.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param expand: The id fields of the resources that are going to be expanded.
+        :type expand: List[str]
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_payment_schedules_by_resource_id_or_reference_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            expand=expand,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_payment_schedules_by_resource_id_or_reference_serialize(
+        self,
+        version,
+        resource_id_or_reference,
+        x_platform_id,
+        expand,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+            'expand[]': 'multi',
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if version is not None:
+            _path_params['version'] = version
+        if resource_id_or_reference is not None:
+            _path_params['resourceIdOrReference'] = resource_id_or_reference
+        # process the query parameters
+        if expand is not None:
+            
+            _query_params.append(('expand[]', expand))
+            
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v{version}/payment-schedules/{resourceIdOrReference}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def post_payment_schedules(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        payment_schedule_create_request: Optional[PaymentScheduleCreateRequest] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PaymentSchedule:
+        """Create a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.CREATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param payment_schedule_create_request:
+        :type payment_schedule_create_request: PaymentScheduleCreateRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            payment_schedule_create_request=payment_schedule_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def post_payment_schedules_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        payment_schedule_create_request: Optional[PaymentScheduleCreateRequest] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PaymentSchedule]:
+        """Create a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.CREATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param payment_schedule_create_request:
+        :type payment_schedule_create_request: PaymentScheduleCreateRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            payment_schedule_create_request=payment_schedule_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def post_payment_schedules_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        payment_schedule_create_request: Optional[PaymentScheduleCreateRequest] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Create a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.CREATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param payment_schedule_create_request:
+        :type payment_schedule_create_request: PaymentScheduleCreateRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            payment_schedule_create_request=payment_schedule_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _post_payment_schedules_serialize(
+        self,
+        version,
+        x_platform_id,
+        payment_schedule_create_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if version is not None:
+            _path_params['version'] = version
+        # process the query parameters
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+        if payment_schedule_create_request is not None:
+            _body_params = payment_schedule_create_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v{version}/payment-schedules',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def post_payment_schedules_by_resource_id_or_reference_activate(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PaymentSchedule:
+        """Activate a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_by_resource_id_or_reference_activate_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def post_payment_schedules_by_resource_id_or_reference_activate_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PaymentSchedule]:
+        """Activate a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_by_resource_id_or_reference_activate_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def post_payment_schedules_by_resource_id_or_reference_activate_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Activate a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_by_resource_id_or_reference_activate_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _post_payment_schedules_by_resource_id_or_reference_activate_serialize(
+        self,
+        version,
+        resource_id_or_reference,
+        x_platform_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if version is not None:
+            _path_params['version'] = version
+        if resource_id_or_reference is not None:
+            _path_params['resourceIdOrReference'] = resource_id_or_reference
+        # process the query parameters
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v{version}/payment-schedules/{resourceIdOrReference}/activate',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def post_payment_schedules_by_resource_id_or_reference_cancel(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PaymentSchedule:
+        """Cancel a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_by_resource_id_or_reference_cancel_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def post_payment_schedules_by_resource_id_or_reference_cancel_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PaymentSchedule]:
+        """Cancel a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_by_resource_id_or_reference_cancel_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def post_payment_schedules_by_resource_id_or_reference_cancel_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Cancel a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_by_resource_id_or_reference_cancel_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _post_payment_schedules_by_resource_id_or_reference_cancel_serialize(
+        self,
+        version,
+        resource_id_or_reference,
+        x_platform_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if version is not None:
+            _path_params['version'] = version
+        if resource_id_or_reference is not None:
+            _path_params['resourceIdOrReference'] = resource_id_or_reference
+        # process the query parameters
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v{version}/payment-schedules/{resourceIdOrReference}/cancel',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def post_payment_schedules_by_resource_id_or_reference_pause(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PaymentSchedule:
+        """Pause a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_by_resource_id_or_reference_pause_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def post_payment_schedules_by_resource_id_or_reference_pause_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PaymentSchedule]:
+        """Pause a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_by_resource_id_or_reference_pause_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def post_payment_schedules_by_resource_id_or_reference_pause_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Pause a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_by_resource_id_or_reference_pause_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _post_payment_schedules_by_resource_id_or_reference_pause_serialize(
+        self,
+        version,
+        resource_id_or_reference,
+        x_platform_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if version is not None:
+            _path_params['version'] = version
+        if resource_id_or_reference is not None:
+            _path_params['resourceIdOrReference'] = resource_id_or_reference
+        # process the query parameters
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v{version}/payment-schedules/{resourceIdOrReference}/pause',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def post_payment_schedules_init(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        payment_schedule_init_create_request: Optional[PaymentScheduleInitCreateRequest] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PaymentScheduleInit:
+        """Initialize resources for a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.CREATE, PAYMENT_METHOD.CREATE, PAYMENT_METHOD.UPDATE, CUSTOMER.CREATE or CUSTOMER.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param payment_schedule_init_create_request:
+        :type payment_schedule_init_create_request: PaymentScheduleInitCreateRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_init_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            payment_schedule_init_create_request=payment_schedule_init_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentScheduleInit",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def post_payment_schedules_init_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        payment_schedule_init_create_request: Optional[PaymentScheduleInitCreateRequest] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PaymentScheduleInit]:
+        """Initialize resources for a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.CREATE, PAYMENT_METHOD.CREATE, PAYMENT_METHOD.UPDATE, CUSTOMER.CREATE or CUSTOMER.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param payment_schedule_init_create_request:
+        :type payment_schedule_init_create_request: PaymentScheduleInitCreateRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_init_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            payment_schedule_init_create_request=payment_schedule_init_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentScheduleInit",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def post_payment_schedules_init_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        payment_schedule_init_create_request: Optional[PaymentScheduleInitCreateRequest] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Initialize resources for a payment schedule
+
+        Requires the PAYMENT_SCHEDULE.CREATE, PAYMENT_METHOD.CREATE, PAYMENT_METHOD.UPDATE, CUSTOMER.CREATE or CUSTOMER.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param payment_schedule_init_create_request:
+        :type payment_schedule_init_create_request: PaymentScheduleInitCreateRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_payment_schedules_init_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            payment_schedule_init_create_request=payment_schedule_init_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentScheduleInit",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _post_payment_schedules_init_serialize(
+        self,
+        version,
+        x_platform_id,
+        payment_schedule_init_create_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if version is not None:
+            _path_params['version'] = version
+        # process the query parameters
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+        if payment_schedule_init_create_request is not None:
+            _body_params = payment_schedule_init_create_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v{version}/payment-schedules/init',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def update_payment_schedules_by_resource_id_or_reference(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        payment_schedule_update_request: Optional[PaymentScheduleUpdateRequest] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PaymentSchedule:
+        """Patch a payment schedule.
+
+        Requires the PAYMENT_SCHEDULE.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param payment_schedule_update_request:
+        :type payment_schedule_update_request: PaymentScheduleUpdateRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._update_payment_schedules_by_resource_id_or_reference_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            payment_schedule_update_request=payment_schedule_update_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def update_payment_schedules_by_resource_id_or_reference_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        payment_schedule_update_request: Optional[PaymentScheduleUpdateRequest] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PaymentSchedule]:
+        """Patch a payment schedule.
+
+        Requires the PAYMENT_SCHEDULE.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param payment_schedule_update_request:
+        :type payment_schedule_update_request: PaymentScheduleUpdateRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._update_payment_schedules_by_resource_id_or_reference_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            payment_schedule_update_request=payment_schedule_update_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def update_payment_schedules_by_resource_id_or_reference_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        payment_schedule_update_request: Optional[PaymentScheduleUpdateRequest] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Patch a payment schedule.
+
+        Requires the PAYMENT_SCHEDULE.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id_or_reference: The ID or reference of the resource. (required)
+        :type resource_id_or_reference: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param payment_schedule_update_request:
+        :type payment_schedule_update_request: PaymentScheduleUpdateRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._update_payment_schedules_by_resource_id_or_reference_serialize(
+            version=version,
+            resource_id_or_reference=resource_id_or_reference,
+            x_platform_id=x_platform_id,
+            payment_schedule_update_request=payment_schedule_update_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaymentSchedule",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _update_payment_schedules_by_resource_id_or_reference_serialize(
+        self,
+        version,
+        resource_id_or_reference,
+        x_platform_id,
+        payment_schedule_update_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if version is not None:
+            _path_params['version'] = version
+        if resource_id_or_reference is not None:
+            _path_params['resourceIdOrReference'] = resource_id_or_reference
+        # process the query parameters
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+        if payment_schedule_update_request is not None:
+            _body_params = payment_schedule_update_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='PATCH',
+            resource_path='/v{version}/payment-schedules/{resourceIdOrReference}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+