chore: added jsdocs

src/organization/organization.ts

@@ -16,6 +16,16 @@ export class Organization {
     this.sdk = sdk;
   }
 
+  /**
+   * The function creates an organization using the provided input and returns the result, or throws an
+   * error if there is one.
+   * @param {CreateOrganizationInput} organizationInput - The `organizationInput` parameter is an
+   * object that contains the input data for creating an organization. It likely includes properties
+   * such as the organization's name, description, and any other relevant information needed to create
+   * the organization.
+   * @returns the result of the `createOrganization_mutation` method call, which is awaited using the
+   * `await` keyword.
+   */
   async createOrganization(organizationInput: CreateOrganizationInput) {
     try {
       return await this.sdk.createOrganization_mutation({
@@ -26,6 +36,13 @@ export class Organization {
     }
   }
 
+  /**
+   * The function adds a member to an organization using the provided input.
+   * @param {MemberInput} memberInput - The `memberInput` parameter is an object that contains the
+   * information needed to add a member to an organization. It likely includes properties such as the
+   * member's name, email, role, and any other relevant details.
+   * @returns the result of the `addMemberToOrganization_mutation` mutation call.
+   */
   async addMemberToOrganization(memberInput: MemberInput) {
     try {
       return await this.sdk.addMemberToOrganization_mutation({
@@ -36,6 +53,14 @@ export class Organization {
     }
   }
 
+  /**
+   * The function "changeMemberRole" is an asynchronous function that takes a "memberInput" parameter
+   * and calls a mutation function to change the role of a member, handling any errors that occur.
+   * @param {MemberInput} memberInput - The `memberInput` parameter is an object that contains the
+   * necessary information to change the role of a member. It likely includes properties such as the
+   * member's ID and the new role they should be assigned to.
+   * @returns the result of the `changeMemberRole_mutation` mutation, which is being awaited.
+   */
   async changeMemberRole(memberInput: MemberInput) {
     try {
       return await this.sdk.changeMemberRole_mutation({ input: memberInput });
@@ -44,6 +69,14 @@ export class Organization {
     }
   }
 
+  /**
+   * The function removes a member from an organization using the provided input.
+   * @param {TransferMemberInput} memberInput - The `memberInput` parameter is an object that contains
+   * the necessary information to remove a member from an organization. It likely includes properties
+   * such as the member's ID or username, and any additional data required to complete the removal
+   * process.
+   * @returns the result of the `removeMemberFromOrganization_mutation` mutation call.
+   */
   async removeMemberFromOrganization(memberInput: TransferMemberInput) {
     try {
       return await this.sdk.removeMemberFromOrganization_mutation({
@@ -54,6 +87,14 @@ export class Organization {
     }
   }
 
+  /**
+   * The function `updateOrganization` updates an organization using the provided input and returns the
+   * result of the update.
+   * @param {UpdateOrganizationInput} updatedOrganization - The `updatedOrganization` parameter is an
+   * object of type `UpdateOrganizationInput`. It contains the updated information for an organization.
+   * @returns the result of the `updateOrganization_mutation` method call, which is likely a Promise
+   * that resolves to the updated organization data.
+   */
   async updateOrganization(updatedOrganization: UpdateOrganizationInput) {
     try {
       return await this.sdk.updateOrganization_mutation({
@@ -64,6 +105,17 @@ export class Organization {
     }
   }
 
+  /**
+   * The function `getOrganization` retrieves an organization based on the specified identifier type
+   * and value.
+   * @param {OrganizationIdentifierType} type - The type of organization identifier. It could be a
+   * value like "GATEWAY_ID", "ORG_ID", etc. This parameter is used to specify the type of identifier
+   * you are providing in the value parameter.
+   * @param {string} value - The value parameter is a string that represents the identifier value of
+   * the organization. It could be an organization name, ID, or any other unique identifier depending
+   * on the type of identifier specified.
+   * @returns the result of the `organization_query` method call.
+   */
   async getOrganization(type: OrganizationIdentifierType, value: string) {
     try {
       return await this.sdk.organization_query({ input: { type, value } });
@@ -72,6 +124,13 @@ export class Organization {
     }
   }
 
+  /**
+   * The function `getOrganizations` retrieves organizations based on optional filters, pagination
+   * parameters, and error handling.
+   * @param  - - `filter` is an optional input parameter of type `FilterOrganizationInput`. It is used
+   * to filter the organizations based on certain criteria.
+   * @returns the result of the `organizations_query` method call from the `sdk` object.
+   */
   async getOrganizations({
     filter,
     skip,