Namespace MatchAttachmentAdapter

Namespace for all of the Match Attachment routes

Index

Functions

Functions

create

create(api_key: string, tournament_url: string, match_id: number, params: createMatchAttachmentRequest): Promise<createMatchAttachmentResponse>

- Defined in adapter/matchAttachments.ts:20
Add a file, link, or text attachment to a match. NOTE: The associated tournament's "accept_attachments" attribute must be true for this action to succeed.

Parameters
- api_key: string
- tournament_url: string
- match_id: number
- params: createMatchAttachmentRequest
Returns Promise<createMatchAttachmentResponse>

destroy

destroy(api_key: string, tournament_url: string, match_id: number, attachment_id: number): Promise<destroyMatchAttachmentResponse>

- Defined in adapter/matchAttachments.ts:53
Delete a match attachment.

Parameters
- api_key: string
- tournament_url: string
- match_id: number
- attachment_id: number
Returns Promise<destroyMatchAttachmentResponse>

index

index(api_key: string, tournament_url: string, match_id: number): Promise<indexMatchAttachmentsResponse>

- Defined in adapter/matchAttachments.ts:7
Retrieve a match's attachments.

Parameters
- api_key: string
- tournament_url: string
- match_id: number
Returns Promise<indexMatchAttachmentsResponse>

show

show(api_key: string, tournament_url: string, match_id: number, attachment_id: number): Promise<showMatchAttachmentResponse>

- Defined in adapter/matchAttachments.ts:31
Retrieve a single match attachment record.

Parameters
- api_key: string
- tournament_url: string
- match_id: number
- attachment_id: number
Returns Promise<showMatchAttachmentResponse>

update

update(api_key: string, tournament_url: string, match_id: number, attachment_id: number, params: updateMatchAttachmentRequest): Promise<updateMatchAttachmentResponse>

- Defined in adapter/matchAttachments.ts:42
Update the attributes of a match attachment.

Parameters
- api_key: string
- tournament_url: string
- match_id: number
- attachment_id: number
- params: updateMatchAttachmentRequest
Returns Promise<updateMatchAttachmentResponse>

Generated using TypeDoc