@wix/auto_sdk_groups_membership-questions 1.0.0

package/build/internal/es/src/social-groups-v2-membership-question-membership-questions.types.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Question asked to members when joining a group.
+ * Only group admins can create or update membership questions
+ * and can set whether it is required to answer membership questions.
+ */
+export interface MembershipQuestion {
+    /**
+     * Question ID.
+     * @readonly
+     */
+    id?: string | null;
+    /** Whether a member must answer this question when joining the group. */
+    required?: boolean;
+    /** Question text. */
+    text?: string;
+}
+export interface ListMembershipQuestionsRequest {
+    /** Group ID. */
+    groupId: string;
+}
+export interface ListMembershipQuestionsResponse {
+    /** Retrieved membership questions. */
+    questions?: MembershipQuestion[];
+}
+export interface CreateOrReplaceAllMembershipQuestionsRequest {
+    /** Group ID. */
+    groupId: string;
+    /** New membership questions. */
+    questions?: MembershipQuestion[];
+}
+export interface CreateOrReplaceAllMembershipQuestionsResponse {
+    /** Membership questions. */
+    questions?: MembershipQuestion[];
+}
+export interface ListAnswersRequest {
+    /** Group ID. */
+    groupId: string;
+    /** Member IDs. If no member ID is provided, answers for all members will be returned. See the Members API for more details. */
+    memberIds?: string[];
+    paging?: Paging;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface ListAnswersResponse {
+    /** Answers to the membership questions, grouped by member. */
+    memberAnswers?: MemberMembershipQuestionAnswers[];
+    /** Membership questions by question ID. Includes only questions that have been answered by the specified members. */
+    questions?: Record<string, MembershipQuestion>;
+    metadata?: PagingMetadata;
+}
+export interface MemberMembershipQuestionAnswers {
+    /** Member ID. See the Members API for more details. */
+    memberId?: string;
+    /** Answers to the membership question. */
+    answers?: MembershipQuestionAnswer[];
+}
+/** Answer to a membership question. */
+export interface MembershipQuestionAnswer {
+    /** Question ID. */
+    id?: string;
+    /** Answer text. */
+    text?: string | null;
+}
+export interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+export interface ListAnswerCountsRequest {
+    memberIds?: string[];
+}
+export interface ListAnswerCountsResponse {
+    memberAnswerCounts?: MemberAnswerCount[];
+}
+export interface MemberAnswerCount {
+    memberId?: string;
+    groupId?: string;
+    count?: number;
+}
+interface MembershipQuestionNonNullableFields {
+    required: boolean;
+    text: string;
+}
+export interface ListMembershipQuestionsResponseNonNullableFields {
+    questions: MembershipQuestionNonNullableFields[];
+}
+export interface CreateOrReplaceAllMembershipQuestionsResponseNonNullableFields {
+    questions: MembershipQuestionNonNullableFields[];
+}
+interface MembershipQuestionAnswerNonNullableFields {
+    id: string;
+}
+interface MemberMembershipQuestionAnswersNonNullableFields {
+    memberId: string;
+    answers: MembershipQuestionAnswerNonNullableFields[];
+}
+export interface ListAnswersResponseNonNullableFields {
+    memberAnswers: MemberMembershipQuestionAnswersNonNullableFields[];
+}
+export {};

package/build/internal/es/src/social-groups-v2-membership-question-membership-questions.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=social-groups-v2-membership-question-membership-questions.types.js.map

package/build/internal/es/src/social-groups-v2-membership-question-membership-questions.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"social-groups-v2-membership-question-membership-questions.types.js","sourceRoot":"","sources":["../../../../src/social-groups-v2-membership-question-membership-questions.types.ts"],"names":[],"mappings":""}

package/build/internal/es/src/social-groups-v2-membership-question-membership-questions.universal.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Question asked to members when joining a group.
+ * Only group admins can create or update membership questions
+ * and can set whether it is required to answer membership questions.
+ */
+export interface MembershipQuestion {
+    /**
+     * Question ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Whether a member must answer this question when joining the group. */
+    required?: boolean;
+    /** Question text. */
+    text?: string;
+}
+export interface ListMembershipQuestionsRequest {
+    /** Group ID. */
+    groupId: string;
+}
+export interface ListMembershipQuestionsResponse {
+    /** Retrieved membership questions. */
+    questions?: MembershipQuestion[];
+}
+export interface CreateOrReplaceAllMembershipQuestionsRequest {
+    /** Group ID. */
+    groupId: string;
+    /** New membership questions. */
+    questions?: MembershipQuestion[];
+}
+export interface CreateOrReplaceAllMembershipQuestionsResponse {
+    /** Membership questions. */
+    questions?: MembershipQuestion[];
+}
+export interface ListAnswersRequest {
+    /** Group ID. */
+    groupId: string;
+    /** Member IDs. If no member ID is provided, answers for all members will be returned. See the Members API for more details. */
+    memberIds?: string[];
+    paging?: Paging;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface ListAnswersResponse {
+    /** Answers to the membership questions, grouped by member. */
+    memberAnswers?: MemberMembershipQuestionAnswers[];
+    /** Membership questions by question ID. Includes only questions that have been answered by the specified members. */
+    questions?: Record<string, MembershipQuestion>;
+    metadata?: PagingMetadata;
+}
+export interface MemberMembershipQuestionAnswers {
+    /** Member ID. See the Members API for more details. */
+    memberId?: string;
+    /** Answers to the membership question. */
+    answers?: MembershipQuestionAnswer[];
+}
+/** Answer to a membership question. */
+export interface MembershipQuestionAnswer {
+    /** Question ID. */
+    _id?: string;
+    /** Answer text. */
+    text?: string | null;
+}
+export interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+export interface ListAnswerCountsRequest {
+    memberIds?: string[];
+}
+export interface ListAnswerCountsResponse {
+    memberAnswerCounts?: MemberAnswerCount[];
+}
+export interface MemberAnswerCount {
+    memberId?: string;
+    groupId?: string;
+    count?: number;
+}
+interface MembershipQuestionNonNullableFields {
+    required: boolean;
+    text: string;
+}
+export interface ListMembershipQuestionsResponseNonNullableFields {
+    questions: MembershipQuestionNonNullableFields[];
+}
+export interface CreateOrReplaceAllMembershipQuestionsResponseNonNullableFields {
+    questions: MembershipQuestionNonNullableFields[];
+}
+interface MembershipQuestionAnswerNonNullableFields {
+    _id: string;
+}
+interface MemberMembershipQuestionAnswersNonNullableFields {
+    memberId: string;
+    answers: MembershipQuestionAnswerNonNullableFields[];
+}
+export interface ListAnswersResponseNonNullableFields {
+    memberAnswers: MemberMembershipQuestionAnswersNonNullableFields[];
+}
+/**
+ * Retrieves the membership questions for a group.
+ *
+ * >**Note:**
+ * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
+ * @param groupId - Group ID.
+ * @public
+ * @requiredField groupId
+ * @fqn wix.social.groups.api.v2.MembershipQuestionsService.ListMembershipQuestions
+ */
+export declare function listMembershipQuestions(groupId: string): Promise<ListMembershipQuestionsResponse & ListMembershipQuestionsResponseNonNullableFields>;
+/**
+ * Creates membership questions if none have been set up. Otherwise, replaces all existing questions.
+ *
+ * Providing an empty array means that members won't have to answer any question when joining the group.
+ * Only admins can create or replace membership questions.
+ *
+ * >**Note:**
+ * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
+ * @param groupId - Group ID.
+ * @public
+ * @requiredField groupId
+ * @fqn wix.social.groups.api.v2.MembershipQuestionsService.CreateOrReplaceAllMembershipQuestions
+ */
+export declare function createOrReplaceAllMembershipQuestions(groupId: string, options?: CreateOrReplaceAllMembershipQuestionsOptions): Promise<CreateOrReplaceAllMembershipQuestionsResponse & CreateOrReplaceAllMembershipQuestionsResponseNonNullableFields>;
+export interface CreateOrReplaceAllMembershipQuestionsOptions {
+    /** New membership questions. */
+    questions?: MembershipQuestion[];
+}
+/**
+ * Retrieves the answers to the membership questions, given the provided filters.
+ *
+ * >**Note:**
+ * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
+ * @param groupId - Group ID.
+ * @public
+ * @requiredField groupId
+ * @fqn wix.social.groups.api.v2.MembershipQuestionsService.ListAnswers
+ */
+export declare function listAnswers(groupId: string, options?: ListAnswersOptions): Promise<ListAnswersResponse & ListAnswersResponseNonNullableFields>;
+export interface ListAnswersOptions {
+    /** Member IDs. If no member ID is provided, answers for all members will be returned. See the Members API for more details. */
+    memberIds?: string[];
+    paging?: Paging;
+}
+export {};

package/build/internal/es/src/social-groups-v2-membership-question-membership-questions.universal.js

@@ -0,0 +1,114 @@
+import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
+import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
+import * as ambassadorWixSocialGroupsV2MembershipQuestion from './social-groups-v2-membership-question-membership-questions.http.js';
+/**
+ * Retrieves the membership questions for a group.
+ *
+ * >**Note:**
+ * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
+ * @param groupId - Group ID.
+ * @public
+ * @requiredField groupId
+ * @fqn wix.social.groups.api.v2.MembershipQuestionsService.ListMembershipQuestions
+ */
+export async function listMembershipQuestions(groupId) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({ groupId: groupId });
+    const reqOpts = ambassadorWixSocialGroupsV2MembershipQuestion.listMembershipQuestions(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { groupId: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['groupId']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * Creates membership questions if none have been set up. Otherwise, replaces all existing questions.
+ *
+ * Providing an empty array means that members won't have to answer any question when joining the group.
+ * Only admins can create or replace membership questions.
+ *
+ * >**Note:**
+ * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
+ * @param groupId - Group ID.
+ * @public
+ * @requiredField groupId
+ * @fqn wix.social.groups.api.v2.MembershipQuestionsService.CreateOrReplaceAllMembershipQuestions
+ */
+export async function createOrReplaceAllMembershipQuestions(groupId, options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[2];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        groupId: groupId,
+        questions: options?.questions,
+    });
+    const reqOpts = ambassadorWixSocialGroupsV2MembershipQuestion.createOrReplaceAllMembershipQuestions(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {
+                groupId: '$[0]',
+                questions: '$[1].questions',
+            },
+            singleArgumentUnchanged: false,
+        }, ['groupId', 'options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * Retrieves the answers to the membership questions, given the provided filters.
+ *
+ * >**Note:**
+ * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
+ * @param groupId - Group ID.
+ * @public
+ * @requiredField groupId
+ * @fqn wix.social.groups.api.v2.MembershipQuestionsService.ListAnswers
+ */
+export async function listAnswers(groupId, options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[2];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        groupId: groupId,
+        memberIds: options?.memberIds,
+        paging: options?.paging,
+    });
+    const reqOpts = ambassadorWixSocialGroupsV2MembershipQuestion.listAnswers(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {
+                groupId: '$[0]',
+                memberIds: '$[1].memberIds',
+                paging: '$[1].paging',
+            },
+            singleArgumentUnchanged: false,
+        }, ['groupId', 'options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+//# sourceMappingURL=social-groups-v2-membership-question-membership-questions.universal.js.map

package/build/internal/es/src/social-groups-v2-membership-question-membership-questions.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"social-groups-v2-membership-question-membership-questions.universal.js","sourceRoot":"","sources":["../../../../src/social-groups-v2-membership-question-membership-questions.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,6CAA6C,MAAM,qEAAqE,CAAC;AAkIrI;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,OAAe;IAKf,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAE5E,MAAM,OAAO,GACX,6CAA6C,CAAC,uBAAuB,CACnE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE;YAC7C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,CAAC,CACZ,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,qCAAqC,CACzD,OAAe,EACf,OAAsD;IAKtD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,OAAO,EAAE,OAAO;QAChB,SAAS,EAAE,OAAO,EAAE,SAAS;KAC9B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,6CAA6C,CAAC,qCAAqC,CACjF,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,OAAO,EAAE,MAAM;gBACf,SAAS,EAAE,gBAAgB;aAC5B;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACvB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAOD;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAAe,EACf,OAA4B;IAE5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,OAAO,EAAE,OAAO;QAChB,SAAS,EAAE,OAAO,EAAE,SAAS;QAC7B,MAAM,EAAE,OAAO,EAAE,MAAM;KACxB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,6CAA6C,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAErE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,OAAO,EAAE,MAAM;gBACf,SAAS,EAAE,gBAAgB;gBAC3B,MAAM,EAAE,aAAa;aACtB;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACvB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/meta/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../build/cjs/meta.js"
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@wix/auto_sdk_groups_membership-questions",
+  "version": "1.0.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": [],
+  "sideEffects": false,
+  "main": "./build/cjs/index.js",
+  "types": "./build/es/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/es/index.js",
+      "require": "./build/cjs/index.js",
+      "types": "./build/es/index.d.ts"
+    },
+    "./package.json": "./package.json",
+    "./meta": {
+      "import": "./build/es/meta.js",
+      "require": "./build/cjs/meta.js",
+      "types": "./build/es/meta.d.ts"
+    }
+  },
+  "files": [
+    "build",
+    "meta",
+    "service-plugins"
+  ],
+  "dependencies": {
+    "@wix/sdk-runtime": "^0.3.35",
+    "@wix/sdk-types": "^1.12.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.2"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
+    "test": ":"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "auto-sdk-groups-membership-questions",
+      "groupId": "com.wixpress.public-sdk-dependencies"
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "membershipQuestions",
+      "fqdn": "wix.social_groups.v2.membership_question"
+    }
+  },
+  "falconPackageHash": "0deaf040221bb48e3693e305e4163a350433c14de509323067504756"
+}