Skip to main content

surebase-sdk

Public, API-key-authenticated surface of the Surebase B2B insurance-as-a-service platform. This spec covers exactly the resources published to third-party developers via X-Api-Key — Products, Quotes, Policies, Claims, and Usage reporting. It intentionally excludes internal-only endpoints (dashboard/admin routes authenticated via JWT session, not API key).

This is the canonical source of truth for the official SDKs published under Stringify-Consulting/surebase-sdks. Language SDKs are generated from this spec via openapi-generator — do not hand-edit generated SDK request/response shapes without first fixing them here.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 0.1.0
  • Generator version: 7.24.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://developers.surebase.it

Requirements.

Python 3.9+

Installation & Usage

pip install

pip install surebase-sdk

Or install the latest commit directly from source:

pip install git+https://github.com/Stringify-Consulting/surebase-sdks.git#subdirectory=packages/python

(you may need to run pip with root permission: sudo pip install ...)

Then import the package:

import surebase_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import surebase_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import surebase_sdk
from surebase_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.surebase.it
# See configuration.py for a list of all supported configuration parameters.
configuration = surebase_sdk.Configuration(
    host = "https://api.surebase.it"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with surebase_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = surebase_sdk.ClaimsApi(api_client)
    claim_id = 56 # int | 
    add_claim_comment_request = surebase_sdk.AddClaimCommentRequest() # AddClaimCommentRequest | 

    try:
        # Post a message to a claim's shared communication thread
        api_response = api_instance.add_claim_comment(claim_id, add_claim_comment_request)
        print("The response of ClaimsApi->add_claim_comment:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ClaimsApi->add_claim_comment: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.surebase.it

Class Method HTTP request Description
ClaimsApi add_claim_comment POST /api/v1/claims/{claimId}/comments Post a message to a claim's shared communication thread
ClaimsApi add_claim_document POST /api/v1/claims/{claimId}/document Add a supporting document to a claim
ClaimsApi approve_claim POST /api/v1/claims/{claimId}/approve Approve a claim
ClaimsApi create_claim POST /api/v1/claims File a new claim against a policy
ClaimsApi list_claim_documents GET /api/v1/claims/{claimId}/document List all supporting documents for a claim
ClaimsApi reject_claim POST /api/v1/claims/{claimId}/reject Reject a claim
ClaimsApi update_claim PUT /api/v1/claims/{claim_id} Update an existing claim
PoliciesApi cancel_policy POST /api/v1/policies/{id}/cancel Cancel a policy
PoliciesApi create_policy POST /api/v1/policies Issue a new policy from an approved quote
PoliciesApi export_policies GET /api/v1/policies/export Export policies (same filters as list) as CSV
PoliciesApi get_policy GET /api/v1/policies/{id} Get a policy by ID
PoliciesApi get_policy_document GET /api/v1/policies/{id}/document Generate and download the policy schedule/certificate as a PDF
PoliciesApi get_policy_stats GET /api/v1/policies/stats Return policy counts by status
PoliciesApi list_policies GET /api/v1/policies List policies for the caller's own organization, paginated
PoliciesApi renew_policy POST /api/v1/policies/{id}/renew Renew a policy
PoliciesApi set_policy_auto_renewal PATCH /api/v1/policies/{id}/auto-renewal Enable or disable auto-renewal for a policy
ProductsApi get_product GET /api/v1/products/{productId} Get a product by ID
ProductsApi get_product_commission_settings GET /api/v1/products/{productId}/commission-settings Get a product's commission settings
ProductsApi list_marketplace_products GET /api/v1/products/marketplace Browse all active products across all insurers (marketplace listing)
ProductsApi list_product_coverage GET /api/v1/products/{productId}/coverage List all coverage line items for a product
QuotesApi approve_quote POST /api/v1/quotes/{quoteId}/approve Approve a quote
QuotesApi create_quote POST /api/v1/quotes Create a new quote for the caller's own broker organization
QuotesApi list_quotes GET /api/v1/quotes List quotes for the caller's own broker organization, newest first
QuotesApi reject_quote POST /api/v1/quotes/{quoteId}/reject Reject a quote
QuotesApi submit_quote POST /api/v1/quotes/{quoteId}/submit Submit a draft quote for insurer review, moving it from Draft to Pending
UsageApi get_api_usage GET /api/v1/reports/api-usage Get the caller's own organization's API usage over a given number of days

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-Api-Key
  • Location: HTTP header

Author

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

surebase_sdk-0.1.0.tar.gz (52.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

surebase_sdk-0.1.0-py3-none-any.whl (110.7 kB view details)

Uploaded Python 3

File details

Details for the file surebase_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: surebase_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 52.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.16

File hashes

Hashes for surebase_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0bd34691f56f00e81904737f6b8ba1ff954893297d30ac465cacb00ec4fbb38e
MD5 d3ee03e303f9bef3f9715142586fabdf
BLAKE2b-256 7f769307efd0df85f30764cf92b40a82647756968a5f2e80baff50ebfeee14c2

See more details on using hashes here.

File details

Details for the file surebase_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: surebase_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 110.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.16

File hashes

Hashes for surebase_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6726e79f1119162c02cb899e628139cf1c9347cc2bb8a3a9c6952bf47bf61cca
MD5 ab5396b5ed8db753b18e02e01c772221
BLAKE2b-256 d1464811d55bda3b48f2aff0630f447b1ebf1d07245a9e74d654f96faa27a9f2

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.1

2 files

This release

0.1.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page