Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .mock/definition/chat/__package__.yml
Original file line number Diff line number Diff line change
Expand Up @@ -660,6 +660,12 @@ types:
* `PUBLIC_INTERNAL` - PUBLIC_INTERNAL
* `PUBLIC_EXTERNAL` - PUBLIC_EXTERNAL
members: optional<list<optional<string>>>
remote_created_at:
type: optional<datetime>
docs: When the third party's conversation was created.
remote_updated_at:
type: optional<datetime>
docs: When the third party's conversation was updated.
remote_was_deleted:
type: optional<boolean>
docs: >-
Expand Down Expand Up @@ -1060,6 +1066,12 @@ types:
docs: The name of the Group
validation:
maxLength: 254
remote_created_at:
type: optional<datetime>
docs: When the third party's group was created.
remote_updated_at:
type: optional<datetime>
docs: When the third party's group was updated.
remote_was_deleted:
type: optional<boolean>
docs: >-
Expand Down Expand Up @@ -1216,6 +1228,12 @@ types:
member is a group.
validation:
format: uuid
remote_created_at:
type: optional<datetime>
docs: When the third party's conversation was created.
remote_updated_at:
type: optional<datetime>
docs: When the third party's conversation was updated.
remote_was_deleted:
type: optional<boolean>
docs: >-
Expand Down Expand Up @@ -1290,6 +1308,12 @@ types:
validation:
format: uri
maxLength: 500
remote_created_at:
type: optional<datetime>
docs: When the third party's conversation was created.
remote_updated_at:
type: optional<datetime>
docs: When the third party's conversation was updated.
remote_was_deleted:
type: optional<boolean>
docs: >-
Expand All @@ -1298,6 +1322,7 @@ types:
Native deletion detection is offered for free with limited coverage.
[Learn
more](https://docs.merge.dev/integrations/hris/supported-features/).
access: read-only
source:
openapi: openapi/openapi.yml
MethodEnum:
Expand Down Expand Up @@ -1757,6 +1782,12 @@ types:
validation:
format: uri
maxLength: 2000
remote_created_at:
type: optional<datetime>
docs: When the third party's user was created.
remote_updated_at:
type: optional<datetime>
docs: When the third party's user was updated.
remote_was_deleted:
type: optional<boolean>
docs: >-
Expand Down
6 changes: 6 additions & 0 deletions .mock/definition/chat/conversations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ service:
type: PRIVATE_INTERNAL
members:
- null
remote_created_at: '2021-09-15T00:00:00Z'
remote_updated_at: '2021-09-16T00:00:00Z'
remote_was_deleted: true
field_mappings:
organization_defined_targets:
Expand Down Expand Up @@ -178,6 +180,8 @@ service:
modified_at: '2021-10-16T00:00:00Z'
user: a1234567-89ab-cdef-0123-456789abcdef
group: group
remote_created_at: '2021-09-15T00:00:00Z'
remote_updated_at: '2021-09-16T00:00:00Z'
remote_was_deleted: true
field_mappings:
organization_defined_targets:
Expand Down Expand Up @@ -241,6 +245,8 @@ service:
type: PRIVATE_INTERNAL
members:
- members
remote_created_at: '2021-09-15T00:00:00Z'
remote_updated_at: '2021-09-16T00:00:00Z'
remote_was_deleted: true
field_mappings:
organization_defined_targets:
Expand Down
4 changes: 4 additions & 0 deletions .mock/definition/chat/groups.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ service:
created_at: '2021-09-15T00:00:00Z'
modified_at: '2021-10-16T00:00:00Z'
name: Engineering
remote_created_at: '2021-09-15T00:00:00Z'
remote_updated_at: '2021-09-16T00:00:00Z'
remote_was_deleted: true
field_mappings:
organization_defined_targets:
Expand Down Expand Up @@ -140,6 +142,8 @@ service:
created_at: '2021-09-15T00:00:00Z'
modified_at: '2021-10-16T00:00:00Z'
name: Engineering
remote_created_at: '2021-09-15T00:00:00Z'
remote_updated_at: '2021-09-16T00:00:00Z'
remote_was_deleted: true
field_mappings:
organization_defined_targets:
Expand Down
41 changes: 41 additions & 0 deletions .mock/definition/chat/messages.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
types:
MessagesListRequestOrderBy:
enum:
- value: '-remote_created_at'
name: RemoteCreatedAtDescending
- value: remote_created_at
name: RemoteCreatedAtAscending
source:
openapi: openapi/openapi.yml
MessagesRepliesListRequestOrderBy:
enum:
- value: '-remote_created_at'
name: RemoteCreatedAtDescending
- value: remote_created_at
name: RemoteCreatedAtAscending
source:
openapi: openapi/openapi.yml
imports:
root: __package__.yml
service:
Expand Down Expand Up @@ -54,12 +71,22 @@ service:
docs: >-
If provided, only objects synced by Merge before this date time
will be returned.
order_by:
type: optional<MessagesListRequestOrderBy>
docs: >-
Overrides the default ordering for this endpoint. Possible values
include: remote_created_at, -remote_created_at.
page_size:
type: optional<integer>
docs: Number of results to return per page. The maximum limit is 100.
remote_id:
type: optional<string>
docs: The API provider's ID for the given object.
root_message:
type: optional<string>
docs: >-
If provided as 'true', will only return root messages (messages
without a parent message).
response:
docs: ''
type: root.PaginatedMessageList
Expand All @@ -74,8 +101,10 @@ service:
include_shell_data: true
modified_after: '2024-01-15T09:30:00Z'
modified_before: '2024-01-15T09:30:00Z'
order_by: '-remote_created_at'
page_size: 1
remote_id: remote_id
root_message: root_message
headers:
X-Account-Token: X-Account-Token
response:
Expand All @@ -93,6 +122,8 @@ service:
subject_line: Hello World
root_message_id: a1234567-89ab-cdef-0123-456789abcdef
url: https://example.com/messages/mem-001
remote_created_at: '2021-09-15T00:00:00Z'
remote_updated_at: '2021-09-16T00:00:00Z'
remote_was_deleted: true
retrieve:
path: /chat/v1/messages/{id}
Expand Down Expand Up @@ -141,6 +172,8 @@ service:
subject_line: Hello World
root_message_id: a1234567-89ab-cdef-0123-456789abcdef
url: https://example.com/messages/mem-001
remote_created_at: '2021-09-15T00:00:00Z'
remote_updated_at: '2021-09-16T00:00:00Z'
remote_was_deleted: true
repliesList:
path: /chat/v1/messages/{message_id}/replies
Expand Down Expand Up @@ -176,6 +209,11 @@ service:
docs: >-
Whether to include shell records. Shell records are empty records
(they may contain some metadata but all other fields are null).
order_by:
type: optional<MessagesRepliesListRequestOrderBy>
docs: >-
Overrides the default ordering for this endpoint. Possible values
include: remote_created_at, -remote_created_at.
page_size:
type: optional<integer>
docs: Number of results to return per page. The maximum limit is 100.
Expand All @@ -191,6 +229,7 @@ service:
include_deleted_data: true
include_remote_data: true
include_shell_data: true
order_by: '-remote_created_at'
page_size: 1
headers:
X-Account-Token: X-Account-Token
Expand All @@ -209,6 +248,8 @@ service:
subject_line: Hello World
root_message_id: a1234567-89ab-cdef-0123-456789abcdef
url: https://example.com/messages/mem-001
remote_created_at: '2021-09-15T00:00:00Z'
remote_updated_at: '2021-09-16T00:00:00Z'
remote_was_deleted: true
source:
openapi: openapi/openapi.yml
4 changes: 4 additions & 0 deletions .mock/definition/chat/users.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ service:
groups:
- groups
avatar: https://merge.dev/user_profile_pic.png
remote_created_at: '2021-09-15T00:00:00Z'
remote_updated_at: '2021-09-16T00:00:00Z'
remote_was_deleted: true
field_mappings:
organization_defined_targets:
Expand Down Expand Up @@ -166,6 +168,8 @@ service:
groups:
- groups
avatar: https://merge.dev/user_profile_pic.png
remote_created_at: '2021-09-15T00:00:00Z'
remote_updated_at: '2021-09-16T00:00:00Z'
remote_was_deleted: true
field_mappings:
organization_defined_targets:
Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,25 @@

The Merge Python library provides convenient access to the Merge APIs from Python.

## Table of Contents

- [Documentation](#documentation)
- [Installation](#installation)
- [Reference](#reference)
- [Usage](#usage)
- [Instantiation](#instantiation)
- [Categories](#categories)
- [Async Client](#async-client)
- [Exception Handling](#exception-handling)
- [Advanced](#advanced)
- [Access Raw Response Data](#access-raw-response-data)
- [Retries](#retries)
- [Timeouts](#timeouts)
- [Custom Client](#custom-client)
- [Contributing](#contributing)
- [File Download](#file-download)
- [Pagination](#pagination)

## Documentation

API reference documentation is available [here](https://docs.merge.dev/).
Expand Down Expand Up @@ -240,3 +259,4 @@ while response.next is not None:




6 changes: 3 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "MergePythonClient"

[tool.poetry]
name = "MergePythonClient"
version = "2.5.0"
version = "2.6.0"
description = ""
readme = "README.md"
authors = []
Expand Down
Loading