Skip to content
Closed
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
213 changes: 212 additions & 1 deletion .mock/definition/ticketing/__package__.yml
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,19 @@ types:
id: string
source:
openapi: openapi/openapi.yml
ActionsEnum:
enum:
- VIEW
- CREATE
- EDIT
- DELETE
docs: |-
* `VIEW` - VIEW
* `CREATE` - CREATE
* `EDIT` - EDIT
* `DELETE` - DELETE
source:
openapi: openapi/openapi.yml
AdvancedMetadata:
properties:
id:
Expand Down Expand Up @@ -791,6 +804,16 @@ types:
source:
openapi: openapi/openapi.yml
inline: true
CollectionPermissionsItem:
discriminated: false
union:
- type: string
validation:
format: uuid
- Permission
source:
openapi: openapi/openapi.yml
inline: true
Collection:
docs: >-
# The Collection Object
Expand Down Expand Up @@ -847,6 +870,9 @@ types:
parent_collection:
type: optional<CollectionParentCollection>
docs: The parent collection for this collection.
permissions:
type: optional<list<CollectionPermissionsItem>>
access: read-only
collection_url:
type: optional<string>
docs: The 3rd party url of the Collection.
Expand Down Expand Up @@ -1302,6 +1328,17 @@ types:
status_code: integer
source:
openapi: openapi/openapi.yml
EffectEnum:
enum:
- ALLOWED
- DENIED
- INHERITED
docs: |-
* `ALLOWED` - ALLOWED
* `DENIED` - DENIED
* `INHERITED` - INHERITED
source:
openapi: openapi/openapi.yml
EnabledActionsEnum:
enum:
- READ
Expand Down Expand Up @@ -2168,6 +2205,139 @@ types:
access: write-only
source:
openapi: openapi/openapi.yml
PermissionEffect:
discriminated: false
docs: |-
Outcome of this permission rule for matching users.

* `ALLOWED` - ALLOWED
* `DENIED` - DENIED
* `INHERITED` - INHERITED
union:
- EffectEnum
- string
source:
openapi: openapi/openapi.yml
inline: true
Permission:
docs: >-
# The Permission Object

### Description

The `Permission` object is used to represent permissions that can be
applied to users, roles, teams, collections, and tickets.


### Usage Example

TODO
properties:
id:
type: optional<string>
validation:
format: uuid
access: read-only
remote_id:
type: optional<string>
docs: The third-party API ID of the matching object.
created_at:
type: optional<datetime>
docs: The datetime that this object was created by Merge.
access: read-only
modified_at:
type: optional<datetime>
docs: The datetime that this object was modified by Merge.
access: read-only
effect:
type: optional<PermissionEffect>
docs: |-
Outcome of this permission rule for matching users.

* `ALLOWED` - ALLOWED
* `DENIED` - DENIED
* `INHERITED` - INHERITED
actions:
type: optional<list<optional<ActionsEnum>>>
docs: >-
Operations that this permission applies to. If the entity inherits
permission from a parent entity, then this should be an empty array.
In that case, the entity would inherit the parent entity’s actions.
applied_to_users: optional<list<optional<string>>>
applied_to_roles: optional<list<optional<string>>>
applied_to_teams: optional<list<optional<string>>>
applied_to_collections: optional<list<optional<string>>>
remote_was_deleted:
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/).
access: read-only
field_mappings:
type: optional<map<string, unknown>>
access: read-only
source:
openapi: openapi/openapi.yml
PermissionRequestEffect:
discriminated: false
docs: |-
Outcome of this permission rule for matching users.

* `ALLOWED` - ALLOWED
* `DENIED` - DENIED
* `INHERITED` - INHERITED
union:
- EffectEnum
- string
source:
openapi: openapi/openapi.yml
inline: true
PermissionRequest:
docs: >-
# The Permission Object

### Description

The `Permission` object is used to represent permissions that can be
applied to users, roles, teams, collections, and tickets.


### Usage Example

TODO
properties:
remote_id:
type: optional<string>
docs: The third-party API ID of the matching object.
effect:
type: optional<PermissionRequestEffect>
docs: |-
Outcome of this permission rule for matching users.

* `ALLOWED` - ALLOWED
* `DENIED` - DENIED
* `INHERITED` - INHERITED
actions:
type: optional<list<optional<ActionsEnum>>>
docs: >-
Operations that this permission applies to. If the entity inherits
permission from a parent entity, then this should be an empty array.
In that case, the entity would inherit the parent entity’s actions.
applied_to_users: optional<list<optional<string>>>
applied_to_roles: optional<list<optional<string>>>
applied_to_teams: optional<list<optional<string>>>
applied_to_collections: optional<list<optional<string>>>
integration_params:
type: optional<map<string, unknown>>
access: write-only
linked_account_params:
type: optional<map<string, unknown>>
access: write-only
source:
openapi: openapi/openapi.yml
PriorityEnum:
enum:
- URGENT
Expand Down Expand Up @@ -2233,6 +2403,24 @@ types:
access: read-only
source:
openapi: openapi/openapi.yml
RegenerateAccountToken:
docs: >-
# The RegenerateAccountToken Object

### Description

The `RegenerateAccountToken` object is used to exchange an old account
token for a new one.


### Usage Example

Post to receive a new `RegenerateAccountToken`.
properties:
linked_account_id: string
account_token: string
source:
openapi: openapi/openapi.yml
RemoteData:
docs: >-
# The RemoteData Object
Expand Down Expand Up @@ -2524,13 +2712,15 @@ types:
- API
- SYSTEM
- MERGE_TEAM
- SUPPORT
docs: |-
* `ADMIN` - ADMIN
* `DEVELOPER` - DEVELOPER
* `MEMBER` - MEMBER
* `API` - API
* `SYSTEM` - SYSTEM
* `MERGE_TEAM` - MERGE_TEAM
* `SUPPORT` - SUPPORT
source:
openapi: openapi/openapi.yml
SelectiveSyncConfigurationsUsageEnum:
Expand Down Expand Up @@ -2567,6 +2757,14 @@ types:
source:
openapi: openapi/openapi.yml
inline: true
SyncStatusStatus:
discriminated: false
union:
- StatusFd5Enum
- string
source:
openapi: openapi/openapi.yml
inline: true
SyncStatus:
docs: >-
# The SyncStatus Object
Expand All @@ -2588,7 +2786,7 @@ types:
next_sync_start: optional<datetime>
last_sync_result: optional<SyncStatusLastSyncResult>
last_sync_finished: optional<datetime>
status: StatusFd5Enum
status: SyncStatusStatus
is_initial_sync: boolean
selective_sync_configurations_usage: optional<SelectiveSyncConfigurationsUsageEnum>
source:
Expand Down Expand Up @@ -2808,6 +3006,16 @@ types:
source:
openapi: openapi/openapi.yml
inline: true
TicketPermissionsItem:
discriminated: false
union:
- type: string
validation:
format: uuid
- Permission
source:
openapi: openapi/openapi.yml
inline: true
TicketPriority:
discriminated: false
docs: |-
Expand Down Expand Up @@ -2918,6 +3126,9 @@ types:
* `PRIVATE` - PRIVATE

* `COLLECTION` - COLLECTION
permissions:
type: optional<list<TicketPermissionsItem>>
access: read-only
tags: optional<list<optional<string>>>
roles: optional<list<optional<string>>>
remote_created_at:
Expand Down
19 changes: 19 additions & 0 deletions .mock/definition/ticketing/accountToken.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,24 @@ service:
category_beta_status:
key: value
id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd
regenerateCreate:
path: /ticketing/v1/account-token/regenerate
method: POST
auth:
- tokenAuth: []
docs: Exchange Linked Account account tokens.
source:
openapi: openapi/openapi.yml
response:
docs: ''
type: root.RegenerateAccountToken
status-code: 200
examples:
- headers:
X-Account-Token: X-Account-Token
response:
body:
linked_account_id: e59b1821-f85c-4e28-a6b3-1804156f3563
account_token: hXY57W0g0WkdRHjCaPvwijK63fwfN-o_Wh7f30SLTq_uPCOLo-WFcA
source:
openapi: openapi/openapi.yml
2 changes: 1 addition & 1 deletion .mock/definition/ticketing/accounts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ service:
will be returned.
page_size:
type: optional<integer>
docs: Number of results to return per page.
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.
Expand Down
4 changes: 4 additions & 0 deletions .mock/definition/ticketing/collections.yml
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,8 @@ service:
access_level: PRIVATE
collection_type: LIST
parent_collection: parent_collection
permissions:
- 17a54124-287f-494d-965e-3c5b330c9a68
collection_url: https://example.com
remote_created_at: '2022-01-01T00:00:00Z'
remote_updated_at: '2022-01-01T00:00:00Z'
Expand Down Expand Up @@ -291,6 +293,8 @@ service:
access_level: PRIVATE
collection_type: LIST
parent_collection: parent_collection
permissions:
- 17a54124-287f-494d-965e-3c5b330c9a68
collection_url: https://example.com
remote_created_at: '2022-01-01T00:00:00Z'
remote_updated_at: '2022-01-01T00:00:00Z'
Expand Down
14 changes: 14 additions & 0 deletions .mock/definition/ticketing/fieldMapping.yml
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,11 @@ service:
mapping instance (i.e. `remote_fields.remote_key_name` and
`remote_fields.schema` will be null). This will increase the speed
of the request since these fields require some calculations.
remote_data_iteration_count:
type: optional<integer>
docs: >-
Number of common model instances to iterate through when fetching
remote data for field mappings. Defaults to 250 if not provided.
body:
properties:
target_field_name:
Expand Down Expand Up @@ -302,6 +307,7 @@ service:
examples:
- query-parameters:
exclude_remote_field_metadata: true
remote_data_iteration_count: 1
headers:
X-Account-Token: X-Account-Token
request:
Expand Down Expand Up @@ -428,6 +434,12 @@ service:
field_mapping_id: string
request:
name: PatchedEditFieldMappingRequest
query-parameters:
remote_data_iteration_count:
type: optional<integer>
docs: >-
Number of common model instances to iterate through when fetching
remote data for field mappings. Defaults to 250 if not provided.
body:
properties:
remote_field_traversal_path:
Expand Down Expand Up @@ -464,6 +476,8 @@ service:
examples:
- path-parameters:
field_mapping_id: field_mapping_id
query-parameters:
remote_data_iteration_count: 1
headers:
X-Account-Token: X-Account-Token
request: {}
Expand Down
Loading