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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitysvc-services
-Version: 0.2.2
+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.2 → 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.2 → 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.2 → 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.2 → 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.2 → unitysvc_services-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "unitysvc-services"
-version = "0.2.2"
+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.2 → 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
@@ -139,7 +144,7 @@ class ServiceDataPublisher:
 
         # Post to the endpoint
         response = self.client.post(
-            f"{self.base_url}/publish/service_offering",
+            f"{self.base_url}/publish/offering",
             json=data_with_content,
         )
         response.raise_for_status()
@@ -250,7 +255,7 @@ class ServiceDataPublisher:
 
         # Post to the endpoint
         response = self.client.post(
-            f"{self.base_url}/publish/service_listing",
+            f"{self.base_url}/publish/listing",
             json=data_with_content,
         )
         response.raise_for_status()