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.1
  • 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
ProductsApi list_product_policies GET /api/v1/products/{productId}/policies List policies issued against a product, scoped to the caller's own organization
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.1.tar.gz (53.2 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.1-py3-none-any.whl (111.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: surebase_sdk-0.1.1.tar.gz
  • Upload date:
  • Size: 53.2 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.1.tar.gz
Algorithm Hash digest
SHA256 bc2fc95c395f24c022291281fc05cac5896a069f759c55fe2fd92ed05622bc26
MD5 d6c514970b38f4d920c156d50a0cbe33
BLAKE2b-256 77f94b0c0185eaf9e01988df831e583c6071f6371100f3d7503124c006d03143

See more details on using hashes here.

File details

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

File metadata

  • Download URL: surebase_sdk-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 111.1 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bb764fc6a5569fdebded98da534a4807ae1f6ba81cee50ac6075eb0ea5fce10c
MD5 1322ccfeb46d696a8559aa1b3b933148
BLAKE2b-256 b3061cf30450cf642b267f1819d4877a98b16f29e4b2cb97ad7f7a3f1dcbf9a1

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 files

0.1.0

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