Skip to main content

SRO Master API

Project description

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

  • API version: 0.1.53
  • Package version: 0.1.53
  • Generator version: 7.21.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://nexium.me/

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import sromaster

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 sromaster

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import sromaster
from sromaster.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = sromaster.Configuration(
    host = "http://localhost"
)

# 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 Bearer authorization: HTTPBearer
configuration = sromaster.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
async with sromaster.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sromaster.AssetsApi(api_client)
    asset_id = 56 # int | 

    try:
        # Delete Asset
        await api_instance.delete_asset_assets_asset_id_delete(asset_id)
    except ApiException as e:
        print("Exception when calling AssetsApi->delete_asset_assets_asset_id_delete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AssetsApi delete_asset_assets_asset_id_delete DELETE /assets/{asset_id} Delete Asset
AssetsApi download_asset_assets_asset_id_download_get GET /assets/{asset_id}/download Download Asset
AssetsApi finalize_asset_assets_post POST /assets Finalize Asset
AssetsApi get_asset_download_url_assets_asset_id_download_url_get GET /assets/{asset_id}/download-url Get Asset Download Url
AssetsApi request_upload_url_assets_upload_url_post POST /assets/upload-url Request Upload Url
CustomersApi add_customer_phone_customers_customer_id_phones_post POST /customers/{customer_id}/phones Add Customer Phone
CustomersApi create_customer_customers_post POST /customers Create Customer
CustomersApi delete_customer_customers_customer_id_delete DELETE /customers/{customer_id} Delete Customer
CustomersApi delete_customer_phone_customers_customer_id_phones_phone_id_delete DELETE /customers/{customer_id}/phones/{phone_id} Delete Customer Phone
CustomersApi get_customer_customers_customer_id_get GET /customers/{customer_id} Get Customer
CustomersApi list_customer_phones_customers_customer_id_phones_get GET /customers/{customer_id}/phones List Customer Phones
CustomersApi list_customers_customers_get GET /customers List Customers
CustomersApi update_customer_customers_customer_id_patch PATCH /customers/{customer_id} Update Customer
CustomersApi update_customer_phone_customers_customer_id_phones_phone_id_patch PATCH /customers/{customer_id}/phones/{phone_id} Update Customer Phone
EmailMessagesApi dispatch_scheduled_email_messages_email_messages_dispatch_scheduled_post POST /email-messages/dispatch-scheduled Dispatch Scheduled Email Messages
EmailMessagesApi send_email_messages_email_messages_send_post POST /email-messages/send Send Email Messages
EmailSearchRequestsApi create_email_search_request_email_search_requests_post POST /email-search-requests Create Email Search Request
EmailSearchRequestsApi delete_email_search_request_email_search_requests_request_id_delete DELETE /email-search-requests/{request_id} Delete Email Search Request
EmailSearchRequestsApi get_email_search_request_email_search_requests_request_id_get GET /email-search-requests/{request_id} Get Email Search Request
EmailSearchRequestsApi list_email_search_requests_email_search_requests_get GET /email-search-requests List Email Search Requests
EmailSearchRequestsApi update_email_search_request_email_search_requests_request_id_patch PATCH /email-search-requests/{request_id} Update Email Search Request
EmailsApi create_email_emails_post POST /emails Create Email
EmailsApi delete_email_emails_item_id_delete DELETE /emails/{item_id} Delete Email
EmailsApi get_email_emails_item_id_get GET /emails/{item_id} Get Email
EmailsApi list_emails_emails_get GET /emails List Emails
EmailsApi update_email_emails_item_id_patch PATCH /emails/{item_id} Update Email
ImInsurersApi create_im_insurer_im_insurers_post POST /im-insurers Create Im Insurer
ImInsurersApi delete_im_insurer_im_insurers_insurer_id_delete DELETE /im-insurers/{insurer_id} Delete Im Insurer
ImInsurersApi get_im_insurer_im_insurers_insurer_id_get GET /im-insurers/{insurer_id} Get Im Insurer
ImInsurersApi list_im_insurers_im_insurers_get GET /im-insurers List Im Insurers
ImInsurersApi update_im_insurer_im_insurers_insurer_id_patch PATCH /im-insurers/{insurer_id} Update Im Insurer
ImInsurersNameVariantsApi create_name_variant_im_insurers_name_variants_post POST /im-insurers/name-variants Create Name Variant
ImInsurersNameVariantsApi delete_name_variant_im_insurers_name_variants_variant_id_delete DELETE /im-insurers/name-variants/{variant_id} Delete Name Variant
ImInsurersNameVariantsApi get_name_variant_im_insurers_name_variants_variant_id_get GET /im-insurers/name-variants/{variant_id} Get Name Variant
ImInsurersNameVariantsApi list_name_variants_im_insurers_name_variants_get GET /im-insurers/name-variants List Name Variants
ImInsurersNameVariantsApi update_name_variant_im_insurers_name_variants_variant_id_patch PATCH /im-insurers/name-variants/{variant_id} Update Name Variant
ImMailingApi create_item_im_mailing_post POST /im-mailing Create Item
ImMailingApi delete_item_im_mailing_item_id_delete DELETE /im-mailing/{item_id} Delete Item
ImMailingApi generate_items_im_mailing_generate_post POST /im-mailing/generate Generate Items
ImMailingApi generate_pixel_token_im_mailing_item_id_pixel_token_get GET /im-mailing/{item_id}/pixel-token Generate Pixel Token
ImMailingApi get_item_im_mailing_item_id_get GET /im-mailing/{item_id} Get Item
ImMailingApi get_item_invoice_download_url_im_mailing_item_id_invoice_download_url_get GET /im-mailing/{item_id}/invoice/download-url Get Item Invoice Download Url
ImMailingApi list_items_im_mailing_get GET /im-mailing List Items
ImMailingApi update_item_im_mailing_item_id_patch PATCH /im-mailing/{item_id} Update Item
ImMailingInvoicesApi delete_invoice_im_mailing_item_id_invoices_invoice_id_delete DELETE /im-mailing/{item_id}/invoices/{invoice_id} Delete Invoice
ImMailingInvoicesApi finalize_invoice_im_mailing_item_id_invoices_post POST /im-mailing/{item_id}/invoices Finalize Invoice
ImMailingInvoicesApi get_invoice_download_url_im_mailing_item_id_invoices_invoice_id_download_url_get GET /im-mailing/{item_id}/invoices/{invoice_id}/download-url Get Invoice Download Url
ImMailingInvoicesApi get_invoice_im_mailing_item_id_invoices_invoice_id_get GET /im-mailing/{item_id}/invoices/{invoice_id} Get Invoice
ImMailingInvoicesApi list_invoices_im_mailing_item_id_invoices_get GET /im-mailing/{item_id}/invoices List Invoices
ImMailingInvoicesApi request_upload_url_im_mailing_item_id_invoices_upload_url_post POST /im-mailing/{item_id}/invoices/upload-url Request Upload Url
ImSrosApi create_im_sro_im_sros_post POST /im-sros Create Im Sro
ImSrosApi delete_im_sro_im_sros_sro_id_delete DELETE /im-sros/{sro_id} Delete Im Sro
ImSrosApi get_im_sro_im_sros_sro_id_get GET /im-sros/{sro_id} Get Im Sro
ImSrosApi list_im_sros_im_sros_get GET /im-sros List Im Sros
ImSrosApi update_im_sro_im_sros_sro_id_patch PATCH /im-sros/{sro_id} Update Im Sro
InsurancesApi get_insurance_insurances_insurance_id_get GET /insurances/{insurance_id} Get Insurance
InsurancesApi list_insurances_insurances_get GET /insurances List Insurances
OrganizationPhonesApi create_org_phone_organization_phones_post POST /organization-phones Create Org Phone
OrganizationPhonesApi delete_org_phone_organization_phones_item_id_delete DELETE /organization-phones/{item_id} Delete Org Phone
OrganizationPhonesApi get_org_phone_organization_phones_item_id_get GET /organization-phones/{item_id} Get Org Phone
OrganizationPhonesApi list_org_phones_organization_phones_get GET /organization-phones List Org Phones
OrganizationPhonesApi update_org_phone_organization_phones_item_id_patch PATCH /organization-phones/{item_id} Update Org Phone
OrganizationsApi create_organization_organizations_post POST /organizations Create Organization
OrganizationsApi delete_organization_organizations_organization_id_delete DELETE /organizations/{organization_id} Delete Organization
OrganizationsApi get_organization_by_inn_organizations_by_inn_inn_get GET /organizations/by-inn/{inn} Get Organization By Inn
OrganizationsApi get_organization_organizations_organization_id_get GET /organizations/{organization_id} Get Organization
OrganizationsApi list_organization_insurances_organizations_organization_id_insurances_get GET /organizations/{organization_id}/insurances List Organization Insurances
OrganizationsApi list_organizations_organizations_get GET /organizations List Organizations
OrganizationsApi update_organization_organizations_organization_id_patch PATCH /organizations/{organization_id} Update Organization
ParserApi get_sro_by_inn_parser_sros_by_inn_inn_get GET /parser/sros/by-inn/{inn} Get Sro By Inn
ParserApi get_sro_member_by_inn_parser_sro_members_by_inn_inn_get GET /parser/sro-members/by-inn/{inn} Get Sro Member By Inn
ParserApi get_sro_member_parser_sro_members_member_id_get GET /parser/sro-members/{member_id} Get Sro Member
ParserApi get_sro_parser_sros_sro_id_get GET /parser/sros/{sro_id} Get Sro
ParserApi list_sro_members_parser_sro_members_get GET /parser/sro-members List Sro Members
ParserApi list_sros_parser_sros_get GET /parser/sros List Sros
ParserWriteApi upsert_sro_members_parser_sro_members_post POST /parser/sro-members Upsert Sro Members
ParserWriteApi upsert_sro_parser_sros_post POST /parser/sros Upsert Sro
PixelApi email_message_pixel_pixel_email_message_get GET /pixel/email-message Email Message Pixel
PixelApi tracking_pixel_pixel_tracking_pixel_get GET /pixel/tracking_pixel Tracking Pixel
SmrContractsApi create_item_smr_contracts_post POST /smr-contracts Create Item
SmrContractsApi create_magic_link_smr_contracts_smr_contracts_id_magic_link_post POST /smr-contracts/{smr_contracts_id}/magic-link Create Magic Link
SmrContractsApi delete_item_smr_contracts_item_id_delete DELETE /smr-contracts/{item_id} Delete Item
SmrContractsApi get_item_smr_contracts_item_id_get GET /smr-contracts/{item_id} Get Item
SmrContractsApi list_items_smr_contracts_get GET /smr-contracts List Items
SmrContractsApi update_item_smr_contracts_item_id_patch PATCH /smr-contracts/{item_id} Update Item
SroLeadsApi create_sro_lead_sro_leads_post POST /sro-leads Create Sro Lead
SroLeadsApi delete_sro_lead_sro_leads_lead_id_delete DELETE /sro-leads/{lead_id} Delete Sro Lead
SroLeadsApi get_sro_lead_sro_leads_lead_id_get GET /sro-leads/{lead_id} Get Sro Lead
SroLeadsApi list_sro_leads_sro_leads_get GET /sro-leads List Sro Leads
SroLeadsApi update_sro_lead_sro_leads_lead_id_patch PATCH /sro-leads/{lead_id} Update Sro Lead
UsersApi get_me_users_me_get GET /users/me Get Me

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

  • Type: Bearer authentication

Author

info@nexium.me

Project details


Download files

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

Source Distribution

sromaster-0.1.53.tar.gz (134.2 kB view details)

Uploaded Source

Built Distribution

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

sromaster-0.1.53-py3-none-any.whl (319.4 kB view details)

Uploaded Python 3

File details

Details for the file sromaster-0.1.53.tar.gz.

File metadata

  • Download URL: sromaster-0.1.53.tar.gz
  • Upload date:
  • Size: 134.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for sromaster-0.1.53.tar.gz
Algorithm Hash digest
SHA256 c2131a061e6295824a734d7bba10a8d051d03b5d1d7a545d7e9f0aa5b4acdb5b
MD5 d6fce6d403374bf5650efd74985b4f38
BLAKE2b-256 3570e591ad216c92327c938e5fd0eeecd6e6b6fba458997eb701de15f15bcdd8

See more details on using hashes here.

File details

Details for the file sromaster-0.1.53-py3-none-any.whl.

File metadata

  • Download URL: sromaster-0.1.53-py3-none-any.whl
  • Upload date:
  • Size: 319.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for sromaster-0.1.53-py3-none-any.whl
Algorithm Hash digest
SHA256 6a416608e03dc54fcd9208e6be76a49b09018fca49eb614726fe4e58dc3f123f
MD5 72e077828a4be215b17e66a7e2d7f465
BLAKE2b-256 c8636aca73e6121b8cddc4fb38f345d2dbde4bee984768d2204f6da59eba1d8e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page