bsg-sdk 0.1.0
BSG Python SDK for One-API
License: MIT
Requires Python: >=3.8
Keywords: BSG, SMS, Viber, WhatsApp, RCS, API, SDK

# BSG Python SDK

Official Python SDK for BSG One-API. Send SMS, Viber, RCS, WhatsApp messages and more.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.0
- Package version: 1.0.0
- Generator version: 7.12.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.8+

## Installation & Usage
### pip install

Install from PyPI:

```sh
pip install bsg-sdk
```

Or install from repository:

```sh
pip install git+https://github.com/bsgworld/python-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/bsgworld/python-sdk.git`)

Then import the package:
```python
import bsg_api
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import bsg_api
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python
import bsg_api
from bsg_api.rest import ApiException
from pprint import pprint

# Configure API
configuration = bsg_api.Configuration(
    host="https://one-api.bsg.world"
)

with bsg_api.ApiClient(configuration) as api_client:
    # Step 1: Authenticate
    auth_api = bsg_api.AuthApi(api_client)
    login_request = {"api_key": "live_XXXXXXXXXXXXXXXXXXXX"}

    try:
        token_response = auth_api.login(login_request)
        token = token_response.bearer
        print(f"Authenticated! Token: {token[:20]}...")
    except ApiException as e:
        print(f"Authentication failed: {e}")
        exit(1)

# Step 2: Send SMS with obtained token
configuration.access_token = token

with bsg_api.ApiClient(configuration) as api_client:
    sms_api = bsg_api.CampaignSMSApi(api_client)
    sms_request = {
        "phones": [{"number": 380661234567}],
        "sender": "BSG",
        "text": "Hello from BSG SDK!"
    }

    try:
        response = sms_api.sms_send(sms_request)
        print(f"SMS sent! Campaign ID: {response.id}")
        pprint(response)
    except ApiException as e:
        print(f"Failed to send SMS: {e}")
```

## Documentation for API Endpoints

All URIs are relative to *https://one-api.bsg.world*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountSettingsApi* | [**get_settings_address_book_fields_by_id**](docs/AccountSettingsApi.md#get_settings_address_book_fields_by_id) | **GET** /api/settings/address-book-fields/{id} | Get settings value
*AuthApi* | [**login**](docs/AuthApi.md#login) | **POST** /api/auth/login | Receive JWT token
*AuthApi* | [**refresh_token**](docs/AuthApi.md#refresh_token) | **POST** /api/auth/refresh | Refresh JWT token
*BalanceApi* | [**account_balance**](docs/BalanceApi.md#account_balance) | **GET** /api/accounts/balance | Get balance
*BalanceApi* | [**account_tariffs**](docs/BalanceApi.md#account_tariffs) | **GET** /api/accounts/tariff | Get tariffs
*CampaignApi* | [**campaign**](docs/CampaignApi.md#campaign) | **GET** /api/campaigns/{id} | Get campaign info
*CampaignApi* | [**campaign_details**](docs/CampaignApi.md#campaign_details) | **GET** /api/campaigns/{id}/detail | Get campaign details
*CampaignApi* | [**campaign_price**](docs/CampaignApi.md#campaign_price) | **POST** /api/campaigns/price | Calculate campaign price
*CampaignApi* | [**campaign_stop**](docs/CampaignApi.md#campaign_stop) | **PATCH** /api/campaigns/{id}/stop | Cancel campaign
*CampaignApi* | [**campaigns**](docs/CampaignApi.md#campaigns) | **GET** /api/campaigns | List of campaigns
*CampaignRCSApi* | [**rcs_send**](docs/CampaignRCSApi.md#rcs_send) | **POST** /api/campaigns/rcs/send | Send RCS message
*CampaignRCSApi* | [**rcs_send_groups**](docs/CampaignRCSApi.md#rcs_send_groups) | **POST** /api/campaigns/rcs/send-groups | Send RCS message to contact list
*CampaignRCSApi* | [**rcs_single**](docs/CampaignRCSApi.md#rcs_single) | **POST** /api/messages/rcs/send | Send single RCS message
*CampaignSMSApi* | [**sms_send**](docs/CampaignSMSApi.md#sms_send) | **POST** /api/campaigns/sms/send | Send SMS campaign
*CampaignSMSApi* | [**sms_send_groups**](docs/CampaignSMSApi.md#sms_send_groups) | **POST** /api/campaigns/sms/send-groups | Send SMS to contact list
*CampaignSMSApi* | [**sms_send_individual**](docs/CampaignSMSApi.md#sms_send_individual) | **POST** /api/campaigns/sms/send-individual | Send SMS with different text
*CampaignWhatsAppApi* | [**post_campaigns_whatsapp_send**](docs/CampaignWhatsAppApi.md#post_campaigns_whatsapp_send) | **POST** /api/campaigns/whatsapp/send | Send WhatsApp campaign
*ContactApi* | [**contact**](docs/ContactApi.md#contact) | **GET** /api/contacts/{id} | Get contact by ID
*ContactApi* | [**contact_create**](docs/ContactApi.md#contact_create) | **POST** /api/contacts | Create a contact
*ContactApi* | [**contact_delete**](docs/ContactApi.md#contact_delete) | **DELETE** /api/contacts/{id} | Delete contact
*ContactApi* | [**contact_update**](docs/ContactApi.md#contact_update) | **PUT** /api/contacts/{id} | Update contact
*ContactApi* | [**contacts**](docs/ContactApi.md#contacts) | **GET** /api/contacts | List of contacts
*ContactApi* | [**contacts_delete**](docs/ContactApi.md#contacts_delete) | **POST** /api/contacts/delete | Delete multiple contacts
*ContactApi* | [**contacts_search**](docs/ContactApi.md#contacts_search) | **GET** /api/contacts/search | Search contacts
*ContactFieldApi* | [**contact_field_create**](docs/ContactFieldApi.md#contact_field_create) | **POST** /api/contacts/fields | Create contact field
*ContactFieldApi* | [**contact_field_update**](docs/ContactFieldApi.md#contact_field_update) | **PATCH** /api/contacts/fields/{id} | Update contact field
*ContactFieldApi* | [**contact_fields**](docs/ContactFieldApi.md#contact_fields) | **GET** /api/contacts/fields | List of contact fields
*ContactFieldApi* | [**post_contacts_fields_delete**](docs/ContactFieldApi.md#post_contacts_fields_delete) | **POST** /api/contacts/fields/delete | Delete contact fields by ids
*ContactListApi* | [**contact_list**](docs/ContactListApi.md#contact_list) | **GET** /api/groups/{id} | Get list by id
*ContactListApi* | [**contact_list_attach**](docs/ContactListApi.md#contact_list_attach) | **POST** /api/groups/attach | Add contacts to the list
*ContactListApi* | [**contact_list_create**](docs/ContactListApi.md#contact_list_create) | **POST** /api/groups | Create list
*ContactListApi* | [**contact_list_delete**](docs/ContactListApi.md#contact_list_delete) | **DELETE** /api/groups/{id} | Delete list
*ContactListApi* | [**contact_list_detach**](docs/ContactListApi.md#contact_list_detach) | **POST** /api/groups/detach | Remove contacts from the list
*ContactListApi* | [**contact_list_search**](docs/ContactListApi.md#contact_list_search) | **GET** /api/groups/search | Search list
*ContactListApi* | [**contact_list_update**](docs/ContactListApi.md#contact_list_update) | **PUT** /api/groups/{id} | Update list
*ContactListApi* | [**contact_lists**](docs/ContactListApi.md#contact_lists) | **GET** /api/groups | List of contact lists
*EmailApi* | [**email_send**](docs/EmailApi.md#email_send) | **POST** /api/email/send-emails | Send Email
*EmailApi* | [**email_template_send**](docs/EmailApi.md#email_template_send) | **POST** /api/email/send-template-emails | Send Email template
*InternalCorePriceApi* | [**get_internal_core_prices**](docs/InternalCorePriceApi.md#get_internal_core_prices) | **GET** /api/internal/core/prices | Get price list for each country
*InternalCorePriceApi* | [**get_internal_core_prices_by_country_code**](docs/InternalCorePriceApi.md#get_internal_core_prices_by_country_code) | **GET** /api/internal/core/prices/{countryCode} | Get prices for country
*InternalCountryApi* | [**get_internal_countries**](docs/InternalCountryApi.md#get_internal_countries) | **GET** /api/internal/countries | Get countries list
*InternalCurrencyApi* | [**get_internal_currencies**](docs/InternalCurrencyApi.md#get_internal_currencies) | **GET** /api/internal/currencies | Get currencies list 
*InternalTwoFAApi* | [**get_internal2fa_authentications_full_price**](docs/InternalTwoFAApi.md#get_internal2fa_authentications_full_price) | **GET** /api/internal/2fa/authentications/full-price | Show TwoFA authentication full price
*InternalWstPriceApi* | [**get_internal_wst_prices**](docs/InternalWstPriceApi.md#get_internal_wst_prices) | **GET** /api/internal/wst/prices | Get price list for each country
*InternalWstPriceApi* | [**get_internal_wst_prices_by_country_code**](docs/InternalWstPriceApi.md#get_internal_wst_prices_by_country_code) | **GET** /api/internal/wst/prices/{countryCode} | Get prices for country
*MessagesSMSApi* | [**get_messages**](docs/MessagesSMSApi.md#get_messages) | **GET** /api/messages | Find messages
*MessagesWhatsAppApi* | [**whatsapp_single**](docs/MessagesWhatsAppApi.md#whatsapp_single) | **POST** /api/messages/whatsapp/send | Send single WhatsApp message
*SendersApi* | [**sender_request_legal**](docs/SendersApi.md#sender_request_legal) | **POST** /api/senders/requests/legal | Sender registration by a legal entity
*SendersApi* | [**sender_request_natural**](docs/SendersApi.md#sender_request_natural) | **POST** /api/senders/requests/natural | Sender registration by an individual
*SendersApi* | [**sender_requests**](docs/SendersApi.md#sender_requests) | **GET** /api/senders/requests/sms | List of Sender Requests
*SendersApi* | [**senders**](docs/SendersApi.md#senders) | **GET** /api/senders | List of Senders
*ShortDomainsApi* | [**short_urls_domain**](docs/ShortDomainsApi.md#short_urls_domain) | **GET** /api/short-url/domains/{uuid} | Get domain by uuid
*ShortDomainsApi* | [**short_urls_domain_create**](docs/ShortDomainsApi.md#short_urls_domain_create) | **POST** /api/short-url/domains | Add domain
*ShortDomainsApi* | [**short_urls_domain_remove**](docs/ShortDomainsApi.md#short_urls_domain_remove) | **DELETE** /api/short-url/domains/{uuid} | Remove domain
*ShortDomainsApi* | [**short_urls_domain_update**](docs/ShortDomainsApi.md#short_urls_domain_update) | **PUT** /api/short-url/domains/{uuid} | Update domain
*ShortDomainsApi* | [**short_urls_domains**](docs/ShortDomainsApi.md#short_urls_domains) | **GET** /api/short-url/domains | List of domains
*ShortLinksApi* | [**short_urls_clicks**](docs/ShortLinksApi.md#short_urls_clicks) | **GET** /api/short-url/clicks | List of clicks
*ShortLinksApi* | [**short_urls_link**](docs/ShortLinksApi.md#short_urls_link) | **GET** /api/short-url/links/{uuid}/statistics | Get short link statistic
*ShortLinksApi* | [**short_urls_link_create**](docs/ShortLinksApi.md#short_urls_link_create) | **POST** /api/short-url/links | Create short link
*ShortLinksApi* | [**short_urls_link_delete**](docs/ShortLinksApi.md#short_urls_link_delete) | **DELETE** /api/short-url/links/{uuid} | Remove short link
*ShortLinksApi* | [**short_urls_link_update**](docs/ShortLinksApi.md#short_urls_link_update) | **PUT** /api/short-url/links/{uuid} | Update short link
*ShortLinksApi* | [**short_urls_links**](docs/ShortLinksApi.md#short_urls_links) | **GET** /api/short-url/links | List of short links
*StopListApi* | [**stoplist_add**](docs/StopListApi.md#stoplist_add) | **POST** /api/stoplist/attach | Add contacts to stop list
*StopListApi* | [**stoplist_items**](docs/StopListApi.md#stoplist_items) | **GET** /api/stoplist | List the contacts of stop lists
*StopListApi* | [**stoplist_remove**](docs/StopListApi.md#stoplist_remove) | **POST** /api/stoplist/detach | Remove contacts from stop list
*StopListApi* | [**stoplist_search**](docs/StopListApi.md#stoplist_search) | **GET** /api/stoplist/search | Search contacts in Stop lists
*TwoFAOTPApi* | [**cancel_otp**](docs/TwoFAOTPApi.md#cancel_otp) | **POST** /api/2fa/authentications/{id}/cancel | Cancel the authentication session
*TwoFAOTPApi* | [**otp_list**](docs/TwoFAOTPApi.md#otp_list) | **GET** /api/2fa/authentications | List of authentication sessions
*TwoFAOTPApi* | [**resend_otp**](docs/TwoFAOTPApi.md#resend_otp) | **POST** /api/2fa/authentications/otp/{id}/resend | Resend the one-time code
*TwoFAOTPApi* | [**send_otp**](docs/TwoFAOTPApi.md#send_otp) | **POST** /api/2fa/authentications/otp | Send One-time password
*TwoFAOTPApi* | [**status_otp**](docs/TwoFAOTPApi.md#status_otp) | **GET** /api/2fa/authentications/{id} | Check authentication status
*TwoFAOTPApi* | [**verify_otp**](docs/TwoFAOTPApi.md#verify_otp) | **POST** /api/2fa/authentications/otp/{id}/verify | Check one-time Code
*TwoFATemplatesApi* | [**otp_template**](docs/TwoFATemplatesApi.md#otp_template) | **GET** /api/2fa/authentications/templates/{templateId} | Get message template
*TwoFATemplatesApi* | [**otp_template_create**](docs/TwoFATemplatesApi.md#otp_template_create) | **POST** /api/2fa/authentications/templates | Create a message template
*TwoFATemplatesApi* | [**otp_template_delete**](docs/TwoFATemplatesApi.md#otp_template_delete) | **DELETE** /api/2fa/authentications/templates/{templateId} | Delete a message template
*TwoFATemplatesApi* | [**otp_template_list**](docs/TwoFATemplatesApi.md#otp_template_list) | **GET** /api/2fa/authentications/templates | List of message templates


## Documentation For Models

 - [AccountBalance200Response](docs/AccountBalance200Response.md)
 - [AccountTariffs200Response](docs/AccountTariffs200Response.md)
 - [AlternativeChannel](docs/AlternativeChannel.md)
 - [BalanceSchema](docs/BalanceSchema.md)
 - [Campaign200Response](docs/Campaign200Response.md)
 - [CampaignDetails200Response](docs/CampaignDetails200Response.md)
 - [CampaignPrice200Response](docs/CampaignPrice200Response.md)
 - [CampaignPrice422Response](docs/CampaignPrice422Response.md)
 - [CampaignPriceRequest](docs/CampaignPriceRequest.md)
 - [CampaignPriceRequestMessagesItem](docs/CampaignPriceRequestMessagesItem.md)
 - [CampaignSchema](docs/CampaignSchema.md)
 - [CampaignStatus](docs/CampaignStatus.md)
 - [CampaignStop200Response](docs/CampaignStop200Response.md)
 - [CampaignStop422Response](docs/CampaignStop422Response.md)
 - [CancelOtp200Response](docs/CancelOtp200Response.md)
 - [CancelOtp404Response](docs/CancelOtp404Response.md)
 - [CancelOtp422Response](docs/CancelOtp422Response.md)
 - [Card](docs/Card.md)
 - [Cards](docs/Cards.md)
 - [ClickResource](docs/ClickResource.md)
 - [Components](docs/Components.md)
 - [Contact200Response](docs/Contact200Response.md)
 - [Contact422Response](docs/Contact422Response.md)
 - [ContactCreate201Response](docs/ContactCreate201Response.md)
 - [ContactCreate422Response](docs/ContactCreate422Response.md)
 - [ContactFieldCollectionSchema](docs/ContactFieldCollectionSchema.md)
 - [ContactFieldCreate201Response](docs/ContactFieldCreate201Response.md)
 - [ContactFieldCreateRequest](docs/ContactFieldCreateRequest.md)
 - [ContactFieldSchema](docs/ContactFieldSchema.md)
 - [ContactFieldType](docs/ContactFieldType.md)
 - [ContactFieldUpdate200Response](docs/ContactFieldUpdate200Response.md)
 - [ContactFieldUpdateRequest](docs/ContactFieldUpdateRequest.md)
 - [ContactFieldUpdateRequestOption1](docs/ContactFieldUpdateRequestOption1.md)
 - [ContactFieldUpdateRequestOption2](docs/ContactFieldUpdateRequestOption2.md)
 - [ContactFieldUpdateRequestOption3](docs/ContactFieldUpdateRequestOption3.md)
 - [ContactFieldValuePair](docs/ContactFieldValuePair.md)
 - [ContactGroupSchema](docs/ContactGroupSchema.md)
 - [ContactGroupSearchField](docs/ContactGroupSearchField.md)
 - [ContactGroupSearchSchema](docs/ContactGroupSearchSchema.md)
 - [ContactList200Response](docs/ContactList200Response.md)
 - [ContactListAttachRequest](docs/ContactListAttachRequest.md)
 - [ContactListCreate201Response](docs/ContactListCreate201Response.md)
 - [ContactListCreate422Response](docs/ContactListCreate422Response.md)
 - [ContactListCreateRequest](docs/ContactListCreateRequest.md)
 - [ContactListDetachRequest](docs/ContactListDetachRequest.md)
 - [ContactListSearch200Response](docs/ContactListSearch200Response.md)
 - [ContactListSearch200ResponseMeta](docs/ContactListSearch200ResponseMeta.md)
 - [ContactListSearch200ResponseMetaPage](docs/ContactListSearch200ResponseMetaPage.md)
 - [ContactListSearch200ResponseMetaSearch](docs/ContactListSearch200ResponseMetaSearch.md)
 - [ContactListUpdate200Response](docs/ContactListUpdate200Response.md)
 - [ContactListUpdate422Response](docs/ContactListUpdate422Response.md)
 - [ContactListUpdateRequest](docs/ContactListUpdateRequest.md)
 - [ContactLists200Response](docs/ContactLists200Response.md)
 - [ContactSchema](docs/ContactSchema.md)
 - [ContactUpdate200Response](docs/ContactUpdate200Response.md)
 - [ContactUpdate422Response](docs/ContactUpdate422Response.md)
 - [ContactUpdateRequest](docs/ContactUpdateRequest.md)
 - [Contacts200Response](docs/Contacts200Response.md)
 - [ContactsSearch200Response](docs/ContactsSearch200Response.md)
 - [ContactsSearch200ResponseMeta](docs/ContactsSearch200ResponseMeta.md)
 - [ContactsSearch200ResponseMetaPage](docs/ContactsSearch200ResponseMetaPage.md)
 - [ContactsSearch200ResponseMetaSearch](docs/ContactsSearch200ResponseMetaSearch.md)
 - [CorePriceSchema](docs/CorePriceSchema.md)
 - [CurrencyObj](docs/CurrencyObj.md)
 - [DateTimeParameter](docs/DateTimeParameter.md)
 - [DetailCampaignSchema](docs/DetailCampaignSchema.md)
 - [DetailCampaignSchemaAlternativeChannels](docs/DetailCampaignSchemaAlternativeChannels.md)
 - [DetailCampaignSchemaAlternativeChannelsOneOf0Sms](docs/DetailCampaignSchemaAlternativeChannelsOneOf0Sms.md)
 - [DetailCampaignSchemaAlternativeChannelsOption1](docs/DetailCampaignSchemaAlternativeChannelsOption1.md)
 - [DomainStoreRequest](docs/DomainStoreRequest.md)
 - [DomainUpdateRequest](docs/DomainUpdateRequest.md)
 - [EmailResponse](docs/EmailResponse.md)
 - [GetInternal2faAuthenticationsFullPrice200Response](docs/GetInternal2faAuthenticationsFullPrice200Response.md)
 - [GetInternalCorePrices200Response](docs/GetInternalCorePrices200Response.md)
 - [GetInternalCorePricesByCountryCode200Response](docs/GetInternalCorePricesByCountryCode200Response.md)
 - [GetInternalCountries200Response](docs/GetInternalCountries200Response.md)
 - [GetInternalCountries200ResponseDataItem](docs/GetInternalCountries200ResponseDataItem.md)
 - [GetInternalCurrencies200Response](docs/GetInternalCurrencies200Response.md)
 - [GetInternalCurrencies200ResponseDataItem](docs/GetInternalCurrencies200ResponseDataItem.md)
 - [GetInternalWstPrices200Response](docs/GetInternalWstPrices200Response.md)
 - [GetInternalWstPricesByCountryCode200Response](docs/GetInternalWstPricesByCountryCode200Response.md)
 - [GetMessages200Response](docs/GetMessages200Response.md)
 - [GetMessages200ResponseMeta](docs/GetMessages200ResponseMeta.md)
 - [GetMessages200ResponseMetaPage](docs/GetMessages200ResponseMetaPage.md)
 - [IndividualMessageData](docs/IndividualMessageData.md)
 - [Inline](docs/Inline.md)
 - [Language](docs/Language.md)
 - [LinkStoreRequest](docs/LinkStoreRequest.md)
 - [LinkUpdateRequest](docs/LinkUpdateRequest.md)
 - [LoginRequest](docs/LoginRequest.md)
 - [Media](docs/Media.md)
 - [MediaObject](docs/MediaObject.md)
 - [MessageApiSchema](docs/MessageApiSchema.md)
 - [MessageApiSchemaAlternativeChannels](docs/MessageApiSchemaAlternativeChannels.md)
 - [MessageApiSchemaAlternativeChannelsOneOf0Sms](docs/MessageApiSchemaAlternativeChannelsOneOf0Sms.md)
 - [MessageApiSchemaAlternativeChannelsOneOf1Viber](docs/MessageApiSchemaAlternativeChannelsOneOf1Viber.md)
 - [MessageApiSchemaAlternativeChannelsOption1](docs/MessageApiSchemaAlternativeChannelsOption1.md)
 - [MessageApiSchemaAlternativeChannelsOption2](docs/MessageApiSchemaAlternativeChannelsOption2.md)
 - [MessageInfo](docs/MessageInfo.md)
 - [MessagePriceObject](docs/MessagePriceObject.md)
 - [MessageSource](docs/MessageSource.md)
 - [MessageStatus](docs/MessageStatus.md)
 - [MessageType](docs/MessageType.md)
 - [OperatorSchema](docs/OperatorSchema.md)
 - [Options](docs/Options.md)
 - [OtpChannel](docs/OtpChannel.md)
 - [OtpList200Response](docs/OtpList200Response.md)
 - [OtpList200ResponseData](docs/OtpList200ResponseData.md)
 - [OtpMessageStatus](docs/OtpMessageStatus.md)
 - [OtpStatus](docs/OtpStatus.md)
 - [OtpTemplate200Response](docs/OtpTemplate200Response.md)
 - [OtpTemplate404Response](docs/OtpTemplate404Response.md)
 - [OtpTemplateCreate200Response](docs/OtpTemplateCreate200Response.md)
 - [OtpTemplateCreate422Response](docs/OtpTemplateCreate422Response.md)
 - [OtpTemplateCreateRequest](docs/OtpTemplateCreateRequest.md)
 - [OtpTemplateDelete200Response](docs/OtpTemplateDelete200Response.md)
 - [OtpTemplateDelete200ResponseData](docs/OtpTemplateDelete200ResponseData.md)
 - [OtpTemplateDelete404Response](docs/OtpTemplateDelete404Response.md)
 - [OtpTemplateDelete422Response](docs/OtpTemplateDelete422Response.md)
 - [OtpTemplateList200Response](docs/OtpTemplateList200Response.md)
 - [OtpTemplateList200ResponseData](docs/OtpTemplateList200ResponseData.md)
 - [OtpTemplateStatus](docs/OtpTemplateStatus.md)
 - [Parameter](docs/Parameter.md)
 - [Phone](docs/Phone.md)
 - [PostContactsFieldsDeleteRequest](docs/PostContactsFieldsDeleteRequest.md)
 - [RcsClickCallback](docs/RcsClickCallback.md)
 - [RcsMessage](docs/RcsMessage.md)
 - [RcsSend200Response](docs/RcsSend200Response.md)
 - [RcsSendGroups200Response](docs/RcsSendGroups200Response.md)
 - [RcsSingle200Response](docs/RcsSingle200Response.md)
 - [RcsStatusCallback](docs/RcsStatusCallback.md)
 - [ResendOtp200Response](docs/ResendOtp200Response.md)
 - [ResendOtp404Response](docs/ResendOtp404Response.md)
 - [ResendOtp422Response](docs/ResendOtp422Response.md)
 - [SearchCampaignResource](docs/SearchCampaignResource.md)
 - [SearchCampaignResourceMeta](docs/SearchCampaignResourceMeta.md)
 - [SearchCampaignResourceMetaPage](docs/SearchCampaignResourceMetaPage.md)
 - [SearchOperator](docs/SearchOperator.md)
 - [SendEmail](docs/SendEmail.md)
 - [SendOtp201Response](docs/SendOtp201Response.md)
 - [SendOtp422Response](docs/SendOtp422Response.md)
 - [SendOtpRequest](docs/SendOtpRequest.md)
 - [SendRcsCampaign](docs/SendRcsCampaign.md)
 - [SendRcsCampaignGroups](docs/SendRcsCampaignGroups.md)
 - [SendRcsCampaignGroupsAlternativeChannel](docs/SendRcsCampaignGroupsAlternativeChannel.md)
 - [SendTemplateEmail](docs/SendTemplateEmail.md)
 - [SendWhatsAppCampaign](docs/SendWhatsAppCampaign.md)
 - [SendWhatsAppCampaignAlternativeChannel](docs/SendWhatsAppCampaignAlternativeChannel.md)
 - [SenderRequestLegal201Response](docs/SenderRequestLegal201Response.md)
 - [SenderRequestLegalRequest](docs/SenderRequestLegalRequest.md)
 - [SenderRequestLegalSchema](docs/SenderRequestLegalSchema.md)
 - [SenderRequestNatural201Response](docs/SenderRequestNatural201Response.md)
 - [SenderRequestNaturalRequest](docs/SenderRequestNaturalRequest.md)
 - [SenderRequestNaturalSchema](docs/SenderRequestNaturalSchema.md)
 - [SenderRequestSchema](docs/SenderRequestSchema.md)
 - [SenderRequestStatus](docs/SenderRequestStatus.md)
 - [SenderRequestType](docs/SenderRequestType.md)
 - [SenderRequests200Response](docs/SenderRequests200Response.md)
 - [SenderRequests200ResponseMeta](docs/SenderRequests200ResponseMeta.md)
 - [SenderRequests200ResponseMetaPage](docs/SenderRequests200ResponseMetaPage.md)
 - [SenderSchema](docs/SenderSchema.md)
 - [Senders200Response](docs/Senders200Response.md)
 - [ShortDomainNotFound](docs/ShortDomainNotFound.md)
 - [ShortDomainSlugType](docs/ShortDomainSlugType.md)
 - [ShortLink](docs/ShortLink.md)
 - [ShortLinkStatus](docs/ShortLinkStatus.md)
 - [ShortUrlDomainListSchema](docs/ShortUrlDomainListSchema.md)
 - [ShortUrlDomainSchema](docs/ShortUrlDomainSchema.md)
 - [ShortUrlLinkSchema](docs/ShortUrlLinkSchema.md)
 - [ShortUrlsClicks200Response](docs/ShortUrlsClicks200Response.md)
 - [ShortUrlsDomain200Response](docs/ShortUrlsDomain200Response.md)
 - [ShortUrlsDomainCreate201Response](docs/ShortUrlsDomainCreate201Response.md)
 - [ShortUrlsDomainCreate422Response](docs/ShortUrlsDomainCreate422Response.md)
 - [ShortUrlsDomainUpdate200Response](docs/ShortUrlsDomainUpdate200Response.md)
 - [ShortUrlsDomains200Response](docs/ShortUrlsDomains200Response.md)
 - [ShortUrlsLink200Response](docs/ShortUrlsLink200Response.md)
 - [ShortUrlsLink200ResponseData](docs/ShortUrlsLink200ResponseData.md)
 - [ShortUrlsLink404Response](docs/ShortUrlsLink404Response.md)
 - [ShortUrlsLinkCreate201Response](docs/ShortUrlsLinkCreate201Response.md)
 - [ShortUrlsLinkDelete422Response](docs/ShortUrlsLinkDelete422Response.md)
 - [ShortUrlsLinkUpdate200Response](docs/ShortUrlsLinkUpdate200Response.md)
 - [ShortUrlsLinkUpdate422Response](docs/ShortUrlsLinkUpdate422Response.md)
 - [ShortUrlsLinks200Response](docs/ShortUrlsLinks200Response.md)
 - [Sms](docs/Sms.md)
 - [SmsCampaignResponse](docs/SmsCampaignResponse.md)
 - [SmsSendGroupsRequest](docs/SmsSendGroupsRequest.md)
 - [SmsSendIndividualRequest](docs/SmsSendIndividualRequest.md)
 - [SmsSendRequest](docs/SmsSendRequest.md)
 - [SmsSendRequestPhonesItem](docs/SmsSendRequestPhonesItem.md)
 - [SortWay](docs/SortWay.md)
 - [StatisticsData](docs/StatisticsData.md)
 - [StatisticsShort](docs/StatisticsShort.md)
 - [StatusOtp200Response](docs/StatusOtp200Response.md)
 - [StatusOtp404Response](docs/StatusOtp404Response.md)
 - [StopListCollection](docs/StopListCollection.md)
 - [StopListPaginateSchema](docs/StopListPaginateSchema.md)
 - [StoplistAdd200Response](docs/StoplistAdd200Response.md)
 - [StoplistAddRequest](docs/StoplistAddRequest.md)
 - [StoplistItems200Response](docs/StoplistItems200Response.md)
 - [StoplistRemoveRequest](docs/StoplistRemoveRequest.md)
 - [StoplistSearch200Response](docs/StoplistSearch200Response.md)
 - [StoplistSearch200ResponseMeta](docs/StoplistSearch200ResponseMeta.md)
 - [StoplistSearch200ResponseMetaPage](docs/StoplistSearch200ResponseMetaPage.md)
 - [StoplistSearch200ResponseMetaSearch](docs/StoplistSearch200ResponseMetaSearch.md)
 - [StoplistSearchField](docs/StoplistSearchField.md)
 - [StoreContact](docs/StoreContact.md)
 - [Suggestion](docs/Suggestion.md)
 - [SuggestionCall](docs/SuggestionCall.md)
 - [SuggestionLink](docs/SuggestionLink.md)
 - [TariffSchema](docs/TariffSchema.md)
 - [Template](docs/Template.md)
 - [Text](docs/Text.md)
 - [TokenSchema](docs/TokenSchema.md)
 - [TooManyRequestsResponse](docs/TooManyRequestsResponse.md)
 - [TwoFaTemplateResource](docs/TwoFaTemplateResource.md)
 - [TwoFactorAuthenticationMessagesResource](docs/TwoFactorAuthenticationMessagesResource.md)
 - [TwoFactorAuthenticationSchema](docs/TwoFactorAuthenticationSchema.md)
 - [TwoFactorMessageResource](docs/TwoFactorMessageResource.md)
 - [VerifyOtp200Response](docs/VerifyOtp200Response.md)
 - [VerifyOtp404Response](docs/VerifyOtp404Response.md)
 - [VerifyOtp422Response](docs/VerifyOtp422Response.md)
 - [VerifyOtpRequest](docs/VerifyOtpRequest.md)
 - [Viber](docs/Viber.md)
 - [ViberOptions](docs/ViberOptions.md)
 - [WhatsAppMessage](docs/WhatsAppMessage.md)
 - [WhatsAppMessageAlternativeChannel](docs/WhatsAppMessageAlternativeChannel.md)
 - [WhatsAppMessageTemplate](docs/WhatsAppMessageTemplate.md)
 - [WhatsappSingle200Response](docs/WhatsappSingle200Response.md)
 - [WstPriceSchema](docs/WstPriceSchema.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ExternalAuth"></a>
### ExternalAuth

- **Type**: Bearer authentication (JWT)

<a id="InternalAuth"></a>
### InternalAuth

- **Type**: Bearer authentication (JWT)


## Author