unitysvc-services 0.2.3__tar.gz → 0.2.4__tar.gz

{unitysvc_services-0.2.3 → unitysvc_services-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitysvc-services
-Version: 0.2.3
+Version: 0.2.4
 Summary: SDK for digital service providers on UnitySVC
 Author-email: Bo Peng <bo.peng@unitysvc.com>
 Maintainer-email: Bo Peng <bo.peng@unitysvc.com>
@@ -87,8 +87,11 @@ unitysvc_services publish
 # Or publish specific types only
 unitysvc_services publish providers
 
-# Verify
+# Verify with default fields
 unitysvc_services query offerings
+
+# Query with custom fields
+unitysvc_services query providers --fields id,name,contact_email
 ```
 
 ## Key Features

{unitysvc_services-0.2.3 → unitysvc_services-0.2.4}/README.md

@@ -45,8 +45,11 @@ unitysvc_services publish
 # Or publish specific types only
 unitysvc_services publish providers
 
-# Verify
+# Verify with default fields
 unitysvc_services query offerings
+
+# Query with custom fields
+unitysvc_services query providers --fields id,name,contact_email
 ```
 
 ## Key Features

{unitysvc_services-0.2.3 → unitysvc_services-0.2.4}/docs/cli-reference.md

@@ -157,6 +157,8 @@ unitysvc_services list listings [DATA_DIR]
 
 Query data from UnitySVC backend API.
 
+All query commands support field selection to customize output columns and pagination options.
+
 ### query providers
 
 ```bash
@@ -166,11 +168,13 @@ unitysvc_services query providers [OPTIONS]
 **Options:**
 
 -   `--format, -f {table|json}` - Output format (default: table)
+-   `--fields FIELDS` - Comma-separated list of fields to display (default: id,name,display_name,status)
+-   `--skip SKIP` - Number of records to skip for pagination (default: 0)
+-   `--limit LIMIT` - Maximum number of records to return (default: 100)
 
-**Required Environment Variables:**
+**Available Fields:**
 
--   `UNITYSVC_BASE_URL` - Backend API URL
--   `UNITYSVC_API_KEY` - API key for authentication
+id, name, display_name, contact_email, secondary_contact_email, homepage, description, status, created_at, updated_at
 
 ### query sellers
 
@@ -178,42 +182,85 @@ unitysvc_services query providers [OPTIONS]
 unitysvc_services query sellers [OPTIONS]
 ```
 
+**Options:**
+
+-   `--format, -f {table|json}` - Output format (default: table)
+-   `--fields FIELDS` - Comma-separated list of fields to display (default: id,name,display_name,seller_type)
+-   `--skip SKIP` - Number of records to skip for pagination (default: 0)
+-   `--limit LIMIT` - Maximum number of records to return (default: 100)
+
+**Available Fields:**
+
+id, name, display_name, seller_type, contact_email, secondary_contact_email, homepage, description, business_registration, tax_id, account_manager_id, created_at, updated_at, status
+
 ### query offerings
 
 ```bash
 unitysvc_services query offerings [OPTIONS]
 ```
 
+**Options:**
+
+-   `--format, -f {table|json}` - Output format (default: table)
+-   `--fields FIELDS` - Comma-separated list of fields to display (default: id,service_name,service_type,provider_name,status)
+-   `--skip SKIP` - Number of records to skip for pagination (default: 0)
+-   `--limit LIMIT` - Maximum number of records to return (default: 100)
+
+**Available Fields:**
+
+id, definition_id, provider_id, status, price, service_name, service_type, provider_name
+
 ### query listings
 
 ```bash
 unitysvc_services query listings [OPTIONS]
 ```
 
-### query interfaces
+**Options:**
 
-```bash
-unitysvc_services query interfaces [OPTIONS]
-```
+-   `--format, -f {table|json}` - Output format (default: table)
+-   `--fields FIELDS` - Comma-separated list of fields to display (default: id,service_name,service_type,seller_name,listing_type,status)
+-   `--skip SKIP` - Number of records to skip for pagination (default: 0)
+-   `--limit LIMIT` - Maximum number of records to return (default: 100)
 
-Query access interfaces (private endpoint).
+**Available Fields:**
 
-### query documents
+id, offering_id, seller_id, status, created_at, updated_at, parameters_schema, parameters_ui_schema, tags, service_name, service_type, provider_name, seller_name, listing_type
 
-```bash
-unitysvc_services query documents [OPTIONS]
-```
+**Required Environment Variables:**
 
-Query documents (private endpoint).
+-   `UNITYSVC_BASE_URL` - Backend API URL
+-   `UNITYSVC_API_KEY` - API key for authentication
 
 **Examples:**
 
 ```bash
-# Table output
+# Table output with default fields
 unitysvc_services query providers
 
 # JSON output
 unitysvc_services query offerings --format json
+
+# Custom fields - show only specific columns
+unitysvc_services query providers --fields id,name,contact_email
+
+# Show all available fields for sellers
+unitysvc_services query sellers --fields id,name,display_name,seller_type,contact_email,homepage,created_at,updated_at
+
+# Custom fields for listings
+unitysvc_services query listings --fields id,service_name,listing_type,status
+
+# Retrieve more than 100 records
+unitysvc_services query providers --limit 500
+
+# Pagination: get second page of 100 records
+unitysvc_services query offerings --skip 100 --limit 100
+
+# Large dataset retrieval
+unitysvc_services query listings --limit 1000
+
+# Combine pagination with custom fields
+unitysvc_services query sellers --skip 50 --limit 50 --fields id,name,contact_email
 ```
 
 ## publish - Publish to Backend

{unitysvc_services-0.2.3 → unitysvc_services-0.2.4}/docs/getting-started.md

@@ -147,9 +147,17 @@ unitysvc_services publish sellers
 ### Step 9: Verify Your Published Data
 
 ```bash
+# Query with default fields
 unitysvc_services query providers
 unitysvc_services query offerings
 unitysvc_services query listings
+
+# Query with custom fields - show only specific columns
+unitysvc_services query providers --fields id,name,contact_email
+unitysvc_services query listings --fields id,service_name,listing_type,status
+
+# Query as JSON for programmatic use
+unitysvc_services query offerings --format json
 ```
 
 ## Next Steps

{unitysvc_services-0.2.3 → unitysvc_services-0.2.4}/docs/workflows.md

@@ -102,9 +102,14 @@ unitysvc_services publish --data-path ./data
 #### 7. Verify on Platform
 
 ```bash
+# Query with default fields
 unitysvc_services query providers
 unitysvc_services query offerings
 unitysvc_services query listings
+
+# Or query with custom fields for focused output
+unitysvc_services query providers --fields id,name,status
+unitysvc_services query listings --fields id,service_name,listing_type,status
 ```
 
 ### Version Control Integration
@@ -269,7 +274,11 @@ unitysvc_services publish
 #### 8. Verify
 
 ```bash
+# Query with default fields
 unitysvc_services query offerings
+
+# Or query with custom fields
+unitysvc_services query offerings --fields id,service_name,status
 ```
 
 ### Automation with CI/CD

{unitysvc_services-0.2.3 → unitysvc_services-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "unitysvc-services"
-version = "0.2.3"
+version = "0.2.4"
 description = "SDK for digital service providers on UnitySVC"
 readme = "README.md"
 authors = [{ name = "Bo Peng", email = "bo.peng@unitysvc.com" }]

{unitysvc_services-0.2.3 → unitysvc_services-0.2.4}/src/unitysvc_services/publisher.py

@@ -106,6 +106,11 @@ class ServiceDataPublisher:
 
         # Resolve file references and include content
         base_path = data_file.parent
+        data = convert_convenience_fields_to_documents(
+            data, base_path, logo_field="logo", terms_field="terms_of_service"
+        )
+
+        # Resolve file references and include content
         data_with_content = self.resolve_file_references(data, base_path)
 
         # Extract provider_name from directory structure

{unitysvc_services-0.2.3 → unitysvc_services-0.2.4}/src/unitysvc_services/query.py

@@ -39,45 +39,65 @@ class ServiceDataQuery:
             timeout=30.0,
         )
 
-    def list_service_offerings(self) -> list[dict[str, Any]]:
-        """List all service offerings from the backend."""
-        response = self.client.get(f"{self.base_url}/publish/offerings")
-        response.raise_for_status()
-        result = response.json()
-        return result.get("data", result) if isinstance(result, dict) else result
+    def list_service_offerings(self, skip: int = 0, limit: int = 100) -> list[dict[str, Any]]:
+        """List all service offerings from the backend.
 
-    def list_service_listings(self) -> list[dict[str, Any]]:
-        """List all service listings from the backend."""
-        response = self.client.get(f"{self.base_url}/publish/listings")
+        Args:
+            skip: Number of records to skip (for pagination)
+            limit: Maximum number of records to return
+        """
+        response = self.client.get(
+            f"{self.base_url}/publish/offerings",
+            params={"skip": skip, "limit": limit}
+        )
         response.raise_for_status()
         result = response.json()
         return result.get("data", result) if isinstance(result, dict) else result
 
-    def list_providers(self) -> list[dict[str, Any]]:
-        """List all providers from the backend."""
-        response = self.client.get(f"{self.base_url}/publish/providers")
+    def list_service_listings(self, skip: int = 0, limit: int = 100) -> list[dict[str, Any]]:
+        """List all service listings from the backend.
+
+        Args:
+            skip: Number of records to skip (for pagination)
+            limit: Maximum number of records to return
+        """
+        response = self.client.get(
+            f"{self.base_url}/publish/listings",
+            params={"skip": skip, "limit": limit}
+        )
         response.raise_for_status()
         result = response.json()
         return result.get("data", result) if isinstance(result, dict) else result
 
-    def list_sellers(self) -> list[dict[str, Any]]:
-        """List all sellers from the backend."""
-        response = self.client.get(f"{self.base_url}/publish/sellers")
+    def list_providers(self, skip: int = 0, limit: int = 100) -> list[dict[str, Any]]:
+        """List all providers from the backend.
+
+        Args:
+            skip: Number of records to skip (for pagination)
+            limit: Maximum number of records to return
+        """
+        response = self.client.get(
+            f"{self.base_url}/publish/providers",
+            params={"skip": skip, "limit": limit}
+        )
         response.raise_for_status()
         result = response.json()
         return result.get("data", result) if isinstance(result, dict) else result
 
-    def list_access_interfaces(self) -> dict[str, Any]:
-        """List all access interfaces from the backend (private endpoint)."""
-        response = self.client.get(f"{self.base_url}/private/interfaces")
-        response.raise_for_status()
-        return response.json()
+    def list_sellers(self, skip: int = 0, limit: int = 100) -> list[dict[str, Any]]:
+        """List all sellers from the backend.
 
-    def list_documents(self) -> dict[str, Any]:
-        """List all documents from the backend (private endpoint)."""
-        response = self.client.get(f"{self.base_url}/private/documents")
+        Args:
+            skip: Number of records to skip (for pagination)
+            limit: Maximum number of records to return
+        """
+        response = self.client.get(
+            f"{self.base_url}/publish/sellers",
+            params={"skip": skip, "limit": limit}
+        )
         response.raise_for_status()
-        return response.json()
+        result = response.json()
+        return result.get("data", result) if isinstance(result, dict) else result
 
     def close(self):
         """Close the HTTP client."""
@@ -111,6 +131,16 @@ def query_sellers(
             "created_at, updated_at, status"
         ),
     ),
+    skip: int = typer.Option(
+        0,
+        "--skip",
+        help="Number of records to skip (for pagination)",
+    ),
+    limit: int = typer.Option(
+        100,
+        "--limit",
+        help="Maximum number of records to return (default: 100)",
+    ),
 ):
     """Query all sellers from the backend.
 
@@ -121,6 +151,12 @@ def query_sellers(
         # Show only specific fields
         unitysvc_services query sellers --fields id,name,contact_email
 
+        # Retrieve more than 100 records
+        unitysvc_services query sellers --limit 500
+
+        # Pagination: skip first 100, get next 100
+        unitysvc_services query sellers --skip 100 --limit 100
+
         # Show all available fields
         unitysvc_services query sellers --fields \\
             id,name,display_name,seller_type,contact_email,homepage,created_at,updated_at
@@ -158,7 +194,7 @@ def query_sellers(
 
     try:
         with ServiceDataQuery() as query:
-            sellers = query.list_sellers()
+            sellers = query.list_sellers(skip=skip, limit=limit)
 
             if format == "json":
                 # For JSON, filter fields if not all are requested
@@ -255,6 +291,16 @@ def query_providers(
             "homepage, description, status, created_at, updated_at"
         ),
     ),
+    skip: int = typer.Option(
+        0,
+        "--skip",
+        help="Number of records to skip (for pagination)",
+    ),
+    limit: int = typer.Option(
+        100,
+        "--limit",
+        help="Maximum number of records to return (default: 100)",
+    ),
 ):
     """Query all providers from the backend.
 
@@ -262,6 +308,12 @@ def query_providers(
         # Use default fields
         unitysvc_services query providers
 
+        # Retrieve more than 100 records
+        unitysvc_services query providers --limit 500
+
+        # Pagination: skip first 100, get next 100
+        unitysvc_services query providers --skip 100 --limit 100
+
         # Show only specific fields
         unitysvc_services query providers --fields id,name,contact_email
 
@@ -298,7 +350,7 @@ def query_providers(
 
     try:
         with ServiceDataQuery() as query:
-            providers = query.list_providers()
+            providers = query.list_providers(skip=skip, limit=limit)
 
             if format == "json":
                 # For JSON, filter fields if not all are requested
@@ -389,6 +441,16 @@ def query_offerings(
             "service_type, provider_name"
         ),
     ),
+    skip: int = typer.Option(
+        0,
+        "--skip",
+        help="Number of records to skip (for pagination)",
+    ),
+    limit: int = typer.Option(
+        100,
+        "--limit",
+        help="Maximum number of records to return (default: 100)",
+    ),
 ):
     """Query all service offerings from UnitySVC backend.
 
@@ -399,6 +461,12 @@ def query_offerings(
         # Show only specific fields
         unitysvc_services query offerings --fields id,service_name,status
 
+        # Retrieve more than 100 records
+        unitysvc_services query offerings --limit 500
+
+        # Pagination: skip first 100, get next 100
+        unitysvc_services query offerings --skip 100 --limit 100
+
         # Show all available fields
         unitysvc_services query offerings --fields \\
             id,service_name,service_type,provider_name,status,price,definition_id,provider_id
@@ -430,7 +498,7 @@ def query_offerings(
 
     try:
         with ServiceDataQuery() as query:
-            offerings = query.list_service_offerings()
+            offerings = query.list_service_offerings(skip=skip, limit=limit)
 
             if format == "json":
                 # For JSON, filter fields if not all are requested
@@ -489,11 +557,21 @@ def query_listings(
         "--fields",
         help=(
             "Comma-separated list of fields to display. Available fields: "
-            "id, offering_id, seller_id, status, created_at, updated_at, "
+            "id, offering_id, offering_status, seller_id, status, created_at, updated_at, "
             "parameters_schema, parameters_ui_schema, tags, service_name, "
             "service_type, provider_name, seller_name, listing_type"
         ),
     ),
+    skip: int = typer.Option(
+        0,
+        "--skip",
+        help="Number of records to skip (for pagination)",
+    ),
+    limit: int = typer.Option(
+        100,
+        "--limit",
+        help="Maximum number of records to return (default: 100)",
+    ),
 ):
     """Query all service listings from UnitySVC backend.
 
@@ -504,6 +582,12 @@ def query_listings(
         # Show only specific fields
         unitysvc_services query listings --fields id,service_name,status
 
+        # Retrieve more than 100 records
+        unitysvc_services query listings --limit 500
+
+        # Pagination: skip first 100, get next 100
+        unitysvc_services query listings --skip 100 --limit 100
+
         # Show all available fields
         unitysvc_services query listings --fields \\
             id,service_name,service_type,seller_name,listing_type,status,provider_name
@@ -515,6 +599,7 @@ def query_listings(
     allowed_fields = {
         "id",
         "offering_id",
+        "offering_status",
         "seller_id",
         "status",
         "created_at",
@@ -541,7 +626,7 @@ def query_listings(
 
     try:
         with ServiceDataQuery() as query:
-            listings = query.list_service_listings()
+            listings = query.list_service_listings(skip=skip, limit=limit)
 
             if format == "json":
                 # For JSON, filter fields if not all are requested
@@ -583,232 +668,3 @@ def query_listings(
     except Exception as e:
         console.print(f"[red]✗[/red] Failed to query service listings: {e}", style="bold red")
         raise typer.Exit(code=1)
-
-
-@app.command("interfaces")
-def query_interfaces(
-    format: str = typer.Option(
-        "table",
-        "--format",
-        "-f",
-        help="Output format: table, json",
-    ),
-    fields: str = typer.Option(
-        "id,name,context_type,access_method,is_active",
-        "--fields",
-        help=(
-            "Comma-separated list of fields to display. Available fields: "
-            "id, entity_id, context_type, access_method, api_endpoint, name, "
-            "description, request_transformer, rate_limits, constraint, "
-            "is_active, is_primary, sort_order, created_at, updated_at"
-        ),
-    ),
-):
-    """Query all access interfaces from UnitySVC backend (private endpoint).
-
-    Examples:
-        # Use default fields
-        unitysvc_services query interfaces
-
-        # Show only specific fields
-        unitysvc_services query interfaces --fields id,name,access_method
-
-        # Show all available fields
-        unitysvc_services query interfaces --fields \\
-            id,name,context_type,access_method,entity_id,is_active,is_primary
-    """
-    # Parse fields list
-    field_list = [f.strip() for f in fields.split(",")]
-
-    # Define allowed fields from AccessInterfacePublic model
-    allowed_fields = {
-        "id",
-        "entity_id",
-        "context_type",
-        "access_method",
-        "api_endpoint",
-        "name",
-        "description",
-        "request_transformer",
-        "rate_limits",
-        "constraint",
-        "is_active",
-        "is_primary",
-        "sort_order",
-        "created_at",
-        "updated_at",
-    }
-
-    # Validate fields
-    invalid_fields = [f for f in field_list if f not in allowed_fields]
-    if invalid_fields:
-        console.print(
-            f"[red]Error:[/red] Invalid field(s): {', '.join(invalid_fields)}",
-            style="bold red",
-        )
-        console.print(f"[yellow]Available fields:[/yellow] {', '.join(sorted(allowed_fields))}")
-        raise typer.Exit(code=1)
-
-    try:
-        with ServiceDataQuery() as query:
-            data = query.list_access_interfaces()
-
-            if format == "json":
-                # For JSON, filter fields if not all are requested
-                interfaces = data.get("data", [])
-                if set(field_list) != allowed_fields:
-                    filtered_interfaces = [
-                        {k: v for k, v in interface.items() if k in field_list} for interface in interfaces
-                    ]
-                    console.print(json.dumps({"data": filtered_interfaces, "count": data.get("count", 0)}, indent=2))
-                else:
-                    console.print(json.dumps(data, indent=2))
-            else:
-                interfaces = data.get("data", [])
-                if not interfaces:
-                    console.print("[yellow]No access interfaces found.[/yellow]")
-                else:
-                    table = Table(title="Access Interfaces")
-
-                    # Add columns dynamically based on selected fields
-                    for field in field_list:
-                        # Capitalize and format field names for display
-                        column_name = field.replace("_", " ").title()
-                        table.add_column(column_name)
-
-                    # Add rows
-                    for interface in interfaces:
-                        row = []
-                        for field in field_list:
-                            value = interface.get(field)
-                            if value is None:
-                                row.append("N/A")
-                            elif isinstance(value, dict | list):
-                                row.append(str(value)[:50])  # Truncate complex types
-                            else:
-                                row.append(str(value))
-                        table.add_row(*row)
-
-                    console.print(table)
-                    console.print(f"\n[green]Total:[/green] {data.get('count', 0)} access interface(s)")
-    except ValueError as e:
-        console.print(f"[red]✗[/red] {e}", style="bold red")
-        raise typer.Exit(code=1)
-    except Exception as e:
-        console.print(f"[red]✗[/red] Failed to query access interfaces: {e}", style="bold red")
-        raise typer.Exit(code=1)
-
-
-@app.command("documents")
-def query_documents(
-    format: str = typer.Option(
-        "table",
-        "--format",
-        "-f",
-        help="Output format: table, json",
-    ),
-    fields: str = typer.Option(
-        "id,title,category,mime_type,context_type,is_public",
-        "--fields",
-        help=(
-            "Comma-separated list of fields to display. Available fields: "
-            "id, entity_id, context_type, title, description, mime_type, "
-            "version, category, meta, sort_order, is_active, is_public, "
-            "external_url, object_key, filename, filesize, created_at, updated_at"
-        ),
-    ),
-):
-    """Query all documents from UnitySVC backend (private endpoint).
-
-    Examples:
-        # Use default fields
-        unitysvc_services query documents
-
-        # Show only specific fields
-        unitysvc_services query documents --fields id,title,category
-
-        # Show all available fields
-        unitysvc_services query documents --fields \\
-            id,title,category,mime_type,context_type,is_public,filename,filesize
-    """
-    # Parse fields list
-    field_list = [f.strip() for f in fields.split(",")]
-
-    # Define allowed fields from DocumentPublic model
-    allowed_fields = {
-        "id",
-        "entity_id",
-        "context_type",
-        "title",
-        "description",
-        "mime_type",
-        "version",
-        "category",
-        "meta",
-        "sort_order",
-        "is_active",
-        "is_public",
-        "external_url",
-        "object_key",
-        "filename",
-        "filesize",
-        "created_at",
-        "updated_at",
-    }
-
-    # Validate fields
-    invalid_fields = [f for f in field_list if f not in allowed_fields]
-    if invalid_fields:
-        console.print(
-            f"[red]Error:[/red] Invalid field(s): {', '.join(invalid_fields)}",
-            style="bold red",
-        )
-        console.print(f"[yellow]Available fields:[/yellow] {', '.join(sorted(allowed_fields))}")
-        raise typer.Exit(code=1)
-
-    try:
-        with ServiceDataQuery() as query:
-            data = query.list_documents()
-
-            if format == "json":
-                # For JSON, filter fields if not all are requested
-                documents = data.get("data", [])
-                if set(field_list) != allowed_fields:
-                    filtered_documents = [{k: v for k, v in doc.items() if k in field_list} for doc in documents]
-                    console.print(json.dumps({"data": filtered_documents, "count": data.get("count", 0)}, indent=2))
-                else:
-                    console.print(json.dumps(data, indent=2))
-            else:
-                documents = data.get("data", [])
-                if not documents:
-                    console.print("[yellow]No documents found.[/yellow]")
-                else:
-                    table = Table(title="Documents")
-
-                    # Add columns dynamically based on selected fields
-                    for field in field_list:
-                        # Capitalize and format field names for display
-                        column_name = field.replace("_", " ").title()
-                        table.add_column(column_name)
-
-                    # Add rows
-                    for doc in documents:
-                        row = []
-                        for field in field_list:
-                            value = doc.get(field)
-                            if value is None:
-                                row.append("N/A")
-                            elif isinstance(value, dict | list):
-                                row.append(str(value)[:50])  # Truncate complex types
-                            else:
-                                row.append(str(value))
-                        table.add_row(*row)
-
-                    console.print(table)
-                    console.print(f"\n[green]Total:[/green] {data.get('count', 0)} document(s)")
-    except ValueError as e:
-        console.print(f"[red]✗[/red] {e}", style="bold red")
-        raise typer.Exit(code=1)
-    except Exception as e:
-        console.print(f"[red]✗[/red] Failed to query documents: {e}", style="bold red")
-        raise typer.Exit(code=1)

{unitysvc_services-0.2.3 → unitysvc_services-0.2.4}/src/unitysvc_services.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitysvc-services
-Version: 0.2.3
+Version: 0.2.4
 Summary: SDK for digital service providers on UnitySVC
 Author-email: Bo Peng <bo.peng@unitysvc.com>
 Maintainer-email: Bo Peng <bo.peng@unitysvc.com>
@@ -87,8 +87,11 @@ unitysvc_services publish
 # Or publish specific types only
 unitysvc_services publish providers
 
-# Verify
+# Verify with default fields
 unitysvc_services query offerings
+
+# Query with custom fields
+unitysvc_services query providers --fields id,name,contact_email
 ```
 
 ## Key Features