Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
2,225 changes: 2,225 additions & 0 deletions .mock/definition/knowledgebase/__package__.yml

Large diffs are not rendered by default.

37 changes: 37 additions & 0 deletions .mock/definition/knowledgebase/accountDetails.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
imports:
root: __package__.yml
service:
auth: false
base-path: ''
endpoints:
retrieve:
path: /knowledgebase/v1/account-details
method: GET
auth: true
docs: Get details for a linked account.
source:
openapi: openapi/openapi.yml
response:
docs: ''
type: root.AccountDetails
status-code: 200
examples:
- headers:
X-Account-Token: X-Account-Token
response:
body:
id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd
integration: BambooHR
integration_slug: bamboohr
category: hris
end_user_origin_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
end_user_organization_name: Waystar Royco
end_user_email_address: [email protected]
status: COMPLETE
webhook_listener_url: >-
https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4
is_duplicate: true
account_type: PRODUCTION
completed_at: '2024-08-26T20:11:19Z'
source:
openapi: openapi/openapi.yml
46 changes: 46 additions & 0 deletions .mock/definition/knowledgebase/accountToken.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
imports:
root: __package__.yml
service:
auth: false
base-path: ''
endpoints:
retrieve:
path: /knowledgebase/v1/account-token/{public_token}
method: GET
auth: true
docs: >-
Returns the account token for the end user with the provided public
token.
source:
openapi: openapi/openapi.yml
path-parameters:
public_token: string
response:
docs: ''
type: root.AccountToken
status-code: 200
examples:
- path-parameters:
public_token: public_token
headers:
X-Account-Token: '[object Object]'
response:
body:
account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB
integration:
name: name
abbreviated_name: abbreviated_name
categories:
- hris
image: image
square_image: square_image
color: color
slug: slug
api_endpoints_to_documentation_urls:
key: value
webhook_setup_guide_url: webhook_setup_guide_url
category_beta_status:
key: value
id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd
source:
openapi: openapi/openapi.yml
757 changes: 757 additions & 0 deletions .mock/definition/knowledgebase/articles.yml

Large diffs are not rendered by default.

72 changes: 72 additions & 0 deletions .mock/definition/knowledgebase/asyncPassthrough.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
imports:
root: __package__.yml
service:
auth: false
base-path: ''
endpoints:
create:
path: /knowledgebase/v1/async-passthrough
method: POST
auth: true
docs: >-
Asynchronously pull data from an endpoint not currently supported by
Merge.
source:
openapi: openapi/openapi.yml
request:
body: root.DataPassthroughRequest
content-type: application/json
response:
docs: ''
type: root.AsyncPassthroughReciept
status-code: 200
examples:
- headers:
X-Account-Token: X-Account-Token
request:
method: GET
path: /scooters
response:
body:
async_passthrough_receipt_id: fd29020f-2695-445e-922e-dcd5e81903fd
retrieve:
path: /knowledgebase/v1/async-passthrough/{async_passthrough_receipt_id}
method: GET
auth: true
docs: Retrieves data from earlier async-passthrough POST request
source:
openapi: openapi/openapi.yml
path-parameters:
async_passthrough_receipt_id: string
response:
docs: ''
type: AsyncPassthroughRetrieveResponse
status-code: 200
examples:
- path-parameters:
async_passthrough_receipt_id: async_passthrough_receipt_id
headers:
X-Account-Token: X-Account-Token
response:
body:
method: GET
path: /scooters
status: 200
response:
key: value
response_headers:
X-Page-Token: value
response_type: JSON
headers:
EXTRA-HEADER: value
Authorization: <redacted>
source:
openapi: openapi/openapi.yml
types:
AsyncPassthroughRetrieveResponse:
discriminated: false
union:
- root.RemoteResponse
- string
source:
openapi: openapi/openapi.yml
144 changes: 144 additions & 0 deletions .mock/definition/knowledgebase/attachments.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
imports:
root: __package__.yml
service:
auth: false
base-path: ''
endpoints:
list:
path: /knowledgebase/v1/attachments
method: GET
auth: true
docs: Returns a list of `Attachment` objects.
source:
openapi: openapi/openapi.yml
request:
name: AttachmentsListRequest
query-parameters:
created_after:
type: optional<datetime>
docs: If provided, will only return objects created after this datetime.
created_before:
type: optional<datetime>
docs: >-
If provided, will only return objects created before this
datetime.
cursor:
type: optional<string>
docs: The pagination cursor value.
include_deleted_data:
type: optional<boolean>
docs: >-
Indicates whether or not this object has been deleted in the third
party platform. Full coverage deletion detection is a premium
add-on. Native deletion detection is offered for free with limited
coverage. [Learn
more](https://docs.merge.dev/integrations/hris/supported-features/).
include_remote_data:
type: optional<boolean>
docs: >-
Whether to include the original data Merge fetched from the
third-party to produce these models.
include_shell_data:
type: optional<boolean>
docs: >-
Whether to include shell records. Shell records are empty records
(they may contain some metadata but all other fields are null).
modified_after:
type: optional<datetime>
docs: >-
If provided, only objects synced by Merge after this date time
will be returned.
modified_before:
type: optional<datetime>
docs: >-
If provided, only objects synced by Merge before this date time
will be returned.
page_size:
type: optional<integer>
docs: Number of results to return per page.
remote_id:
type: optional<string>
docs: The API provider's ID for the given object.
response:
docs: ''
type: root.PaginatedAttachmentList
status-code: 200
examples:
- query-parameters:
cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
headers:
X-Account-Token: X-Account-Token
response:
body:
next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ
results:
- id: c640b80b-fac9-409f-aa19-1f9221aec445
remote_id: '11167'
created_at: '2021-09-15T00:00:00Z'
modified_at: '2021-10-16T00:00:00Z'
name: Article spec
description: This is an example attachment.
attachment_url: https://example.com/attachments/2039349
remote_was_deleted: true
field_mappings:
organization_defined_targets:
custom_key: custom_value
linked_account_defined_targets:
custom_key: custom_value
remote_data:
- path: /attachments
data:
- Varies by platform
retrieve:
path: /knowledgebase/v1/attachments/{id}
method: GET
auth: true
docs: Returns an `Attachment` object with the given `id`.
source:
openapi: openapi/openapi.yml
path-parameters:
id: string
request:
name: AttachmentsRetrieveRequest
query-parameters:
include_remote_data:
type: optional<boolean>
docs: >-
Whether to include the original data Merge fetched from the
third-party to produce these models.
include_shell_data:
type: optional<boolean>
docs: >-
Whether to include shell records. Shell records are empty records
(they may contain some metadata but all other fields are null).
response:
docs: ''
type: root.Attachment
status-code: 200
examples:
- path-parameters:
id: id
headers:
X-Account-Token: X-Account-Token
response:
body:
id: c640b80b-fac9-409f-aa19-1f9221aec445
remote_id: '11167'
created_at: '2021-09-15T00:00:00Z'
modified_at: '2021-10-16T00:00:00Z'
name: Article spec
description: This is an example attachment.
attachment_url: https://example.com/attachments/2039349
remote_was_deleted: true
field_mappings:
organization_defined_targets:
custom_key: custom_value
linked_account_defined_targets:
custom_key: custom_value
remote_data:
- path: /attachments
data:
- Varies by platform
source:
openapi: openapi/openapi.yml
Loading