SRO Master API
Project description
sromaster
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.35
- Package version: 0.1.35
- Generator version: 7.14.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.CustomersApi(api_client)
customer_id = 56 # int |
customer_email_in = sromaster.CustomerEmailIn() # CustomerEmailIn |
try:
# Add Customer Email
api_response = await api_instance.add_customer_email_customers_customer_id_emails_post(customer_id, customer_email_in)
print("The response of CustomersApi->add_customer_email_customers_customer_id_emails_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling CustomersApi->add_customer_email_customers_customer_id_emails_post: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CustomersApi | add_customer_email_customers_customer_id_emails_post | POST /customers/{customer_id}/emails | Add Customer Email |
| 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_email_customers_customer_id_emails_email_id_delete | DELETE /customers/{customer_id}/emails/{email_id} | Delete Customer Email |
| 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_emails_customers_customer_id_emails_get | GET /customers/{customer_id}/emails | List Customer Emails |
| 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_email_customers_customer_id_emails_email_id_patch | PATCH /customers/{customer_id}/emails/{email_id} | Update Customer Email |
| CustomersApi | update_customer_phone_customers_customer_id_phones_phone_id_patch | PATCH /customers/{customer_id}/phones/{phone_id} | Update Customer Phone |
| 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 |
| OrganizationEmailsApi | create_org_email_organization_emails_post | POST /organization-emails | Create Org Email |
| OrganizationEmailsApi | delete_org_email_organization_emails_item_id_delete | DELETE /organization-emails/{item_id} | Delete Org Email |
| OrganizationEmailsApi | get_org_email_organization_emails_item_id_get | GET /organization-emails/{item_id} | Get Org Email |
| OrganizationEmailsApi | list_org_emails_organization_emails_get | GET /organization-emails | List Org Emails |
| OrganizationEmailsApi | update_org_email_organization_emails_item_id_patch | PATCH /organization-emails/{item_id} | Update Org Email |
| 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_emails_organizations_organization_id_emails_get | GET /organizations/{organization_id}/emails | List Organization Emails |
| 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 | tracking_pixel_pixel_tracking_pixel_get | GET /pixel/tracking_pixel | Tracking Pixel |
| 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
- AccordanceStatus
- CheckDisciplinaryAction
- CheckOut
- CheckResult
- CheckType
- CheckUpsertRequest
- CustomerCreate
- CustomerEmailIn
- CustomerEmailOut
- CustomerOut
- CustomerPhoneIn
- CustomerPhoneOut
- CustomerStatus
- CustomerUpdate
- Data
- EmailSearchStatus
- HTTPValidationError
- IMInsurerCreate
- IMInsurerNameVariantCreate
- IMInsurerNameVariantOut
- IMInsurerNameVariantUpdate
- IMInsurerOut
- IMInsurerUpdate
- IMMailingCreate
- IMMailingInvoiceOut
- IMMailingInvoiceSummary
- IMMailingOutInput
- IMMailingOutOutput
- IMMailingUpdate
- IMSroPublicInput
- IMSroPublicOutput
- IMSroUpsertRequest
- InsuranceOut
- InsurancePremium
- InsurancePremiumFrom
- InsurancePremiumTo
- InsuranceUpsertRequest
- InsuredSum
- InsuredSumFrom
- InsuredSumTo
- InvoiceFinalizeRequest
- InvoiceStatus
- InvoiceUploadUrlRequest
- InvoiceUploadUrlResponse
- LeadStatus
- LegalForm
- MailingResult
- MailingStatus
- MemberStatus
- MessageStatus
- OrganizationCreate
- OrganizationDetailOut
- OrganizationEmailCreate
- OrganizationEmailOut
- OrganizationEmailUpdate
- OrganizationOut
- OrganizationPhoneCreate
- OrganizationPhoneOut
- OrganizationPhoneUpdate
- OrganizationPublic
- OrganizationSchema
- OrganizationUpdate
- PageCustomerOutInput
- PageCustomerOutOutput
- PageIMInsurerNameVariantOut
- PageIMInsurerOutInput
- PageIMInsurerOutOutput
- PageIMMailingInvoiceOut
- PageIMMailingOutInput
- PageIMMailingOutOutput
- PageIMSroPublicInput
- PageIMSroPublicOutput
- PageInsuranceOut
- PageOrganizationEmailOut
- PageOrganizationOutInput
- PageOrganizationOutOutput
- PageOrganizationPhoneOut
- PageSROMemberListItemInput
- PageSROMemberListItemOutput
- PageSROPublicInput
- PageSROPublicOutput
- PageSroLeadOutInput
- PageSroLeadOutOutput
- ParticipationStatus
- ResponseDataCustomerEmailOut
- ResponseDataCustomerOut
- ResponseDataCustomerPhoneOut
- ResponseDataIMInsurerNameVariantOut
- ResponseDataIMInsurerOut
- ResponseDataIMMailingInvoiceOut
- ResponseDataIMMailingOut
- ResponseDataIMSroPublic
- ResponseDataInsuranceOut
- ResponseDataInvoiceUploadUrlResponse
- ResponseDataListCustomerEmailOut
- ResponseDataListCustomerPhoneOut
- ResponseDataListIMMailingOut
- ResponseDataListOrganizationEmailOut
- ResponseDataOrganizationDetailOut
- ResponseDataOrganizationEmailOut
- ResponseDataOrganizationOut
- ResponseDataOrganizationPhoneOut
- ResponseDataPageCustomerOut
- ResponseDataPageIMInsurerNameVariantOut
- ResponseDataPageIMInsurerOut
- ResponseDataPageIMMailingInvoiceOut
- ResponseDataPageIMMailingOut
- ResponseDataPageIMSroPublic
- ResponseDataPageInsuranceOut
- ResponseDataPageOrganizationEmailOut
- ResponseDataPageOrganizationOut
- ResponseDataPageOrganizationPhoneOut
- ResponseDataPageSROMemberListItem
- ResponseDataPageSROPublic
- ResponseDataSROMemberDetails
- ResponseDataSROPublic
- ResponseDataSroLeadOut
- ResponseDataStr
- ResponseDataUnionPageSroLeadOutListSroLeadOut
- ResponseDataUserResponse
- ResponsibilityLevel
- RightStatus
- SROMemberDetailsInput
- SROMemberDetailsOutput
- SROMemberListItemInput
- SROMemberListItemOutput
- SROMemberUpsertRequest
- SROPublic
- SROShort
- SROStatus
- SROUpsertRequest
- SourceRegistry
- SrcModelsSroMemberRegistry
- SroLeadCreate
- SroLeadOut
- SroLeadUpdate
- SroType
- TariffEntry
- UserResponse
- ValidationError
- ValidationErrorLocInner
Documentation For Authorization
Authentication schemes defined for the API:
HTTPBearer
- Type: Bearer authentication
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sromaster-0.1.35.tar.gz.
File metadata
- Download URL: sromaster-0.1.35.tar.gz
- Upload date:
- Size: 171.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
712ac1d3637fb1b06606affd0126b1a2a3ba192940c349ff389bfb8bd1edd008
|
|
| MD5 |
6d877d8f3084cb34a65f97bd3118f987
|
|
| BLAKE2b-256 |
147567a7813f6d405ed4e9f057a03c972f246564758a77ee91bebc2cfc3b24fa
|
File details
Details for the file sromaster-0.1.35-py3-none-any.whl.
File metadata
- Download URL: sromaster-0.1.35-py3-none-any.whl
- Upload date:
- Size: 407.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30ee3efdf200a3337716fa2a3cdcf41035fe1882220229621722f05ca2c55e25
|
|
| MD5 |
af07969d2d623fe8f170c8d3030c39ba
|
|
| BLAKE2b-256 |
94936a2b316076cea80ce702d2dd785d4a921a45e679d9b8759d60b5e33bce21
|