Metadata-Version: 2.1
Name: whatsapp-python-sdk
Version: 1.0.0
Summary: Python client library for WhatsApp Cloud API
Home-page: https://apimatic.io
Author: APIMatic SDK Generator
Author-email: support@apimatic.io
License: UNKNOWN
Description: 
        # Getting Started with WhatsApp Cloud API
        
        ## Introduction
        
        Welcome to the WhatsApp API from Meta.
        
        Individual developers and existing Business Service Providers (BSPs) can now send and receive messages via the WhatsApp API using a cloud-hosted version of the WhatsApp Business API. Compared to the previous solutions, the cloud-based WhatsApp API is simpler to use and is a more cost-effective way for businesses to use WhatsApp. Please keep in mind the following configurations:
        
        | Name | Description |
        | --- | --- |
        | Version | Latest [Graph API version](https://developers.facebook.com/docs/graph-api/). For example: v13.0 |
        | User-Access-Token | Your user access token after signing up at [developers.facebook.com](https://developers.facebook.com). |
        | WABA-ID | Your WhatsApp Business Account (WABA) ID. |
        | Phone-Number-ID | ID for the phone number connected to the WhatsApp Business API. You can get this with a [Get Phone Number ID request](3184f675-d289-46f1-88e5-e2b11549c418). |
        | Business-ID | Your Business' ID. Once you have your Phone-Number-ID, make a [Get Business Profile request](#99fd3743-46cf-46c4-95b5-431c6a4eb0b0) to get your Business' ID. |
        | Recipient-Phone-Number | Phone number that you want to send a WhatsApp message to. |
        | Media-ID | ID for the media to [send a media message](#0a632754-3788-43bf-b785-ac6a73423d5a) or [media template message](#439c926a-8a6c-4972-ab2c-d99297716da9) to your customers. |
        | Media-URL | URL for the media to [download media content](#cbe5ece3-246c-48f3-b338-074187dfef66). |
        
        ## Install the Package
        
        The package is compatible with Python versions `3 >=3.7, <= 3.9`.
        Install the package from PyPi using the following pip command:
        
        ```python
        pip install whatsapp-python-sdk==1.0.0
        ```
        
        You can also view the package at:
        https://pypi.python.org/pypi/whatsapp-python-sdk
        
        ## Initialize the API Client
        
        **_Note:_** Documentation for the client can be found [here.](doc/client.md)
        
        The following parameters are configurable for the API Client:
        
        | Parameter | Type | Description |
        |  --- | --- | --- |
        | `version` | `string` | *Default*: `'v13.0'` |
        | `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |
        | `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |
        | `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
        | `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
        | `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |
        | `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
        | `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
        | `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
        | `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |
        | `access_token` | `string` | The OAuth 2.0 Access Token to use for API requests. |
        
        The API client can be initialized as follows:
        
        ```python
        from whatsappcloudapi.whatsappcloudapi_client import WhatsappcloudapiClient
        from whatsappcloudapi.configuration import Environment
        
        client = WhatsappcloudapiClient(
            access_token='AccessToken',
            environment=Environment.PRODUCTION,
            version = 'v13.0',)
        ```
        
        ## Authorization
        
        This API uses `OAuth 2 Bearer token`.
        
        ## List of APIs
        
        * [Business Profiles](doc/controllers/business-profiles.md)
        * [Phone Numbers](doc/controllers/phone-numbers.md)
        * [Two-Step Verification](doc/controllers/two-step-verification.md)
        * [Messages](doc/controllers/messages.md)
        * [Registration](doc/controllers/registration.md)
        * [Media](doc/controllers/media.md)
        
        ## Classes Documentation
        
        * [Utility Classes](doc/utility-classes.md)
        * [HttpResponse](doc/http-response.md)
        * [HttpRequest](doc/http-request.md)
        
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
