Skip to content

Latest commit

 

History

History
170 lines (121 loc) · 9.54 KB

README.md

File metadata and controls

170 lines (121 loc) · 9.54 KB
Raw

Companies

(crm.companies)

Available Operations

list

List Companies

Example Usage

from panora_sdk import Panora

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


res = s.crm.companies.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.ListCrmCompanyResponse

Errors

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

create

Create Companies in any supported CRM software

Example Usage

from panora_sdk import Panora

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


res = s.crm.companies.create(x_connection_token="<value>", unified_crm_company_input={
    "name": "Acme",
    "industry": "ACCOUNTING",
    "number_of_employees": 10,
    "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "email_addresses": [
        {
            "email_address": "[email protected]",
            "email_address_type": "WORK",
        },
    ],
    "addresses": [
        {
            "street_1": "5th Avenue",
            "street_2": "Street 2",
            "city": "New York",
            "state": "NY",
            "postal_code": "10001",
            "country": "USA",
            "address_type": "WORK",
            "owner_type": "<value>",
        },
    ],
    "phone_numbers": [
        {
            "phone_number": "+33660606067",
            "phone_type": "WORK",
        },
    ],
    "field_mappings": {
        "fav_dish": "broccoli",
        "fav_color": "red",
    },
}, remote_data=False)

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
unified_crm_company_input models.UnifiedCrmCompanyInput ✔️ N/A
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.UnifiedCrmCompanyOutput

Errors

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

retrieve

Retrieve Companies from any connected Crm software

Example Usage

from panora_sdk import Panora

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


res = s.crm.companies.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 company 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.UnifiedCrmCompanyOutput

Errors

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