Version 2 API Release checklist

[MrRefactoring]

Branch we are working

• v2 of API #40

All PR should have a target for this branch.

General

• 'urlSuffix' is better to be a configuration option. #35 completed.
• Adjustment of all code instances where sort?: {}; was incorrectly defined #46
• Write integration tests like we already have in the project. #44
• Set serializeIdsAsStrings to true for all of endpoint use this. #47
• Create next() function for all paginate endpoints. #110
• Create getAll... for all paginate endpoints. (return all data recursively got from paginated endpoint) #117

Api

• Enhancement: add data property to blogPost.createBlogPost #105
• Enhancement: add data property to blogPost.updateBlogPost #106
• Enhancement: add data property to customContent.createCustomContent #120
• Enhancement: add data property to customContent.updateCustomContent #121
• Enhancement: add data property to page.createPage #122
• Enhancement: add data property to page.updatePage #123
• Enhancement: add data property to task.updateTask #124
• Enhancement: add data property to user.checkAccessByEmail #125
• Enhancement: add data property to user.inviteByEmail #126
• Enhancement: Review and determine mandatory parameters for comment.createFooterComment method #127
• Enhancement: Review and determine mandatory parameters for comment.createInlineComment method #128
• Convert Dash-Cased Parameters to CamelCase in getBlogPostById #58
• Convert Dash-Cased Parameters to CamelCase in getPageFooterComments #59
• Convert Dash-Cased Parameters to CamelCase in getPageInlineComments #60
• Convert Dash-Cased Parameters to CamelCase in getBlogPostFooterComments #61
• Convert Dash-Cased Parameters to CamelCase in getBlogPostInlineComments #62
• Convert Dash-Cased Parameters to CamelCase in getFooterCommentById #64
• Convert Dash-Cased Parameters to CamelCase in getFooterCommentChildren #63
• Convert Dash-Cased Parameters to CamelCase in getInlineCommentById #65
• Convert Dash-Cased Parameters to CamelCase in getInlineCommentChildren #66
• Convert Dash-Cased Parameters to CamelCase in getCustomContentByTypeInBlogPost #67
• Convert Dash-Cased Parameters to CamelCase in getCustomContentByType #68
• Convert Dash-Cased Parameters to CamelCase in getCustomContentById #69
• Convert Dash-Cased Parameters to CamelCase in getCustomContentByTypeInPage #70
• Convert Dash-Cased Parameters to CamelCase in getCustomContentByTypeInSpace #71
• Convert Dash-Cased Parameters to CamelCase in getLabelPages #72
• Convert Dash-Cased Parameters to CamelCase in getPages #73
• Convert Dash-Cased Parameters to CamelCase in getPageById #74
• Convert Dash-Cased Parameters to CamelCase in getPagesInSpace #75
• Convert Dash-Cased Parameters to CamelCase in getSpaces #76
• Convert Dash-Cased Parameters to CamelCase in getSpaceById #77
• Convert Dash-Cased Parameters to CamelCase in getBlogPostVersions #78
• Convert Dash-Cased Parameters to CamelCase in getPageVersions #79
• Convert Dash-Cased Parameters to CamelCase in getCustomContentVersions #80
• Convert Dash-Cased Parameters to CamelCase in getFooterCommentVersions #81
• Convert Dash-Cased Parameters to CamelCase in getInlineCommentVersions #82
• Convert Dash-Cased Parameters to CamelCase in getTasks #83
• Convert Dash-Cased Parameters to CamelCase in getTaskById #84
• comment.getFooterCommentById body needs to clarify the type.
• comment.updateFooterComment body needs to clarify the type.
• comment.updateInlineComment body needs to clarify the type.
• content.convertContentIdsToContentTypes contentIds parameter should be added to the request.

Models

• Attachment: clarify types for pageId, blogPostId, customContentId. Mark optional parameters as required when it's needed.
• Body: clarify interface properties and types of these properties.
• UpdateInlineCommentModel: type of body?
• UpdateFooterCommentModel: type of body?
• Task: clarify types for id, localId, spaceId, pageId, blogPostId. Mark optional parameters as required when it's needed.
• SpaceProperty: clarify type for id.
• Space: clarify types for id, homepageId.
• PrimaryBodyRepresentation clarify properties and properties types.
• PageInlineCommentModel: clarify types for id, pageId. Mark optional parameters as required when it's needed.
• PageCommentModel: clarify types for id, pageId. Mark optional parameters as required when it's needed.
• PageBodyWrite: clarify properties.
• Page: clarify types for id, spaceId, parentId. Mark optional parameters as required when it's needed.
• Label: clarify types for id, name, prefix is optional?
• InviteByEmail: clarify types.
• InlineCommentModel: clarify types for id, blogPostId, pageId, parentCommentId. Mark optional parameters as required when it's needed.
• InlineCommentChildrenModel: clarify types for id, parentCommentId. Mark optional parameters as required when it's needed.
• ContentStatus: replate ContentStatus to a list of available statuses.
• FooterCommentModel: clarify types for id, blogPostId, pageId, parentCommentId. Mark optional parameters as required when it's needed.
• CustomContentVersion: Mark optional parameters as required when it's needed.
• CustomContentBodyWrite: check types.
• CustomContent: clarify types for id, spaceId, pageId, blogPostId, customContentId. Mark optional parameters as required when it's needed.
• CreateInlineCommentModel: clarify types for body, inlineCommentProperties. Mark optional parameters as required when it's needed.
• CreateFooterCommentModel: Mark optional parameters as required when it's needed.
• ContentPropertyUpdateRequest: version property should be clarified.
• ContentIdToContentTypeResponse: clarify the type.
• CommentVersion: Mark optional parameters as required when it's needed.
• CommentBodyWrite: clarify the type.
• ChildrenCommentModel clarify types fo id, parentCommentId. Mark optional parameters as required when it's needed.
• ChildPage: clarify types for id, spaceId. Mark optional parameters as required when it's needed.
• ChildCustomContent: clarify types for id, spaceId. Mark optional parameters as required when it's needed.
• CheckAccessByEmail: check types.
• BlogPostVersion: Mark optional parameters as required when it's needed.
• BlogPostInlineCommentModel: clarify types for id, blogPostId. Mark optional parameters as required when it's needed.
• BlogPostCommentModel: clarify types for id, blogPostId. Mark optional parameters as required when it's needed.
• BlogPostBodyWrite: clarify the type.
• BlogPost: clarify types for id, spaceId. Mark optional parameters as required when it's needed.
• Wrap results, _links to wapper. #45
• Remove unused models.

Paramerters

• Convert query parameters to camelCase for GET /tasks endpoint #57

---

Special thanks

I would like to extend my gratitude to the following individuals for their contributions and support:

• Fabio Rodriguez made significant contributions to the Version 2 API Client of the confluence.js project. Here are the specific contributions:
  Convert Dash-Cased Parameters to CamelCase in getPageInlineComments #60
  Convert Dash-Cased Parameters to CamelCase in getBlogPostFooterComments #61
  Convert Dash-Cased Parameters to CamelCase in getBlogPostInlineComments #62
  Convert Dash-Cased Parameters to CamelCase in getFooterCommentChildren #63
  Convert Dash-Cased Parameters to CamelCase in getFooterCommentById #64
  Convert Dash-Cased Parameters to CamelCase in getInlineCommentById #65
  Convert Dash-Cased Parameters to CamelCase in getInlineCommentChildren #66
  Convert Dash-Cased Parameters to CamelCase in getCustomContentByTypeInBlogPost #67
  Convert Dash-Cased Parameters to CamelCase in getCustomContentByType #68
  Convert Dash-Cased Parameters to CamelCase in getCustomContentById #69
  Convert Dash-Cased Parameters to CamelCase in getCustomContentByTypeInPage #70
  Convert Dash-Cased Parameters to CamelCase in getCustomContentByTypeInSpace #71
  Convert Dash-Cased Parameters to CamelCase in getLabelPages #72
  Convert Dash-Cased Parameters to CamelCase in getPages #73
  Convert Dash-Cased Parameters to CamelCase in getPageById #74
  Convert Dash-Cased Parameters to CamelCase in getPagesInSpace #75
  Convert Dash-Cased Parameters to CamelCase in getSpaces #76
  Convert Dash-Cased Parameters to CamelCase in getSpaceById #77
  Convert Dash-Cased Parameters to CamelCase in getBlogPostVersions #78
  Convert Dash-Cased Parameters to CamelCase in getPageVersions #79
  Convert Dash-Cased Parameters to CamelCase in getCustomContentVersions #80
  Convert Dash-Cased Parameters to CamelCase in getFooterCommentVersions #81
  Convert Dash-Cased Parameters to CamelCase in getTaskById #84

---

• Augustus Thomas for his contribution to making Version 2 API Client.
  Convert Dash-Cased Parameters to CamelCase in getBlogPostById #58
• Haider Zaidi for his contribution to making Version 2 API Client.
  Convert Dash-Cased Parameters to CamelCase in getTasks #83
• mukultotla for his contribution to making Version 2 API Client.
  Convert Dash-Cased Parameters to CamelCase in getInlineCommentVersions #82
• Kunal Virk for his contribution to making Version 2 API Client.
  Convert Dash-Cased Parameters to CamelCase in getPageFooterComments #59