dima-sdk 2.0.4

Deel REST API

dima-sdk

Deel REST API

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.25.0
• Package version: 2.0.4
• Generator version: 7.11.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

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

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:

import dima_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import dima_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import dima_sdk
from dima_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.letsdeel.com/rest/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = dima_sdk.Configuration(
    host = "https://api.letsdeel.com/rest/v2"
)

# 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 Bearer authorization (JWT): deelToken
configuration = dima_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with dima_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dima_sdk.PeopleApi(api_client)

    try:
        # Get my current personal profile
        api_response = api_instance.get_people()
        print("The response of PeopleApi->get_people:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PeopleApi->get_people: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.letsdeel.com/rest/v2

Class	Method	HTTP request	Description
PeopleApi	get_people	GET /people/me	Get my current personal profile
PeopleApi	get_people_list	GET /people	List of people

Documentation For Models

• ApiError
• ApiErrorContainer
• ApiErrorRequest
• GetPeople200Response
• GetPeopleList200Response
• GetPeopleList200ResponseDataInner
• GetPeopleList200ResponseDataInnerAddressesInner
• GetPeopleList200ResponseDataInnerDepartment
• GetPeopleList200ResponseDataInnerDirectManager
• GetPeopleList200ResponseDataInnerDirectReportsInner
• GetPeopleList200ResponseDataInnerEmailsInner
• GetPeopleList200ResponseDataInnerEmploymentsInner
• GetPeopleList200ResponseDataInnerEmploymentsInnerClientLegalEntity
• GetPeopleList200ResponseDataInnerEmploymentsInnerPayment
• GetPeopleList200ResponseDataInnerEmploymentsInnerTeam
• GetPeopleList200ResponsePage

Documentation For Authorization

Authentication schemes defined for the API:

deelToken

• Type: Bearer authentication (JWT)

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.deel.com/authorize
• Scopes:
• accounting:read: View payments and invoices in your organization.
• accounting:write: Create and edit payments and invoices.
• candidates:read: View candidates in your organization.
• candidates:write: Create, edit and delete candidates in your organization.
• contracts:read: View contracts in your organization.
• contracts:write: Create and amend contracts.
• people:write: Write worker’s information such as profile, time-off and expense.
• people:read: Read worker’s information such as profile, time-off and expenses.
• profile:read: Read Profile information such as name, email, phone
• Users:read: View information about people in Deel HR.
• webhooks:read: View webhooks in your organization.
• webhooks:write: Create and edit webhooks in your organization.
• global-payroll:read: View global payroll information about your employees.
• global-payroll:write: Write global payroll information about your employees.
• adjustments:write: Create / update adjustments of your employee.
• adjustments:read: View adjustments of your employee.
• invoice-adjustments:read: View invoices of your workforce.
• invoice-adjustments:write: Create, edit, review, and delete invoice adjustments.
• milestones:read: View milestones of your contractors.
• milestones:write: Create, edit, review, and delete milestones.
• organizations:read: View basic information about your organizations, teams, legal entities and agreements.
• organizations:write: Modify information in your organization. Create, edit, delete admin users or managers.
• off-cycle-payments:read: View your off-cycle payments.
• off-cycle-payments:write: Create, edit, review your off-cycle payments.
• timesheets:read: View work submitted for time-based contracts.
• timesheets:write: Create, edit, review, and delete timesheets.
• tasks:read: View your pay-as-you-go tasks.
• tasks:write: Create, edit, review and delete your pay-as-you-go tasks.
• payslips:read: View employee payslips.
• payslips:write: Create, edit, review and delete employee payslips.
• public-token:write: Create, edit, review and delete public tokens.
• profile:write: Write Profile information such as name, email, phone

public

• Type: OAuth
• Flow: accessCode
• Authorization URL:
• Scopes:
• contracts:read: View contracts in your organization.

Author

[e-mail]