PTHMINT-52: Fix Ruff D100

pyproject.toml

@@ -99,7 +99,6 @@ extend-safe-fixes = [
     "D415", # docstrings should end with a period, question mark, or exclamation point
 ]
 ignore = [
-    "D100",
     "D101",
     "D103",
     "D104",

src/__init__.py

@@ -0,0 +1 @@
+"""MultiSafepay Python SDK source package."""

src/multisafepay/__init__.py

@@ -0,0 +1 @@
+"""MultiSafepay Python SDK main package."""

src/multisafepay/api/__init__.py

@@ -0,0 +1 @@
+"""API package for MultiSafepay SDK API management components."""

src/multisafepay/api/base/__init__.py

@@ -0,0 +1 @@
+"""Base API management classes and utilities for MultiSafepay SDK."""

src/multisafepay/api/base/abstract_manager.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Abstract base manager class for MultiSafepay API managers."""
+
 import urllib.parse
 
 from multisafepay.client.client import Client

src/multisafepay/api/base/decorator.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Decorator class for response model transformations and dependencies."""
+
 from typing import Any, Dict, List, Optional
 
 

src/multisafepay/api/base/listings/__init__.py

@@ -0,0 +1 @@
+"""Listing and pagination utilities for API responses."""

src/multisafepay/api/base/listings/cursor.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Cursor implementation for pagination in API listings."""
+
 from typing import Optional
 
 from multisafepay.model.response_model import ResponseModel

src/multisafepay/api/base/listings/listing.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Generic listing container for API response collections."""
+
 from typing import Any, Dict, Generic, Iterator, List, TypeVar
 
 from pydantic.main import BaseModel

src/multisafepay/api/base/listings/listing_pager.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Paginated listing implementation combining listings with pagers."""
+
 from typing import Optional
 
 from multisafepay.api.base.listings.listing import Listing

src/multisafepay/api/base/listings/pager.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Pager implementation for handling pagination in API responses."""
+
 
 from typing import Optional
 

src/multisafepay/api/base/response/__init__.py

@@ -0,0 +1 @@
+"""Shared response abstractions and utilities for API responses."""

src/multisafepay/api/base/response/api_response.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""API response wrapper class for handling MultiSafepay API responses."""
 
 from typing import Optional, Union
 

src/multisafepay/api/base/response/custom_api_response.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Custom API response class with generic typing support for flexible response handling."""
+
 from typing import Any, Dict, Optional, Union
 
 from multisafepay.api.base.response.api_response import ApiResponse

src/multisafepay/api/paths/__init__.py

@@ -0,0 +1 @@
+"""API path endpoints for MultiSafepay SDK operations."""

src/multisafepay/api/paths/auth/__init__.py

@@ -0,0 +1 @@
+"""Authentication API endpoints for managing access credentials."""

src/multisafepay/api/paths/auth/api_token/__init__.py

@@ -0,0 +1 @@
+"""API token management endpoints and request models."""

src/multisafepay/api/paths/auth/api_token/response/__init__.py

@@ -0,0 +1 @@
+"""Response models for authentication token issuance and metadata."""

src/multisafepay/api/paths/auth/api_token/response/api_token.py

@@ -1,9 +1,14 @@
 # Copyright (c) MultiSafepay, Inc. All rights reserved.
-from typing import Optional
 
 # This file is licensed under the Open Software License (OSL) version 3.0.
 # For a copy of the license, see the LICENSE.txt file in the project root.
+
 # See the DISCLAIMER.md file for disclaimer details.
+
+"""API token response model for handling authentication token data."""
+
+from typing import Optional
+
 from multisafepay.model.response_model import ResponseModel
 
 

src/multisafepay/api/paths/auth/auth_manager.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Authentication manager for handling API token operations."""
+
 from multisafepay.api.base.abstract_manager import AbstractManager
 from multisafepay.api.base.response.api_response import ApiResponse
 from multisafepay.api.base.response.custom_api_response import (

src/multisafepay/api/paths/capture/__init__.py

@@ -0,0 +1 @@
+"""Standalone capture API endpoints for managing payment captures."""

src/multisafepay/api/paths/capture/capture_manager.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Capture manager for handling reservation capture operations."""
+
 import json
 
 from multisafepay.api.base.abstract_manager import AbstractManager

src/multisafepay/api/paths/capture/request/__init__.py

@@ -0,0 +1 @@
+"""Request models for initiating standalone capture operations."""

src/multisafepay/api/paths/capture/request/capture_request.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Capture request model for processing reservation captures."""
 
 from typing import Optional
 

src/multisafepay/api/paths/capture/response/__init__.py

@@ -0,0 +1 @@
+"""Response models for standalone capture outcomes and details."""

src/multisafepay/api/paths/capture/response/capture.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Capture response model for handling capture operation results and status information."""
+
 from typing import Optional
 
 from multisafepay.model.response_model import ResponseModel

src/multisafepay/api/paths/categories/__init__.py

@@ -0,0 +1 @@
+"""Category API endpoints for retrieving payment categories."""

src/multisafepay/api/paths/categories/category_manager.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Category manager for retrieving transaction and payment categories."""
+
 from multisafepay.api.base.abstract_manager import AbstractManager
 from multisafepay.api.base.response.custom_api_response import (
     CustomApiResponse,

src/multisafepay/api/paths/categories/response/__init__.py

@@ -0,0 +1 @@
+"""Response models for category listings and metadata."""

src/multisafepay/api/paths/categories/response/category.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Category response model for handling payment category information and classification."""
 
 from typing import Optional
 

src/multisafepay/api/paths/gateways/__init__.py

@@ -0,0 +1 @@
+"""Gateway API endpoints for retrieving available payment gateways."""

src/multisafepay/api/paths/gateways/gateway_manager.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Gateway manager for handling payment gateway operations and information."""
+
 from multisafepay.api.base.abstract_manager import AbstractManager
 from multisafepay.api.base.response.custom_api_response import (
     CustomApiResponse,

src/multisafepay/api/paths/gateways/response/__init__.py

@@ -0,0 +1 @@
+"""Response models describing payment gateway metadata and configuration."""

src/multisafepay/api/paths/gateways/response/gateway.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Gateway response model for handling payment gateway configuration and information."""
 
 from typing import Optional
 

src/multisafepay/api/paths/issuers/__init__.py

@@ -0,0 +1 @@
+"""Issuer API endpoints for payment issuer information."""

src/multisafepay/api/paths/issuers/issuer_manager.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Issuer manager for retrieving payment gateway issuers and bank options."""
+
 from multisafepay.api.base.abstract_manager import AbstractManager
 from multisafepay.api.base.response.custom_api_response import (
     CustomApiResponse,

src/multisafepay/api/paths/issuers/response/__init__.py

@@ -0,0 +1 @@
+"""Issuer response models and data structures."""

src/multisafepay/api/paths/issuers/response/issuer.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Issuer response model for handling payment issuer information and configurations."""
 
 from typing import Optional
 

src/multisafepay/api/paths/me/__init__.py

@@ -0,0 +1 @@
+"""Account information API endpoints for the authenticated user."""

src/multisafepay/api/paths/me/me_manager.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Me manager for retrieving account and merchant information."""
+
 from multisafepay.api.base.abstract_manager import AbstractManager
 from multisafepay.api.base.response.custom_api_response import (
     CustomApiResponse,

src/multisafepay/api/paths/me/response/__init__.py

@@ -0,0 +1 @@
+"""Response models for account profile and credentials queries."""

src/multisafepay/api/paths/me/response/me.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Me response model for handling account information and user profile data."""
 
 from typing import Optional
 

src/multisafepay/api/paths/orders/__init__.py

@@ -0,0 +1 @@
+"""Order API endpoints and order management functionality."""

src/multisafepay/api/paths/orders/order_id/__init__.py

@@ -0,0 +1 @@
+"""Order ID specific operations and endpoints."""

src/multisafepay/api/paths/orders/order_id/capture/__init__.py

@@ -0,0 +1 @@
+"""Capture operations and endpoints for specific orders."""

src/multisafepay/api/paths/orders/order_id/capture/request/__init__.py

@@ -0,0 +1 @@
+"""Request models for capturing payments on existing orders."""

src/multisafepay/api/paths/orders/order_id/capture/request/capture_request.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Capture request model for handling order capture operations and parameters."""
 
 from typing import Optional, Union
 

src/multisafepay/api/paths/orders/order_id/capture/response/__init__.py

@@ -0,0 +1 @@
+"""Response models for order capture outcomes and summaries."""

src/multisafepay/api/paths/orders/order_id/capture/response/order_capture.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Order capture response model for handling successful capture operations."""
 
 from typing import Optional
 

src/multisafepay/api/paths/orders/order_id/refund/__init__.py

@@ -0,0 +1 @@
+"""Order refund operations and endpoints."""

src/multisafepay/api/paths/orders/order_id/refund/request/__init__.py

@@ -0,0 +1 @@
+"""Request models for handling refund operations on specific orders."""

src/multisafepay/api/paths/orders/order_id/refund/request/components/__init__.py

@@ -0,0 +1 @@
+"""Component models supporting order refund request payloads."""

src/multisafepay/api/paths/orders/order_id/refund/request/components/checkout_data.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Checkout data model for refund request checkout information and configuration."""
 
 from typing import List, Optional
 

src/multisafepay/api/paths/orders/order_id/refund/request/refund_request.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Refund request model for handling order refund operations and parameters."""
 
 from typing import Optional, Union
 

src/multisafepay/api/paths/orders/order_id/refund/response/__init__.py

@@ -0,0 +1 @@
+"""Response models for order refund results and status details."""

src/multisafepay/api/paths/orders/order_id/refund/response/order_refund.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Order refund response model for handling successful refund operations."""
 
 from typing import Optional
 

src/multisafepay/api/paths/orders/order_id/update/__init__.py

@@ -0,0 +1 @@
+"""Update operations and endpoints for modifying existing orders."""

src/multisafepay/api/paths/orders/order_id/update/request/__init__.py

@@ -0,0 +1 @@
+"""Request models for updating order details and metadata."""

src/multisafepay/api/paths/orders/order_id/update/request/update_request.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Update request model for handling order update operations and parameters."""
 
 from typing import Optional
 

src/multisafepay/api/paths/orders/order_manager.py

@@ -5,6 +5,8 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Order manager for handling order operations and API endpoints."""
+
 import json
 from typing import Union
 

src/multisafepay/api/paths/orders/request/__init__.py

@@ -0,0 +1 @@
+"""Order request models and data structures for creating orders."""

src/multisafepay/api/paths/orders/request/components/__init__.py

@@ -0,0 +1 @@
+"""Order request components for detailed order configuration and settings."""

src/multisafepay/api/paths/orders/request/components/checkout_options.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Checkout options component for order request configuration and settings."""
 
 from typing import Optional
 

src/multisafepay/api/paths/orders/request/components/customer_info.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Customer info model for handling customer information in order requests."""
 
 from typing import Optional
 

src/multisafepay/api/paths/orders/request/components/gateway_info/__init__.py

@@ -0,0 +1 @@
+"""Gateway-specific information components for order configuration."""

src/multisafepay/api/paths/orders/request/components/gateway_info/account.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Account model for gateway-specific account information and configuration."""
 
 from typing import Optional, Union
 

src/multisafepay/api/paths/orders/request/components/gateway_info/creditcard.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Credit card model for gateway-specific credit card information and processing."""
 
 from typing import Optional, Union
 

src/multisafepay/api/paths/orders/request/components/gateway_info/destination_holder.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Destination holder model for gateway-specific destination account information."""
 
 from typing import Optional, Union
 

src/multisafepay/api/paths/orders/request/components/gateway_info/issuer.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Issuer model for gateway-specific issuer information and configuration."""
 
 from typing import Optional
 

src/multisafepay/api/paths/orders/request/components/gateway_info/meta.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""Meta model for gateway-specific metadata and additional configuration options."""
 
 from typing import Optional, Union
 

src/multisafepay/api/paths/orders/request/components/gateway_info/qr_code.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""QR code model for gateway-specific QR code generation and display settings."""
 
 from typing import Optional
 

src/multisafepay/api/paths/orders/request/components/gateway_info/qr_enabled.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+"""QR enabled model for gateway-specific QR code enabling and configuration."""
 
 from typing import Optional