Skip to content

docs(functions): add short and long descriptions to triggers methods #960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 26, 2023
Merged

docs(functions): add short and long descriptions to triggers methods #960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 packages/clients/src/api/function/v1beta1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -884,6 +884,12 @@ export class API extends ParentAPI {
unmarshalToken,
)

/**
* Create a trigger. Create a new trigger for a specified function.
*
* @param request - The request {@link CreateTriggerRequest}
* @returns A Promise of Trigger
*/
createTrigger = (request: Readonly<CreateTriggerRequest>) =>
this.client.fetch<Trigger>(
{
Expand All @@ -900,6 +906,12 @@ export class API extends ParentAPI {
unmarshalTrigger,
)

/**
* Get a trigger. Get a trigger with a specified ID.
*
* @param request - The request {@link GetTriggerRequest}
* @returns A Promise of Trigger
*/
getTrigger = (request: Readonly<GetTriggerRequest>) =>
this.client.fetch<Trigger>(
{
Expand Down Expand Up @@ -971,9 +983,22 @@ export class API extends ParentAPI {
unmarshalListTriggersResponse,
)

/**
* List all triggers. List all triggers belonging to a specified Organization
* or Project.
*
* @param request - The request {@link ListTriggersRequest}
* @returns A Promise of ListTriggersResponse
*/
listTriggers = (request: Readonly<ListTriggersRequest> = {}) =>
enrichForPagination('triggers', this.pageOfListTriggers, request)

/**
* Update a trigger. Update a trigger with a specified ID.
*
* @param request - The request {@link UpdateTriggerRequest}
* @returns A Promise of Trigger
*/
updateTrigger = (request: Readonly<UpdateTriggerRequest>) =>
this.client.fetch<Trigger>(
{
Expand All @@ -990,6 +1015,12 @@ export class API extends ParentAPI {
unmarshalTrigger,
)

/**
* Delete a trigger. Delete a trigger with a specified ID.
*
* @param request - The request {@link DeleteTriggerRequest}
* @returns A Promise of Trigger
*/
deleteTrigger = (request: Readonly<DeleteTriggerRequest>) =>
this.client.fetch<Trigger>(
{
Expand Down
4 changes: 2 additions & 2 deletions packages/clients/src/api/function/v1beta1/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,10 +465,10 @@ export interface TriggerMnqNatsClientConfig {

/** Trigger. mnq sqs client config. */
export interface TriggerMnqSqsClientConfig {
/** @deprecated */
mnqNamespaceId?: string
/** Name of the SQS queue the trigger listens to. */
queue: string
/** @deprecated */
mnqNamespaceId?: string
/** ID of the M&Q project. */
mnqProjectId: string
/** Region in which the M&Q project is activated. */
Expand Down