Skip to content

Latest commit

 

History

History
148 lines (99 loc) · 8.5 KB

README.md

File metadata and controls

148 lines (99 loc) · 8.5 KB
Raw

Deals

(crm.deals)

Available Operations

list

List Deals

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.crm.deals.list(x_connection_token="<value>", remote_data=True, limit=10, cursor="1b8b05bb-5273-4012-b520-8657b0b90874")

if res is not None:
    while True:
        # handle items

        res = res.Next()
        if res is None:
            break

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
remote_data Optional[bool] ➖ Set to true to include data from the original software. true
limit Optional[float] ➖ Set to get the number of records. 10
cursor Optional[str] ➖ Set to get the number of records after this cursor. 1b8b05bb-5273-4012-b520-8657b0b90874
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListCrmDealsResponse

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

create

Create Deals in any supported Crm software

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.crm.deals.create(x_connection_token="<value>", unified_crm_deal_input={
    "name": "Huge Contract with Acme",
    "description": "Contract with Sales Operations Team",
    "amount": 1000,
    "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "stage_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "field_mappings": {
        "fav_dish": "broccoli",
        "fav_color": "red",
    },
})

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
x_connection_token str ✔️ The connection token
unified_crm_deal_input models.UnifiedCrmDealInput ✔️ N/A
remote_data Optional[bool] ➖ Set to true to include data from the original Crm software.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UnifiedCrmDealOutput

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

retrieve

Retrieve Deals from any connected Crm software

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.crm.deals.retrieve(x_connection_token="<value>", id="801f9ede-c698-4e66-a7fc-48d19eebaa4f", remote_data=False)

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
id str ✔️ id of the deal you want to retrieve. 801f9ede-c698-4e66-a7fc-48d19eebaa4f
remote_data Optional[bool] ➖ Set to true to include data from the original Crm software. false
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UnifiedCrmDealOutput

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /