Mediana-sdk


NameMediana-sdk JSON
Version 1.0.2 PyPI version JSON
download
home_page
SummaryMediana sms api
upload_time2023-06-05 16:14:20
maintainer
docs_urlNone
authorOpenAPI Generator community
requires_python>=3.6
licenseMIT
keywords openapi openapi-generator mediana sms api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Mediana-sdk
Mediana sms api doc </br>  sdks for some programming languages is in out github at https://github.com/ippanelippanel </br> api-key format: <code>Authorization: \"AccessKey your-api-key\"</code>

# Authentication

<!-- ReDoc-Inject: <security-definitions> -->

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

- API version: 1.0.1
- Package version: 1.0.2
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python >= 3.6

## Installation & Usage
### pip install

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

```sh
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:
```python
import Mediana-sdk
```

### 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 Mediana-sdk
```

## Getting Started

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

```python

import time
import Mediana-sdk
from pprint import pprint
from Mediana-sdk.api import auth_api
from Mediana-sdk.model.inline_response200 import InlineResponse200
from Mediana-sdk.model.inline_response401 import InlineResponse401
# Defining the host is optional and defaults to http://rest.ippanel.com
# See configuration.py for a list of all supported configuration parameters.
configuration = Mediana-sdk.Configuration(
    host = "http://rest.ippanel.com"
)

# 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'] = 'YOUR_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 Mediana-sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = auth_api.AuthApi(api_client)
    
    try:
        api_response = api_instance.get_authorized_user()
        pprint(api_response)
    except Mediana-sdk.ApiException as e:
        print("Exception when calling AuthApi->get_authorized_user: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *http://rest.ippanel.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuthApi* | [**get_authorized_user**](docs/AuthApi.md#get_authorized_user) | **GET** /v1/user | 
*CreditApi* | [**get_credit**](docs/CreditApi.md#get_credit) | **GET** /v1/credit | 
*MessagesApi* | [**create_pattern**](docs/MessagesApi.md#create_pattern) | **POST** /v1/messages/patterns | 
*MessagesApi* | [**fetch_inbox_messages**](docs/MessagesApi.md#fetch_inbox_messages) | **GET** /v1/messages/inbox | 
*MessagesApi* | [**get_message_recipients_status**](docs/MessagesApi.md#get_message_recipients_status) | **GET** /v1/messages/{bulk_id}/recipients | 
*MessagesApi* | [**get_sms**](docs/MessagesApi.md#get_sms) | **GET** /v1/messages/{bulk_id} | 
*MessagesApi* | [**send_pattern**](docs/MessagesApi.md#send_pattern) | **POST** /v1/messages/patterns/send | 
*MessagesApi* | [**send_sms**](docs/MessagesApi.md#send_sms) | **POST** /v1/messages | 


## Documentation For Models

 - [InboxMessage](docs/InboxMessage.md)
 - [InlineResponse200](docs/InlineResponse200.md)
 - [InlineResponse2001](docs/InlineResponse2001.md)
 - [InlineResponse2002](docs/InlineResponse2002.md)
 - [InlineResponse2003](docs/InlineResponse2003.md)
 - [InlineResponse2004](docs/InlineResponse2004.md)
 - [InlineResponse2005](docs/InlineResponse2005.md)
 - [InlineResponse2006](docs/InlineResponse2006.md)
 - [InlineResponse401](docs/InlineResponse401.md)
 - [Message](docs/Message.md)
 - [Meta](docs/Meta.md)
 - [Pattern](docs/Pattern.md)
 - [Recipient](docs/Recipient.md)
 - [User](docs/User.md)


## Documentation For Authorization


## ApiKeyAuth

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header


## Author




## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in Mediana-sdk.apis and Mediana-sdk.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1:
Use specific imports for apis and models like:
- `from Mediana-sdk.api.default_api import DefaultApi`
- `from Mediana-sdk.model.pet import Pet`

Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import Mediana-sdk
from Mediana-sdk.apis import *
from Mediana-sdk.models import *
```


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "Mediana-sdk",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "OpenAPI,OpenAPI-Generator,Mediana sms api",
    "author": "OpenAPI Generator community",
    "author_email": "team@openapitools.org",
    "download_url": "https://files.pythonhosted.org/packages/d6/2f/4672d97e31606c7b96d8c6307aada2afeca8a443d393114f8b957a2f22b3/Mediana-sdk-1.0.2.tar.gz",
    "platform": null,
    "description": "# Mediana-sdk\nMediana sms api doc </br>  sdks for some programming languages is in out github at https://github.com/ippanelippanel </br> api-key format: <code>Authorization: \\\"AccessKey your-api-key\\\"</code>\n\n# Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.1\n- Package version: 1.0.2\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython >= 3.6\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport Mediana-sdk\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport Mediana-sdk\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport Mediana-sdk\nfrom pprint import pprint\nfrom Mediana-sdk.api import auth_api\nfrom Mediana-sdk.model.inline_response200 import InlineResponse200\nfrom Mediana-sdk.model.inline_response401 import InlineResponse401\n# Defining the host is optional and defaults to http://rest.ippanel.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = Mediana-sdk.Configuration(\n    host = \"http://rest.ippanel.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: ApiKeyAuth\nconfiguration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith Mediana-sdk.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = auth_api.AuthApi(api_client)\n    \n    try:\n        api_response = api_instance.get_authorized_user()\n        pprint(api_response)\n    except Mediana-sdk.ApiException as e:\n        print(\"Exception when calling AuthApi->get_authorized_user: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://rest.ippanel.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AuthApi* | [**get_authorized_user**](docs/AuthApi.md#get_authorized_user) | **GET** /v1/user | \n*CreditApi* | [**get_credit**](docs/CreditApi.md#get_credit) | **GET** /v1/credit | \n*MessagesApi* | [**create_pattern**](docs/MessagesApi.md#create_pattern) | **POST** /v1/messages/patterns | \n*MessagesApi* | [**fetch_inbox_messages**](docs/MessagesApi.md#fetch_inbox_messages) | **GET** /v1/messages/inbox | \n*MessagesApi* | [**get_message_recipients_status**](docs/MessagesApi.md#get_message_recipients_status) | **GET** /v1/messages/{bulk_id}/recipients | \n*MessagesApi* | [**get_sms**](docs/MessagesApi.md#get_sms) | **GET** /v1/messages/{bulk_id} | \n*MessagesApi* | [**send_pattern**](docs/MessagesApi.md#send_pattern) | **POST** /v1/messages/patterns/send | \n*MessagesApi* | [**send_sms**](docs/MessagesApi.md#send_sms) | **POST** /v1/messages | \n\n\n## Documentation For Models\n\n - [InboxMessage](docs/InboxMessage.md)\n - [InlineResponse200](docs/InlineResponse200.md)\n - [InlineResponse2001](docs/InlineResponse2001.md)\n - [InlineResponse2002](docs/InlineResponse2002.md)\n - [InlineResponse2003](docs/InlineResponse2003.md)\n - [InlineResponse2004](docs/InlineResponse2004.md)\n - [InlineResponse2005](docs/InlineResponse2005.md)\n - [InlineResponse2006](docs/InlineResponse2006.md)\n - [InlineResponse401](docs/InlineResponse401.md)\n - [Message](docs/Message.md)\n - [Meta](docs/Meta.md)\n - [Pattern](docs/Pattern.md)\n - [Recipient](docs/Recipient.md)\n - [User](docs/User.md)\n\n\n## Documentation For Authorization\n\n\n## ApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n\n## Author\n\n\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in Mediana-sdk.apis and Mediana-sdk.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from Mediana-sdk.api.default_api import DefaultApi`\n- `from Mediana-sdk.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport Mediana-sdk\nfrom Mediana-sdk.apis import *\nfrom Mediana-sdk.models import *\n```\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Mediana sms api",
    "version": "1.0.2",
    "project_urls": null,
    "split_keywords": [
        "openapi",
        "openapi-generator",
        "mediana sms api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "be5553513132617e52803c04da9d8e7ea4bab162fbb2a4f9d8b40b5182de89d0",
                "md5": "b6cc589e65e6712fee9d683cdc9a7f51",
                "sha256": "0c4f22129481e9009e5c8f6a361671be19fe862a982bea131ea23f65ec645940"
            },
            "downloads": -1,
            "filename": "Mediana_sdk-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b6cc589e65e6712fee9d683cdc9a7f51",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 81649,
            "upload_time": "2023-06-05T16:14:16",
            "upload_time_iso_8601": "2023-06-05T16:14:16.947542Z",
            "url": "https://files.pythonhosted.org/packages/be/55/53513132617e52803c04da9d8e7ea4bab162fbb2a4f9d8b40b5182de89d0/Mediana_sdk-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d62f4672d97e31606c7b96d8c6307aada2afeca8a443d393114f8b957a2f22b3",
                "md5": "19e44523978b57e02f2a098484d9ff8f",
                "sha256": "a1e23fff8d4b96955321c8f8ed84065f658a8849521353831a4d5980e4110859"
            },
            "downloads": -1,
            "filename": "Mediana-sdk-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "19e44523978b57e02f2a098484d9ff8f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 44021,
            "upload_time": "2023-06-05T16:14:20",
            "upload_time_iso_8601": "2023-06-05T16:14:20.990936Z",
            "url": "https://files.pythonhosted.org/packages/d6/2f/4672d97e31606c7b96d8c6307aada2afeca8a443d393114f8b957a2f22b3/Mediana-sdk-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-05 16:14:20",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mediana-sdk"
}
        
Elapsed time: 0.10511s