Skip to content
New issue

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

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

Already on GitHub? # to your account

Changed create-many tickets object type #412

Merged
merged 1 commit into from
Jul 2, 2024

Conversation

1frenk6
Copy link

@1frenk6 1frenk6 commented May 28, 2024

Pull Request Description

Description

This pull request introduces changes to the tickets.js file in the src/clients/core directory:

  1. Added a Typedef for CreateManyTickets:

    • Introduced a new typedef object CreateManyTickets which represents an object containing an array of tickets to create.
  2. Updated Parameter Documentation:

    • Changed the parameter type for the createMany method from Array<CreateOrUpdateTicket> to CreateManyTickets.
    • Updated the description to reflect this change: from "an array of ticket objects to create" to "an object of tickets containing an array of tickets".
  3. Modified Example Usage:

    • Updated the example in the documentation to reflect the new CreateManyTickets object structure.
  4. Updated Links and Documentation:

    • Corrected the link in the @see annotation to point to the appropriate section for creating many tickets.

Related Issue(s)

  • This PR fixes/closes issue #...
  • This is a new feature and does not have an associated issue.

Additional Information

  • This change is a breaking change (may require a major version update)
  • This change is a new feature (non-breaking change which adds functionality)
  • This change improves the code (e.g., refactoring, etc.)
  • This change includes dependency updates

Test Cases

The following test cases were executed to verify the changes:

  1. Ensured that the createMany method functions correctly with the new CreateManyTickets object structure.
  2. Verified that existing functionality is not broken by running all existing unit tests.
  3. Added new unit tests to cover the CreateManyTickets object usage.
image

Documentation

  • I have updated the documentation accordingly.
  • No updates are required.

Checklist

  • I have read the CONTRIBUTING documentation.
  • My code follows the coding standards of this project.
  • All new and existing tests passed.

@blakmatrix blakmatrix merged commit e396120 into blakmatrix:master Jul 2, 2024
1 check passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants