Skip to content

Conversation

@michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Nov 26, 2025

Resolves #19170
Resolves #19169

Summary by CodeRabbit

  • New Features

    • Add actions to manage ticket tags: list, add, and set tags.
    • Add actions to list and update ticket custom field values (dynamic field mapping).
    • Add action to retrieve a macro by ID.
    • Extended Gorgias OAuth client with new tag and custom-field methods.
  • Chores

    • Bumped component and source package versions.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel
Copy link

vercel bot commented Nov 26, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Preview Comments Updated (UTC)
pipedream-docs Ignored Ignored Dec 1, 2025 3:42pm
pipedream-docs-redirect-do-not-edit Ignored Ignored Dec 1, 2025 3:42pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 26, 2025

Walkthrough

Adds new Gorgias ticket/tag/field/macro actions and corresponding app client methods, introduces dynamic ticket-field update props, and bumps package and multiple action/source versions across the Gorgias OAuth component.

Changes

Cohort / File(s) Summary
New ticket tag actions
components/gorgias_oauth/actions/add-ticket-tags/add-ticket-tags.mjs, components/gorgias_oauth/actions/list-ticket-tags/list-ticket-tags.mjs, components/gorgias_oauth/actions/set-ticket-tags/set-ticket-tags.mjs
New actions to add, list, and set tags on a ticket; each uses ticketId (propDefinition) and tagIds as applicable and calls new app client tag endpoints.
New ticket field value actions
components/gorgias_oauth/actions/list-ticket-field-values/list-ticket-field-values.mjs, components/gorgias_oauth/actions/update-ticket-field-values/update-ticket-field-values.mjs
New actions to list and update ticket custom field values. The update action provides dynamic additionalProps() built from custom field definitions and constructs typed payloads merging provided and existing values.
New macro action
components/gorgias_oauth/actions/get-macro/get-macro.mjs
New "Get Macro" action that fetches a macro by ID via the app client.
App client additions
components/gorgias_oauth/gorgias_oauth.app.mjs
Adds methods: listTicketTags, addTicketTags, setTicketTags, listTicketFieldValues, listCustomFields, updateTicketFieldValues mapping to /tickets/{ticketId}/tags, /tickets/{ticketId}/custom-fields, and /custom-fields endpoints.
Action version bumps
components/gorgias_oauth/actions/{create-customer,create-macro,create-ticket-message,create-ticket,delete-macro,get-ticket-message,get-ticket,list-macros,list-messages,list-ticket-messages,list-ticket-messages,list-tickets,retrieve-customer,update-customer,update-macro,update-ticket}/**/*.mjs
Patch/minor version increments across multiple existing actions (metadata only).
Source version bumps
components/gorgias_oauth/sources/{internal-note-created,macro-updated,new-macro-created,ticket-created,ticket-message-created,ticket-updated}/*.mjs
Version increments in several sources (metadata only).
Package version
components/gorgias_oauth/package.json
Package version bumped from 0.7.0 to 0.8.0.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Action as Tag Action (add/list/set)
    participant App as Gorgias App Client
    participant API as Gorgias API

    User->>Action: invoke with ticketId (+ tagIds)
    Action->>App: call addTicketTags/listTicketTags/setTicketTags({ ticketId, ... })
    App->>API: HTTP POST/GET/PUT /tickets/{ticketId}/tags
    API-->>App: response (tags/count)
    App-->>Action: return response
    Action->>Action: export summary (e.g., "Added X tags to ticket Y")
    Action-->>User: return API response
Loading
sequenceDiagram
    participant User
    participant Action as update-ticket-field-values
    participant App as Gorgias App Client
    participant API as Gorgias API

    User->>Action: invoke with ticketId and field props
    Action->>App: listCustomFields()
    App->>API: GET /custom-fields
    API-->>App: custom field definitions
    App-->>Action: return definitions
    Action->>App: listTicketFieldValues({ ticketId })
    App->>API: GET /tickets/{ticketId}/custom-fields
    API-->>App: existing field values
    App-->>Action: return existing values
    Action->>Action: build payload (merge provided + existing, convert types)
    Action->>App: updateTicketFieldValues({ ticketId, data })
    App->>API: POST /tickets/{ticketId}/custom-fields
    API-->>App: update response
    App-->>Action: return response
    Action->>Action: export summary
    Action-->>User: return API response
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

  • Files needing extra attention:
    • components/gorgias_oauth/actions/update-ticket-field-values/update-ticket-field-values.mjs — dynamic additionalProps() logic, type mapping, and merging existing vs. new values.
    • components/gorgias_oauth/gorgias_oauth.app.mjs — verify newly added methods map to correct endpoints, HTTP verbs, and parameter shapes.
    • New actions interacting with tag/field methods — ensure consistent propDefinitions, summaries, and returned payload shapes.

Possibly related PRs

Suggested labels

User submitted

Suggested reviewers

  • lcaresia

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 2 inconclusive)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description only provides issue references without explaining the changes, failing to follow the required template structure with a WHY section. Add a WHY section explaining the purpose and context of implementing these new Gorgias actions as specified in the template.
Title check ❓ Inconclusive The title 'Gorgias - new components' is partially related to the changes but lacks specificity about which new components are being added. Consider using a more descriptive title like 'Add Gorgias macro and ticket tags actions' to better reflect the specific new functionality.
Out of Scope Changes check ❓ Inconclusive Version bumps in existing actions and sources appear to be scoped maintenance updates, but the comprehensive version updates across many files may warrant clarification of their necessity. Clarify whether the version bumps across 15+ existing actions and sources are necessary or if they should be separated into a distinct maintenance PR.
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed All linked issue objectives are met: get-macro action implements #19170 requirement; list/add/set ticket tags and list/update ticket field values actions fully implement #19169 requirements with matching API endpoints.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@michelle0927 michelle0927 marked this pull request as ready for review November 26, 2025 18:11
luancazarine
luancazarine previously approved these changes Nov 26, 2025
Copy link
Collaborator

@luancazarine luancazarine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @michelle0927, LGTM! Ready for QA!

@vunguyenhung
Copy link
Collaborator

Hello everyone, I have tested this PR and there're some test cases failed or needed improvement.

Please check test reports below for more information:

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4a6b3ae and 4ecb417.

📒 Files selected for processing (1)
  • components/gorgias_oauth/actions/update-ticket-field-values/update-ticket-field-values.mjs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Lint Code Base
  • GitHub Check: pnpm publish
  • GitHub Check: Publish TypeScript components
  • GitHub Check: Verify TypeScript components

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[ACTION] Gorgias - Macros [ACTION] Gorgias - ticket tags

4 participants