python-zendesk 0.2.4
Python Client SDK Generated by Speakeasy.
Requires Python: >=3.9.2

# python-zendesk

Provided by botBrains. This SDK is generated for the [Zendesk Support API](https://developer.zendesk.com/api-reference/ticketing/introduction/) openapi spec (also known as Zendesk Ticketing API). We slightly modified it to comply with the OpenAPI spec and to work with the speakeasy codegen tool, as well as adding partial pagination support.

## How to regenerate the SDK

```bash
sh scripts/generate.sh
```

## How to generate the website mdx

```bash
curl https://<CRAWLER_URL>/crawl?urls[]=https://developer.zendesk.com/api-reference/ticketing/introduction/&limit=100&render_mode=no-js&include_globs[]=https://developer.zendesk.com/api-reference/ticketing/**&include_only_selectors[]=.documentContent__DocumentContent-sc-196ktpv-0
```

<!-- Start Summary [summary] -->
## Summary

Support API: Zendesk Support API endpoints
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [python-zendesk](#python-zendesk)
  * [How to regenerate the SDK](#how-to-regenerate-the-sdk)
  * [How to generate the website mdx](#how-to-generate-the-website-mdx)
  * [SDK Installation](#sdk-installation)
  * [IDE Support](#ide-support)
  * [SDK Example Usage](#sdk-example-usage)
  * [Authentication](#authentication)
  * [Available Resources and Operations](#available-resources-and-operations)
  * [Pagination](#pagination)
  * [Retries](#retries)
  * [Error Handling](#error-handling)
  * [Server Selection](#server-selection)
  * [Custom HTTP Client](#custom-http-client)
  * [Resource Management](#resource-management)
  * [Debugging](#debugging)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

> [!NOTE]
> **Python version upgrade policy**
>
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with *uv*, *pip*, or *poetry* package managers.

### uv

*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

```bash
uv add python-zendesk
```

### PIP

*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

```bash
pip install python-zendesk
```

### Poetry

*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.

```bash
poetry add python-zendesk
```

### Shell and script usage with `uv`

You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:

```shell
uvx --from python-zendesk python
```

It's also possible to write a standalone Python script without needing to set up a whole project like so:

```python
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "python-zendesk",
# ]
# ///

from zendesk import Zendesk

sdk = Zendesk(
  # SDK arguments
)

# Rest of script here...
```

Once that is saved to a file, you can run it with `uv run script.py` where
`script.py` can be replaced with the actual file name.
<!-- End SDK Installation [installation] -->

<!-- Start IDE Support [idesupport] -->
## IDE Support

### PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```python
# Synchronous Example
from zendesk import Zendesk, models


with Zendesk(
    security=models.Security(
        username="",
        password="",
    ),
) as z_client:

    res = z_client.assignee_field_assignable_groups.list_assignee_field_assignable_groups_and_agents_search(name="Johnny Agent")

    # Handle response
    print(res)
```

</br>

The same SDK client can also be used to make asynchronous requests by importing asyncio.

```python
# Asynchronous Example
import asyncio
from zendesk import Zendesk, models

async def main():

    async with Zendesk(
        security=models.Security(
            username="",
            password="",
        ),
    ) as z_client:

        res = await z_client.assignee_field_assignable_groups.list_assignee_field_assignable_groups_and_agents_search_async(name="Johnny Agent")

        # Handle response
        print(res)

asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name                      | Type | Scheme     | Environment Variable                      |
| ------------------------- | ---- | ---------- | ----------------------------------------- |
| `username`<br/>`password` | http | HTTP Basic | `ZENDESK_USERNAME`<br/>`ZENDESK_PASSWORD` |

You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
```python
from zendesk import Zendesk, models


with Zendesk(
    security=models.Security(
        username="",
        password="",
    ),
) as z_client:

    res = z_client.assignee_field_assignable_groups.list_assignee_field_assignable_groups_and_agents_search(name="Johnny Agent")

    # Handle response
    print(res)

```
<!-- End Authentication [security] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [AccountSettings](docs/sdks/accountsettings/README.md)

* [show_account_settings](docs/sdks/accountsettings/README.md#show_account_settings) - Show Settings
* [update_account_settings](docs/sdks/accountsettings/README.md#update_account_settings) - Update Account Settings

### [ActivityStream](docs/sdks/activitystream/README.md)

* [list_activities](docs/sdks/activitystream/README.md#list_activities) - List Activities
* [show_activity](docs/sdks/activitystream/README.md#show_activity) - Show Activity
* [count_activities](docs/sdks/activitystream/README.md#count_activities) - Count Activities

### [ApprovalRequests](docs/sdks/approvalrequests/README.md)

* [create_approval_request](docs/sdks/approvalrequests/README.md#create_approval_request) - Create an Approval Request
* [show_approval_request](docs/sdks/approvalrequests/README.md#show_approval_request) - Show Approval Request
* [update_decision_approval_request](docs/sdks/approvalrequests/README.md#update_decision_approval_request) - Update Approval Request Status
* [search_approvals](docs/sdks/approvalrequests/README.md#search_approvals) - Get Approvals by Approval Workflow Id

### [ApprovalWorkflowInstances](docs/sdks/approvalworkflowinstances/README.md)

* [create_approval_workflow_instance](docs/sdks/approvalworkflowinstances/README.md#create_approval_workflow_instance) - Create Approval Workflow Instance

### [AssigneeFieldAssignableAgents](docs/sdks/assigneefieldassignableagents/README.md)

* [list_assignee_field_assignable_groups_and_agents_search](docs/sdks/assigneefieldassignableagents/README.md#list_assignee_field_assignable_groups_and_agents_search) - List assignable groups and agents based on query matched against name
* [list_assignee_field_assignable_groups](docs/sdks/assigneefieldassignableagents/README.md#list_assignee_field_assignable_groups) - List assignable groups on the AssigneeField
* [list_assignee_field_assignable_group_agents](docs/sdks/assigneefieldassignableagents/README.md#list_assignee_field_assignable_group_agents) - List assignable agents from a group on the AssigneeField

### [AssigneeFieldAssignableGroups](docs/sdks/assigneefieldassignablegroups/README.md)

* [list_assignee_field_assignable_groups_and_agents_search](docs/sdks/assigneefieldassignablegroups/README.md#list_assignee_field_assignable_groups_and_agents_search) - List assignable groups and agents based on query matched against name

### [Attachments](docs/sdks/attachments/README.md)

* [show_attachment](docs/sdks/attachments/README.md#show_attachment) - Show Attachment
* [update_attachment](docs/sdks/attachments/README.md#update_attachment) - Update Attachment for Malware
* [redact_comment_attachment](docs/sdks/attachments/README.md#redact_comment_attachment) - Redact Comment Attachment
* [upload_files](docs/sdks/attachments/README.md#upload_files) - Upload Files
* [delete_upload](docs/sdks/attachments/README.md#delete_upload) - Delete Upload

### [AuditLogs](docs/sdks/auditlogs/README.md)

* [list_audit_logs](docs/sdks/auditlogs/README.md#list_audit_logs) - List Audit Logs
* [show_audit_log](docs/sdks/auditlogs/README.md#show_audit_log) - Show Audit Log
* [export_audit_logs](docs/sdks/auditlogs/README.md#export_audit_logs) - Export Audit Logs

### [Automations](docs/sdks/automations/README.md)

* [list_automations](docs/sdks/automations/README.md#list_automations) - List Automations
* [create_automation](docs/sdks/automations/README.md#create_automation) - Create Automation
* [show_automation](docs/sdks/automations/README.md#show_automation) - Show Automation
* [update_automation](docs/sdks/automations/README.md#update_automation) - Update Automation
* [delete_automation](docs/sdks/automations/README.md#delete_automation) - Delete Automation
* [list_active_automations](docs/sdks/automations/README.md#list_active_automations) - List Active Automations
* [bulk_delete_automations](docs/sdks/automations/README.md#bulk_delete_automations) - Bulk Delete Automations
* [search_automations](docs/sdks/automations/README.md#search_automations) - Search Automations
* [update_many_automations](docs/sdks/automations/README.md#update_many_automations) - Update Many Automations

### [Basics](docs/sdks/basics/README.md)

* [open_ticket_in_agent_browser](docs/sdks/basics/README.md#open_ticket_in_agent_browser) - Open Ticket in Agent's Browser
* [open_users_profile_in_agent_browser](docs/sdks/basics/README.md#open_users_profile_in_agent_browser) - Open a User's Profile in an Agent's Browser
* [create_ticket_or_voicemail_ticket](docs/sdks/basics/README.md#create_ticket_or_voicemail_ticket) - Create Ticket or Voicemail Ticket

### [Bookmarks](docs/sdks/bookmarks/README.md)

* [list_bookmarks](docs/sdks/bookmarks/README.md#list_bookmarks) - List Bookmarks
* [create_bookmark](docs/sdks/bookmarks/README.md#create_bookmark) - Create Bookmark
* [delete_bookmark](docs/sdks/bookmarks/README.md#delete_bookmark) - Delete Bookmark

### [BrandAgents](docs/sdks/brandagents/README.md)

* [list_brand_agents](docs/sdks/brandagents/README.md#list_brand_agents) - List Brand Agent Memberships
* [show_brand_agent_by_id](docs/sdks/brandagents/README.md#show_brand_agent_by_id) - Show Brand Agent Membership

### [Brands](docs/sdks/brands/README.md)

* [list_brands](docs/sdks/brands/README.md#list_brands) - List Brands
* [create_brand](docs/sdks/brands/README.md#create_brand) - Create Brand
* [show_brand](docs/sdks/brands/README.md#show_brand) - Show a Brand
* [update_brand](docs/sdks/brands/README.md#update_brand) - Update a Brand
* [delete_brand](docs/sdks/brands/README.md#delete_brand) - Delete a Brand
* [check_host_mapping_validity_for_existing_brand](docs/sdks/brands/README.md#check_host_mapping_validity_for_existing_brand) - Check Host Mapping Validity for an Existing Brand
* [check_host_mapping_validity](docs/sdks/brands/README.md#check_host_mapping_validity) - Check Host Mapping Validity

### [ChannelFramework](docs/sdks/channelframework/README.md)

* [report_channelback_error](docs/sdks/channelframework/README.md#report_channelback_error) - Report Channelback Error to Zendesk
* [push_content_to_support](docs/sdks/channelframework/README.md#push_content_to_support) - Push Content to Support
* [validate_token](docs/sdks/channelframework/README.md#validate_token) - Validate Token

### [ConversationLog](docs/sdks/conversationlog/README.md)

* [list_conversation_log_for_ticket](docs/sdks/conversationlog/README.md#list_conversation_log_for_ticket) - List Conversation log for Ticket

### [CustomObjectFields](docs/sdks/customobjectfields/README.md)

* [list_custom_object_fields](docs/sdks/customobjectfields/README.md#list_custom_object_fields) - List Custom Object Fields
* [create_custom_object_field](docs/sdks/customobjectfields/README.md#create_custom_object_field) - Create Custom Object Field
* [show_custom_object_field](docs/sdks/customobjectfields/README.md#show_custom_object_field) - Show Custom Object Field
* [update_custom_object_field](docs/sdks/customobjectfields/README.md#update_custom_object_field) - Update Custom Object Field
* [delete_custom_object_field](docs/sdks/customobjectfields/README.md#delete_custom_object_field) - Delete Custom Object Field
* [reorder_custom_object_fields](docs/sdks/customobjectfields/README.md#reorder_custom_object_fields) - Reorder Custom Fields of an Object
* [custom_object_fields_limit](docs/sdks/customobjectfields/README.md#custom_object_fields_limit) - Custom Object Fields Limit

### [CustomObjectRecords](docs/sdks/customobjectrecords/README.md)

* [custom_object_record_bulk_jobs](docs/sdks/customobjectrecords/README.md#custom_object_record_bulk_jobs) - Custom Object Record Bulk Jobs
* [list_custom_object_records](docs/sdks/customobjectrecords/README.md#list_custom_object_records) - List Custom Object Records
* [create_custom_object_record](docs/sdks/customobjectrecords/README.md#create_custom_object_record) - Create Custom Object Record
* [upsert_custom_object_record_by_external_id_or_name](docs/sdks/customobjectrecords/README.md#upsert_custom_object_record_by_external_id_or_name) - Set Custom Object Record by External Id Or Name
* [delete_custom_object_record_by_external_id_or_name](docs/sdks/customobjectrecords/README.md#delete_custom_object_record_by_external_id_or_name) - Delete Custom Object Record by External Id Or Name
* [show_custom_object_record](docs/sdks/customobjectrecords/README.md#show_custom_object_record) - Show Custom Object Record
* [update_custom_object_record](docs/sdks/customobjectrecords/README.md#update_custom_object_record) - Update Custom Object Record
* [delete_custom_object_record](docs/sdks/customobjectrecords/README.md#delete_custom_object_record) - Delete Custom Object Record
* [autocomplete_custom_object_record_search](docs/sdks/customobjectrecords/README.md#autocomplete_custom_object_record_search) - Autocomplete Custom Object Record Search
* [count_custom_object_records](docs/sdks/customobjectrecords/README.md#count_custom_object_records) - Count Custom Object Records
* [search_custom_object_records](docs/sdks/customobjectrecords/README.md#search_custom_object_records) - Search Custom Object Records
* [filtered_search_custom_object_records](docs/sdks/customobjectrecords/README.md#filtered_search_custom_object_records) - Filtered Search of Custom Object Records
* [custom_object_records_limit](docs/sdks/customobjectrecords/README.md#custom_object_records_limit) - Custom Object Records Limit

### [CustomObjects](docs/sdks/customobjects/README.md)

* [list_custom_objects](docs/sdks/customobjects/README.md#list_custom_objects) - List Custom Objects
* [create_custom_object](docs/sdks/customobjects/README.md#create_custom_object) - Create Custom Object
* [show_custom_object](docs/sdks/customobjects/README.md#show_custom_object) - Show Custom Object
* [update_custom_object](docs/sdks/customobjects/README.md#update_custom_object) - Update Custom Object
* [delete_custom_object](docs/sdks/customobjects/README.md#delete_custom_object) - Delete Custom Object
* [custom_objects_limit](docs/sdks/customobjects/README.md#custom_objects_limit) - Custom Objects Limit

### [CustomRoles](docs/sdks/customroles/README.md)

* [list_custom_roles](docs/sdks/customroles/README.md#list_custom_roles) - List Custom Roles
* [create_custom_role](docs/sdks/customroles/README.md#create_custom_role) - Create Custom Role
* [show_custom_role_by_id](docs/sdks/customroles/README.md#show_custom_role_by_id) - Show Custom Role
* [update_custom_role_by_id](docs/sdks/customroles/README.md#update_custom_role_by_id) - Update Custom Role
* [delete_custom_role_by_id](docs/sdks/customroles/README.md#delete_custom_role_by_id) - Delete Custom Role

### [CustomTicketStatuses](docs/sdks/customticketstatuses/README.md)

* [bulk_update_default_custom_status](docs/sdks/customticketstatuses/README.md#bulk_update_default_custom_status) - Bulk Update Default Custom Ticket Status
* [list_custom_statuses](docs/sdks/customticketstatuses/README.md#list_custom_statuses) - List Custom Ticket Statuses
* [create_custom_status](docs/sdks/customticketstatuses/README.md#create_custom_status) - Create Custom Ticket Status
* [show_custom_status](docs/sdks/customticketstatuses/README.md#show_custom_status) - Show Custom Ticket Status
* [update_custom_status](docs/sdks/customticketstatuses/README.md#update_custom_status) - Update Custom Ticket Status
* [create_ticket_form_statuses_for_custom_status](docs/sdks/customticketstatuses/README.md#create_ticket_form_statuses_for_custom_status) - Create Ticket Form Statuses for a Custom Status

### [DeletionSchedules](docs/sdks/deletionschedules/README.md)

* [list_deletion_schedules](docs/sdks/deletionschedules/README.md#list_deletion_schedules) - List Deletion Schedules
* [create_deletion_schedule](docs/sdks/deletionschedules/README.md#create_deletion_schedule) - Create Deletion Schedule
* [get_deletion_schedule](docs/sdks/deletionschedules/README.md#get_deletion_schedule) - Get Deletion Schedule
* [update_deletion_schedule](docs/sdks/deletionschedules/README.md#update_deletion_schedule) - Update Deletion Schedule
* [delete_deletion_schedule](docs/sdks/deletionschedules/README.md#delete_deletion_schedule) - Delete Deletion Schedule

### [DynamicContent](docs/sdks/dynamiccontent/README.md)

* [list_dynamic_contents](docs/sdks/dynamiccontent/README.md#list_dynamic_contents) - List Items
* [create_dynamic_content](docs/sdks/dynamiccontent/README.md#create_dynamic_content) - Create Item
* [show_dynamic_content_item](docs/sdks/dynamiccontent/README.md#show_dynamic_content_item) - Show Item
* [update_dynamic_content_item](docs/sdks/dynamiccontent/README.md#update_dynamic_content_item) - Update Item
* [delete_dynamic_content_item](docs/sdks/dynamiccontent/README.md#delete_dynamic_content_item) - Delete Item
* [show_many_dynamic_contents](docs/sdks/dynamiccontent/README.md#show_many_dynamic_contents) - Show Many Items

### [DynamicContentItemVariants](docs/sdks/dynamiccontentitemvariants/README.md)

* [dynamic_content_list_variants](docs/sdks/dynamiccontentitemvariants/README.md#dynamic_content_list_variants) - List Variants
* [create_dynamic_content_variant](docs/sdks/dynamiccontentitemvariants/README.md#create_dynamic_content_variant) - Create Variant
* [show_dynamic_content_variant](docs/sdks/dynamiccontentitemvariants/README.md#show_dynamic_content_variant) - Show Variant
* [update_dynamic_content_variant](docs/sdks/dynamiccontentitemvariants/README.md#update_dynamic_content_variant) - Update Variant
* [delete_dynamic_content_variant](docs/sdks/dynamiccontentitemvariants/README.md#delete_dynamic_content_variant) - Delete Variant
* [create_many_dynamic_content_variants](docs/sdks/dynamiccontentitemvariants/README.md#create_many_dynamic_content_variants) - Create Many Variants
* [update_many_dynamic_content_variants](docs/sdks/dynamiccontentitemvariants/README.md#update_many_dynamic_content_variants) - Update Many Variants

### [EmailNotifications](docs/sdks/emailnotifications/README.md)

* [list_email_notifications](docs/sdks/emailnotifications/README.md#list_email_notifications) - List Email Notifications
* [show_email_notification](docs/sdks/emailnotifications/README.md#show_email_notification) - Show Email Notification
* [show_many_email_notifications](docs/sdks/emailnotifications/README.md#show_many_email_notifications) - Show Many Email Notifications

### [EssentialsCard](docs/sdks/essentialscard/README.md)

* [show_essentials_card](docs/sdks/essentialscard/README.md#show_essentials_card) - Show Essentials Card
* [update_essentials_card](docs/sdks/essentialscard/README.md#update_essentials_card) - Update Essentials Card
* [delete_essentials_card](docs/sdks/essentialscard/README.md#delete_essentials_card) - Delete Essentials Card
* [show_essentials_cards](docs/sdks/essentialscard/README.md#show_essentials_cards) - List of Essentials Cards

### [GlobalClients](docs/sdks/globalclients/README.md)

* [list_global_o_auth_clients](docs/sdks/globalclients/README.md#list_global_o_auth_clients) - List Global OAuth Clients

### [GrantTypeTokens](docs/sdks/granttypetokens/README.md)

* [create_token_for_grant_type](docs/sdks/granttypetokens/README.md#create_token_for_grant_type) - Create Token for Grant Type

### [GroupMemberships](docs/sdks/groupmemberships/README.md)

* [list_group_memberships](docs/sdks/groupmemberships/README.md#list_group_memberships) - List Memberships
* [create_group_membership](docs/sdks/groupmemberships/README.md#create_group_membership) - Create Membership
* [show_group_membership_by_id](docs/sdks/groupmemberships/README.md#show_group_membership_by_id) - Show Membership
* [delete_group_membership](docs/sdks/groupmemberships/README.md#delete_group_membership) - Delete Membership
* [list_assignable_group_memberships](docs/sdks/groupmemberships/README.md#list_assignable_group_memberships) - List Assignable Memberships
* [group_membership_bulk_create](docs/sdks/groupmemberships/README.md#group_membership_bulk_create) - Bulk Create Memberships
* [group_membership_bulk_delete](docs/sdks/groupmemberships/README.md#group_membership_bulk_delete) - Bulk Delete Memberships
* [group_membership_set_default](docs/sdks/groupmemberships/README.md#group_membership_set_default) - Set Membership as Default

### [GroupSLAPolicies](docs/sdks/groupslapolicies/README.md)

* [list_group_sla_policies](docs/sdks/groupslapolicies/README.md#list_group_sla_policies) - List Group SLA Policies
* [create_group_sla_policy](docs/sdks/groupslapolicies/README.md#create_group_sla_policy) - Create Group SLA Policy
* [show_group_sla_policy](docs/sdks/groupslapolicies/README.md#show_group_sla_policy) - Show Group SLA Policy
* [update_group_sla_policy](docs/sdks/groupslapolicies/README.md#update_group_sla_policy) - Update Group SLA Policy
* [delete_group_sla_policy](docs/sdks/groupslapolicies/README.md#delete_group_sla_policy) - Delete Group SLA Policy
* [retrieve_group_sla_policy_filter_definition_items](docs/sdks/groupslapolicies/README.md#retrieve_group_sla_policy_filter_definition_items) - Retrieve Supported Filter Definition Items
* [reorder_group_sla_policies](docs/sdks/groupslapolicies/README.md#reorder_group_sla_policies) - Reorder Group SLA Policies

### [Groups](docs/sdks/groups/README.md)

* [list_groups](docs/sdks/groups/README.md#list_groups) - List Groups
* [create_group](docs/sdks/groups/README.md#create_group) - Create Group
* [show_group_by_id](docs/sdks/groups/README.md#show_group_by_id) - Show Group
* [update_group](docs/sdks/groups/README.md#update_group) - Update Group
* [delete_group](docs/sdks/groups/README.md#delete_group) - Delete Group
* [list_assignable_groups](docs/sdks/groups/README.md#list_assignable_groups) - List Assignable Groups
* [count_groups](docs/sdks/groups/README.md#count_groups) - Count Groups

### [IncrementalExport](docs/sdks/incrementalexport/README.md)

* [incremental_sample_export](docs/sdks/incrementalexport/README.md#incremental_sample_export) - Incremental Sample Export
* [incremental_organization_export](docs/sdks/incrementalexport/README.md#incremental_organization_export) - Incremental Organization Export
* [incremental_ticket_events](docs/sdks/incrementalexport/README.md#incremental_ticket_events) - Incremental Ticket Event Export
* [incremental_ticket_export_time](docs/sdks/incrementalexport/README.md#incremental_ticket_export_time) - Incremental Ticket Export, Time Based
* [incremental_ticket_export_cursor](docs/sdks/incrementalexport/README.md#incremental_ticket_export_cursor) - Incremental Ticket Export, Cursor Based
* [incremental_user_export_time](docs/sdks/incrementalexport/README.md#incremental_user_export_time) - Incremental User Export, Time Based
* [incremental_user_export_cursor](docs/sdks/incrementalexport/README.md#incremental_user_export_cursor) - Incremental User Export, Cursor Based

### [IncrementalSkillBasedRouting](docs/sdks/incrementalskillbasedroutingsdk/README.md)

* [incremental_skil_based_routing_attribute_values_export](docs/sdks/incrementalskillbasedroutingsdk/README.md#incremental_skil_based_routing_attribute_values_export) - Incremental Attributes Values Export
* [incremental_skil_based_routing_attributes_export](docs/sdks/incrementalskillbasedroutingsdk/README.md#incremental_skil_based_routing_attributes_export) - Incremental Attributes Export
* [incremental_skil_based_routing_instance_values_export](docs/sdks/incrementalskillbasedroutingsdk/README.md#incremental_skil_based_routing_instance_values_export) - Incremental Instance Values Export

### [JobStatuses](docs/sdks/jobstatuses/README.md)

* [list_job_statuses](docs/sdks/jobstatuses/README.md#list_job_statuses) - List Job Statuses
* [show_job_status](docs/sdks/jobstatuses/README.md#show_job_status) - Show Job Status
* [show_many_job_statuses](docs/sdks/jobstatuses/README.md#show_many_job_statuses) - Show Many Job Statuses
* [bulk_set_agent_attribute_values_job](docs/sdks/jobstatuses/README.md#bulk_set_agent_attribute_values_job) - Bulk Set Agent Attribute Values Job

### [Locales](docs/sdks/locales/README.md)

* [list_locales](docs/sdks/locales/README.md#list_locales) - List Locales
* [show_locale_by_id](docs/sdks/locales/README.md#show_locale_by_id) - Show Locale
* [list_locales_for_agent](docs/sdks/locales/README.md#list_locales_for_agent) - List Locales for Agent
* [show_current_locale](docs/sdks/locales/README.md#show_current_locale) - Show Current Locale
* [detect_best_locale](docs/sdks/locales/README.md#detect_best_locale) - Detect Best Language for User
* [list_available_public_locales](docs/sdks/locales/README.md#list_available_public_locales) - List Available Public Locales

### [LookupRelationships](docs/sdks/lookuprelationships/README.md)

* [get_sources_by_target](docs/sdks/lookuprelationships/README.md#get_sources_by_target) - Get sources by target
* [get_relationship_filter_definitions](docs/sdks/lookuprelationships/README.md#get_relationship_filter_definitions) - Filter Definitions

### [Macros](docs/sdks/macros/README.md)

* [list_macros](docs/sdks/macros/README.md#list_macros) - List Macros
* [create_macro](docs/sdks/macros/README.md#create_macro) - Create Macro
* [show_macro](docs/sdks/macros/README.md#show_macro) - Show Macro
* [update_macro](docs/sdks/macros/README.md#update_macro) - Update Macro
* [delete_macro](docs/sdks/macros/README.md#delete_macro) - Delete Macro
* [show_changes_to_ticket](docs/sdks/macros/README.md#show_changes_to_ticket) - Show Changes to Ticket
* [list_macro_attachments](docs/sdks/macros/README.md#list_macro_attachments) - List Macro Attachments
* [create_associated_macro_attachment](docs/sdks/macros/README.md#create_associated_macro_attachment) - Create Macro Attachment
* [list_macros_actions](docs/sdks/macros/README.md#list_macros_actions) - List Supported Actions for Macros
* [list_active_macros](docs/sdks/macros/README.md#list_active_macros) - List Active Macros
* [create_macro_attachment](docs/sdks/macros/README.md#create_macro_attachment) - Create Unassociated Macro Attachment
* [show_macro_attachment](docs/sdks/macros/README.md#show_macro_attachment) - Show Macro Attachment
* [list_macro_categories](docs/sdks/macros/README.md#list_macro_categories) - List Macro Categories
* [list_macro_action_definitions](docs/sdks/macros/README.md#list_macro_action_definitions) - List Macro Action Definitions
* [delete_many_macros](docs/sdks/macros/README.md#delete_many_macros) - Bulk Delete Macros
* [show_derived_macro](docs/sdks/macros/README.md#show_derived_macro) - Show Macro Replica
* [search_macro](docs/sdks/macros/README.md#search_macro) - Search Macros
* [update_many_macros](docs/sdks/macros/README.md#update_many_macros) - Update Many Macros
* [show_ticket_after_changes](docs/sdks/macros/README.md#show_ticket_after_changes) - Show Ticket After Changes

### [OAuthClients](docs/sdks/oauthclients/README.md)

* [list_o_auth_clients](docs/sdks/oauthclients/README.md#list_o_auth_clients) - List Clients
* [create_o_auth_client](docs/sdks/oauthclients/README.md#create_o_auth_client) - Create Client
* [show_client](docs/sdks/oauthclients/README.md#show_client) - Show Client
* [update_client](docs/sdks/oauthclients/README.md#update_client) - Update Client
* [delete_client](docs/sdks/oauthclients/README.md#delete_client) - Delete Client
* [client_generate_secret](docs/sdks/oauthclients/README.md#client_generate_secret) - Generate Secret

### [OAuthTokens](docs/sdks/oauthtokens/README.md)

* [list_o_auth_tokens](docs/sdks/oauthtokens/README.md#list_o_auth_tokens) - List Tokens
* [create_o_auth_token](docs/sdks/oauthtokens/README.md#create_o_auth_token) - Create Token
* [show_token](docs/sdks/oauthtokens/README.md#show_token) - Show Token
* [revoke_o_auth_token](docs/sdks/oauthtokens/README.md#revoke_o_auth_token) - Revoke Token

### [ObjectTriggers](docs/sdks/objecttriggers/README.md)

* [list_object_triggers](docs/sdks/objecttriggers/README.md#list_object_triggers) - List Object Triggers
* [create_object_trigger](docs/sdks/objecttriggers/README.md#create_object_trigger) - Create Object Trigger
* [get_object_trigger](docs/sdks/objecttriggers/README.md#get_object_trigger) - Show Object Trigger
* [update_object_trigger](docs/sdks/objecttriggers/README.md#update_object_trigger) - Update Object Trigger
* [delete_object_trigger](docs/sdks/objecttriggers/README.md#delete_object_trigger) - Delete Object Trigger
* [list_active_object_triggers](docs/sdks/objecttriggers/README.md#list_active_object_triggers) - List Active Object Triggers
* [list_object_triggers_definitions](docs/sdks/objecttriggers/README.md#list_object_triggers_definitions) - List Object Trigger Action and Condition Definitions
* [delete_many_object_triggers](docs/sdks/objecttriggers/README.md#delete_many_object_triggers) - Delete Many Object Triggers
* [search_object_triggers](docs/sdks/objecttriggers/README.md#search_object_triggers) - Search Object Triggers
* [update_many_object_triggers](docs/sdks/objecttriggers/README.md#update_many_object_triggers) - Update Many Object Triggers

### [OmnichannelRoutingQueues](docs/sdks/omnichannelroutingqueues/README.md)

* [list_queues](docs/sdks/omnichannelroutingqueues/README.md#list_queues) - List queues
* [create_queue](docs/sdks/omnichannelroutingqueues/README.md#create_queue) - Create Queue
* [show_queue_by_id](docs/sdks/omnichannelroutingqueues/README.md#show_queue_by_id) - Show Queue
* [update_queue](docs/sdks/omnichannelroutingqueues/README.md#update_queue) - Update Queue
* [delete_queue](docs/sdks/omnichannelroutingqueues/README.md#delete_queue) - Delete Queue
* [list_queue_definitions](docs/sdks/omnichannelroutingqueues/README.md#list_queue_definitions) - List Queue Definitions
* [reorder_queues](docs/sdks/omnichannelroutingqueues/README.md#reorder_queues) - Reorder Queues

### [OrganizationFields](docs/sdks/organizationfieldssdk/README.md)

* [list_organization_fields](docs/sdks/organizationfieldssdk/README.md#list_organization_fields) - List Organization Fields
* [create_organization_field](docs/sdks/organizationfieldssdk/README.md#create_organization_field) - Create Organization Field
* [reorder_organization_field](docs/sdks/organizationfieldssdk/README.md#reorder_organization_field) - Reorder Organization Field

### [OrganizationMemberships](docs/sdks/organizationmemberships/README.md)

* [list_organization_memberships](docs/sdks/organizationmemberships/README.md#list_organization_memberships) - List Memberships
* [create_organization_membership](docs/sdks/organizationmemberships/README.md#create_organization_membership) - Create Membership
* [show_organization_membership_by_id](docs/sdks/organizationmemberships/README.md#show_organization_membership_by_id) - Show Membership
* [delete_organization_membership](docs/sdks/organizationmemberships/README.md#delete_organization_membership) - Delete Membership
* [create_many_organization_memberships](docs/sdks/organizationmemberships/README.md#create_many_organization_memberships) - Create Many Memberships
* [delete_many_organization_memberships](docs/sdks/organizationmemberships/README.md#delete_many_organization_memberships) - Bulk Delete Memberships
* [set_organization_membership_as_default](docs/sdks/organizationmemberships/README.md#set_organization_membership_as_default) - Set Membership as Default
* [unassign_organization](docs/sdks/organizationmemberships/README.md#unassign_organization) - Unassign Organization
* [set_organization_as_default](docs/sdks/organizationmemberships/README.md#set_organization_as_default) - Set Organization as Default

### [OrganizationSubscriptions](docs/sdks/organizationsubscriptions/README.md)

* [list_organization_subscriptions](docs/sdks/organizationsubscriptions/README.md#list_organization_subscriptions) - List Organization Subscriptions
* [create_organization_subscription](docs/sdks/organizationsubscriptions/README.md#create_organization_subscription) - Create Organization Subscription
* [show_organization_subscription](docs/sdks/organizationsubscriptions/README.md#show_organization_subscription) - Show Organization Subscription
* [delete_organization_subscription](docs/sdks/organizationsubscriptions/README.md#delete_organization_subscription) - Delete Organization Subscription

### [Organizations](docs/sdks/organizations/README.md)

* [show_organization_merge](docs/sdks/organizations/README.md#show_organization_merge) - Show Organization Merge
* [list_organizations](docs/sdks/organizations/README.md#list_organizations) - List Organizations
* [create_organization](docs/sdks/organizations/README.md#create_organization) - Create Organization
* [show_organization](docs/sdks/organizations/README.md#show_organization) - Show Organization
* [update_organization](docs/sdks/organizations/README.md#update_organization) - Update Organization
* [delete_organization](docs/sdks/organizations/README.md#delete_organization) - Delete Organization
* [create_organization_merge](docs/sdks/organizations/README.md#create_organization_merge) - Merge Organization With Another Organization
* [list_organization_merges](docs/sdks/organizations/README.md#list_organization_merges) - List Organization Merges
* [organization_related](docs/sdks/organizations/README.md#organization_related) - Show Organization's Related Information
* [autocomplete_organizations](docs/sdks/organizations/README.md#autocomplete_organizations) - Autocomplete Organizations
* [count_organizations](docs/sdks/organizations/README.md#count_organizations) - Count Organizations
* [create_many_organizations](docs/sdks/organizations/README.md#create_many_organizations) - Create Many Organizations
* [create_or_update_organization](docs/sdks/organizations/README.md#create_or_update_organization) - Create Or Update Organization
* [delete_many_organizations](docs/sdks/organizations/README.md#delete_many_organizations) - Bulk Delete Organizations
* [search_organizations](docs/sdks/organizations/README.md#search_organizations) - Search Organizations
* [show_many_organizations](docs/sdks/organizations/README.md#show_many_organizations) - Show Many Organizations
* [update_many_organizations](docs/sdks/organizations/README.md#update_many_organizations) - Update Many Organizations

### [PushNotificationDevices](docs/sdks/pushnotificationdevices/README.md)

* [push_notification_devices](docs/sdks/pushnotificationdevices/README.md#push_notification_devices) - Bulk Unregister Push Notification Devices

### [Requests](docs/sdks/requests/README.md)

* [list_requests](docs/sdks/requests/README.md#list_requests) - List Requests
* [create_request](docs/sdks/requests/README.md#create_request) - Create Request
* [show_request](docs/sdks/requests/README.md#show_request) - Show Request
* [update_request](docs/sdks/requests/README.md#update_request) - Update Request
* [list_comments](docs/sdks/requests/README.md#list_comments) - Listing Comments
* [show_comment](docs/sdks/requests/README.md#show_comment) - Getting Comments
* [search_requests](docs/sdks/requests/README.md#search_requests) - Search Requests

### [Reseller](docs/sdks/reseller/README.md)

* [create_trial_account](docs/sdks/reseller/README.md#create_trial_account) - Create Trial Account
* [verify_subdomain_availability](docs/sdks/reseller/README.md#verify_subdomain_availability) - Verify Subdomain Availability

### [ResourceCollections](docs/sdks/resourcecollections/README.md)

* [list_resource_collections](docs/sdks/resourcecollections/README.md#list_resource_collections) - List Resource Collections
* [create_resource_collection](docs/sdks/resourcecollections/README.md#create_resource_collection) - Create Resource Collection
* [retrieve_resource_collection](docs/sdks/resourcecollections/README.md#retrieve_resource_collection) - Show Resource Collection
* [update_resource_collection](docs/sdks/resourcecollections/README.md#update_resource_collection) - Update Resource Collection
* [delete_resource_collection](docs/sdks/resourcecollections/README.md#delete_resource_collection) - Delete Resource Collection

### [SatisfactionRatings](docs/sdks/satisfactionratings/README.md)

* [list_satisfaction_ratings](docs/sdks/satisfactionratings/README.md#list_satisfaction_ratings) - List Satisfaction Ratings
* [show_satisfaction_rating](docs/sdks/satisfactionratings/README.md#show_satisfaction_rating) - Show Satisfaction Rating
* [count_satisfaction_ratings](docs/sdks/satisfactionratings/README.md#count_satisfaction_ratings) - Count Satisfaction Ratings
* [create_ticket_satisfaction_rating](docs/sdks/satisfactionratings/README.md#create_ticket_satisfaction_rating) - Create a Satisfaction Rating

### [SatisfactionReasons](docs/sdks/satisfactionreasons/README.md)

* [list_satisfaction_rating_reasons](docs/sdks/satisfactionreasons/README.md#list_satisfaction_rating_reasons) - List Reasons for Satisfaction Rating
* [show_satisfaction_ratings](docs/sdks/satisfactionreasons/README.md#show_satisfaction_ratings) - Show Reason for Satisfaction Rating

### [Search](docs/sdks/search/README.md)

* [list_search_results](docs/sdks/search/README.md#list_search_results) - List Search Results
* [count_search_results](docs/sdks/search/README.md#count_search_results) - Show Results Count
* [export_search_results](docs/sdks/search/README.md#export_search_results) - Export Search Results

### [Sessions](docs/sdks/sessions/README.md)

* [list_sessions](docs/sdks/sessions/README.md#list_sessions) - List Sessions
* [bulk_delete_sessions_by_user_id](docs/sdks/sessions/README.md#bulk_delete_sessions_by_user_id) - Bulk Delete Sessions
* [show_session](docs/sdks/sessions/README.md#show_session) - Show Session
* [delete_session](docs/sdks/sessions/README.md#delete_session) - Delete Session
* [delete_authenticated_session](docs/sdks/sessions/README.md#delete_authenticated_session) - Delete the Authenticated Session
* [show_currently_authenticated_session](docs/sdks/sessions/README.md#show_currently_authenticated_session) - Show the Currently Authenticated Session
* [renew_current_session](docs/sdks/sessions/README.md#renew_current_session) - Rene