@wix/reports 1.0.0

package/type-bundles/meta.bundle.d.ts

@@ -0,0 +1,594 @@
+/**
+ * A Report is an entity defining a UoU complaint with a reason on the site
+ * You can report an entity from a select number of reasons, also providing details for the report
+ */
+interface Report$1 {
+    /**
+     * Report ID.
+     * @readonly
+     */
+    id?: string | null;
+    /** Reported entity name */
+    entityName?: string;
+    /** Reported entity ID */
+    entityId?: string;
+    /**
+     * Identity of who made a report
+     * @readonly
+     */
+    identity?: CommonIdentificationData$1;
+    /** Reason for the report */
+    reason?: Reason$1;
+    /**
+     * Revision number, which increments by 1 each time the Report is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Report was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the Report was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields$1;
+}
+interface CommonIdentificationData$1 extends CommonIdentificationDataIdOneOf$1 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /**
+     * Identity type
+     * @readonly
+     */
+    identityType?: IdentityType$1;
+}
+/** @oneof */
+interface CommonIdentificationDataIdOneOf$1 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+}
+declare enum IdentityType$1 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface Reason$1 {
+    /** Type of reason selected for the report */
+    reasonType?: Type$1;
+    /** Optional details provided alongside the report */
+    details?: string | null;
+}
+declare enum Type$1 {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    OTHER = "OTHER",
+    SPAM = "SPAM",
+    NUDITY_OR_SEXUAL_HARASSMENT = "NUDITY_OR_SEXUAL_HARASSMENT",
+    HATE_SPEECH_OR_SYMBOLS = "HATE_SPEECH_OR_SYMBOLS",
+    FALSE_INFORMATION = "FALSE_INFORMATION",
+    COMMUNITY_GUIDELINES_VIOLATION = "COMMUNITY_GUIDELINES_VIOLATION",
+    VIOLENCE = "VIOLENCE",
+    SUICIDE_OR_SELF_INJURY = "SUICIDE_OR_SELF_INJURY",
+    UNAUTHORIZED_SALES = "UNAUTHORIZED_SALES",
+    EATING_DISORDER = "EATING_DISORDER",
+    INVOLVES_A_CHILD = "INVOLVES_A_CHILD",
+    TERRORISM = "TERRORISM",
+    DRUGS = "DRUGS",
+    UNLAWFUL = "UNLAWFUL",
+    EXPOSING_IDENTIFYING_INFO = "EXPOSING_IDENTIFYING_INFO"
+}
+interface ExtendedFields$1 {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface CreateReportRequest$1 {
+    /** Report to be created. */
+    report: Report$1;
+}
+interface CreateReportResponse$1 {
+    /** The created Report. */
+    report?: Report$1;
+}
+interface GetReportRequest$1 {
+    /** ID of the Report to retrieve. */
+    reportId: string;
+}
+interface GetReportResponse$1 {
+    /** The requested Report. */
+    report?: Report$1;
+}
+interface UpdateReportRequest$1 {
+    /** Report to be updated, may be partial. */
+    report: Report$1;
+}
+interface UpdateReportResponse$1 {
+    /** Updated Report. */
+    report?: Report$1;
+}
+interface DeleteReportRequest$1 {
+    /** Id of the Report to delete. */
+    reportId: string;
+}
+interface DeleteReportResponse$1 {
+}
+interface UpsertReportRequest$1 {
+    /** Report to be upserted. */
+    report?: Report$1;
+}
+interface UpsertReportResponse$1 {
+    /** Updated or created Report. */
+    report?: Report$1;
+}
+interface BulkDeleteReportsByFilterRequest$1 {
+    /** Filter for which reports to delete */
+    filter: Record<string, any> | null;
+}
+interface BulkDeleteReportsByFilterResponse$1 {
+    /** Reference to async job ID */
+    jobId?: string;
+}
+interface CountReportsByReasonTypesRequest$1 {
+    /** Entity name */
+    entityName: string;
+    /** ID of the entity. */
+    entityId: string;
+}
+interface CountReportsByReasonTypesResponse$1 {
+    /** The list of entity reports grouped by report reason. */
+    reasonTypeCount?: ReasonTypeCount$1[];
+}
+interface ReasonTypeCount$1 {
+    /** Type of reason selected for the report */
+    reasonType?: Type$1;
+    /** Report count */
+    count?: number;
+}
+interface QueryReportsRequest$1 {
+    /** WQL expression. */
+    query?: CursorQuery$1;
+}
+interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
+    /** Cursor paging options */
+    cursorPaging?: CursorPaging$1;
+    /** Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information. */
+    filter?: Record<string, any> | null;
+    /** Sorting options */
+    sort?: Sorting$1[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf$1 {
+    /** Cursor paging options */
+    cursorPaging?: CursorPaging$1;
+}
+interface Sorting$1 {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder$1;
+}
+declare enum SortOrder$1 {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface CursorPaging$1 {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     */
+    cursor?: string | null;
+}
+interface QueryReportsResponse$1 {
+    /** List of Reports. */
+    reports?: Report$1[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata$1;
+}
+interface CursorPagingMetadata$1 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors$1;
+    /** Whether there are more pages to retrieve following the current page. */
+    hasNext?: boolean | null;
+}
+interface Cursors$1 {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface UpdateExtendedFieldsRequest$1 {
+    /** ID of the entity to update. */
+    id: string;
+    /** Identifier for the app whose extended fields are being updated. */
+    namespace: string;
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+interface UpdateExtendedFieldsResponse$1 {
+    /** Updated Report. */
+    report?: Report$1;
+}
+interface CommonIdentificationDataNonNullableFields$1 {
+    anonymousVisitorId: string;
+    memberId: string;
+    wixUserId: string;
+    appId: string;
+    identityType: IdentityType$1;
+}
+interface ReasonNonNullableFields$1 {
+    reasonType: Type$1;
+}
+interface ReportNonNullableFields$1 {
+    entityName: string;
+    entityId: string;
+    identity?: CommonIdentificationDataNonNullableFields$1;
+    reason?: ReasonNonNullableFields$1;
+}
+interface CreateReportResponseNonNullableFields$1 {
+    report?: ReportNonNullableFields$1;
+}
+interface GetReportResponseNonNullableFields$1 {
+    report?: ReportNonNullableFields$1;
+}
+interface UpdateReportResponseNonNullableFields$1 {
+    report?: ReportNonNullableFields$1;
+}
+interface UpsertReportResponseNonNullableFields$1 {
+    report?: ReportNonNullableFields$1;
+}
+interface BulkDeleteReportsByFilterResponseNonNullableFields$1 {
+    jobId: string;
+}
+interface ReasonTypeCountNonNullableFields$1 {
+    reasonType: Type$1;
+    count: number;
+}
+interface CountReportsByReasonTypesResponseNonNullableFields$1 {
+    reasonTypeCount: ReasonTypeCountNonNullableFields$1[];
+}
+interface QueryReportsResponseNonNullableFields$1 {
+    reports: ReportNonNullableFields$1[];
+}
+interface UpdateExtendedFieldsResponseNonNullableFields$1 {
+    report?: ReportNonNullableFields$1;
+}
+
+/**
+ * A Report is an entity defining a UoU complaint with a reason on the site
+ * You can report an entity from a select number of reasons, also providing details for the report
+ */
+interface Report {
+    /**
+     * Report ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Reported entity name */
+    entityName?: string;
+    /** Reported entity ID */
+    entityId?: string;
+    /**
+     * Identity of who made a report
+     * @readonly
+     */
+    identity?: CommonIdentificationData;
+    /** Reason for the report */
+    reason?: Reason;
+    /**
+     * Revision number, which increments by 1 each time the Report is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Report was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Report was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+}
+interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /**
+     * Identity type
+     * @readonly
+     */
+    identityType?: IdentityType;
+}
+/** @oneof */
+interface CommonIdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+}
+declare enum IdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface Reason {
+    /** Type of reason selected for the report */
+    reasonType?: Type;
+    /** Optional details provided alongside the report */
+    details?: string | null;
+}
+declare enum Type {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    OTHER = "OTHER",
+    SPAM = "SPAM",
+    NUDITY_OR_SEXUAL_HARASSMENT = "NUDITY_OR_SEXUAL_HARASSMENT",
+    HATE_SPEECH_OR_SYMBOLS = "HATE_SPEECH_OR_SYMBOLS",
+    FALSE_INFORMATION = "FALSE_INFORMATION",
+    COMMUNITY_GUIDELINES_VIOLATION = "COMMUNITY_GUIDELINES_VIOLATION",
+    VIOLENCE = "VIOLENCE",
+    SUICIDE_OR_SELF_INJURY = "SUICIDE_OR_SELF_INJURY",
+    UNAUTHORIZED_SALES = "UNAUTHORIZED_SALES",
+    EATING_DISORDER = "EATING_DISORDER",
+    INVOLVES_A_CHILD = "INVOLVES_A_CHILD",
+    TERRORISM = "TERRORISM",
+    DRUGS = "DRUGS",
+    UNLAWFUL = "UNLAWFUL",
+    EXPOSING_IDENTIFYING_INFO = "EXPOSING_IDENTIFYING_INFO"
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface CreateReportRequest {
+    /** Report to be created. */
+    report: Report;
+}
+interface CreateReportResponse {
+    /** The created Report. */
+    report?: Report;
+}
+interface GetReportRequest {
+    /** ID of the Report to retrieve. */
+    reportId: string;
+}
+interface GetReportResponse {
+    /** The requested Report. */
+    report?: Report;
+}
+interface UpdateReportRequest {
+    /** Report to be updated, may be partial. */
+    report: Report;
+}
+interface UpdateReportResponse {
+    /** Updated Report. */
+    report?: Report;
+}
+interface DeleteReportRequest {
+    /** Id of the Report to delete. */
+    reportId: string;
+}
+interface DeleteReportResponse {
+}
+interface UpsertReportRequest {
+    /** Report to be upserted. */
+    report?: Report;
+}
+interface UpsertReportResponse {
+    /** Updated or created Report. */
+    report?: Report;
+}
+interface BulkDeleteReportsByFilterRequest {
+    /** Filter for which reports to delete */
+    filter: Record<string, any> | null;
+}
+interface BulkDeleteReportsByFilterResponse {
+    /** Reference to async job ID */
+    jobId?: string;
+}
+interface CountReportsByReasonTypesRequest {
+    /** Entity name */
+    entityName: string;
+    /** ID of the entity. */
+    entityId: string;
+}
+interface CountReportsByReasonTypesResponse {
+    /** The list of entity reports grouped by report reason. */
+    reasonTypeCount?: ReasonTypeCount[];
+}
+interface ReasonTypeCount {
+    /** Type of reason selected for the report */
+    reasonType?: Type;
+    /** Report count */
+    count?: number;
+}
+interface QueryReportsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor paging options */
+    cursorPaging?: CursorPaging;
+    /** Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information. */
+    filter?: Record<string, any> | null;
+    /** Sorting options */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor paging options */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     */
+    cursor?: string | null;
+}
+interface QueryReportsResponse {
+    /** List of Reports. */
+    reports?: Report[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /** Whether there are more pages to retrieve following the current page. */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface UpdateExtendedFieldsRequest {
+    /** ID of the entity to update. */
+    _id: string;
+    /** Identifier for the app whose extended fields are being updated. */
+    namespace: string;
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+interface UpdateExtendedFieldsResponse {
+    /** Updated Report. */
+    report?: Report;
+}
+interface CommonIdentificationDataNonNullableFields {
+    anonymousVisitorId: string;
+    memberId: string;
+    wixUserId: string;
+    appId: string;
+    identityType: IdentityType;
+}
+interface ReasonNonNullableFields {
+    reasonType: Type;
+}
+interface ReportNonNullableFields {
+    entityName: string;
+    entityId: string;
+    identity?: CommonIdentificationDataNonNullableFields;
+    reason?: ReasonNonNullableFields;
+}
+interface CreateReportResponseNonNullableFields {
+    report?: ReportNonNullableFields;
+}
+interface GetReportResponseNonNullableFields {
+    report?: ReportNonNullableFields;
+}
+interface UpdateReportResponseNonNullableFields {
+    report?: ReportNonNullableFields;
+}
+interface UpsertReportResponseNonNullableFields {
+    report?: ReportNonNullableFields;
+}
+interface BulkDeleteReportsByFilterResponseNonNullableFields {
+    jobId: string;
+}
+interface ReasonTypeCountNonNullableFields {
+    reasonType: Type;
+    count: number;
+}
+interface CountReportsByReasonTypesResponseNonNullableFields {
+    reasonTypeCount: ReasonTypeCountNonNullableFields[];
+}
+interface QueryReportsResponseNonNullableFields {
+    reports: ReportNonNullableFields[];
+}
+interface UpdateExtendedFieldsResponseNonNullableFields {
+    report?: ReportNonNullableFields;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createReport(): __PublicMethodMetaInfo<'POST', {}, CreateReportRequest, CreateReportRequest$1, CreateReportResponse & CreateReportResponseNonNullableFields, CreateReportResponse$1 & CreateReportResponseNonNullableFields$1>;
+declare function getReport(): __PublicMethodMetaInfo<'GET', {
+    reportId: string;
+}, GetReportRequest, GetReportRequest$1, GetReportResponse & GetReportResponseNonNullableFields, GetReportResponse$1 & GetReportResponseNonNullableFields$1>;
+declare function updateReport(): __PublicMethodMetaInfo<'PATCH', {
+    reportId: string;
+}, UpdateReportRequest, UpdateReportRequest$1, UpdateReportResponse & UpdateReportResponseNonNullableFields, UpdateReportResponse$1 & UpdateReportResponseNonNullableFields$1>;
+declare function deleteReport(): __PublicMethodMetaInfo<'DELETE', {
+    reportId: string;
+}, DeleteReportRequest, DeleteReportRequest$1, DeleteReportResponse, DeleteReportResponse$1>;
+declare function upsertReport(): __PublicMethodMetaInfo<'POST', {
+    reportEntityName: string;
+    reportEntityId: string;
+}, UpsertReportRequest, UpsertReportRequest$1, UpsertReportResponse & UpsertReportResponseNonNullableFields, UpsertReportResponse$1 & UpsertReportResponseNonNullableFields$1>;
+declare function bulkDeleteReportsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteReportsByFilterRequest, BulkDeleteReportsByFilterRequest$1, BulkDeleteReportsByFilterResponse & BulkDeleteReportsByFilterResponseNonNullableFields, BulkDeleteReportsByFilterResponse$1 & BulkDeleteReportsByFilterResponseNonNullableFields$1>;
+declare function countReportsByReasonTypes(): __PublicMethodMetaInfo<'POST', {}, CountReportsByReasonTypesRequest, CountReportsByReasonTypesRequest$1, CountReportsByReasonTypesResponse & CountReportsByReasonTypesResponseNonNullableFields, CountReportsByReasonTypesResponse$1 & CountReportsByReasonTypesResponseNonNullableFields$1>;
+declare function queryReports(): __PublicMethodMetaInfo<'GET', {}, QueryReportsRequest, QueryReportsRequest$1, QueryReportsResponse & QueryReportsResponseNonNullableFields, QueryReportsResponse$1 & QueryReportsResponseNonNullableFields$1>;
+declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, UpdateExtendedFieldsRequest, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields, UpdateExtendedFieldsResponse$1 & UpdateExtendedFieldsResponseNonNullableFields$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_bulkDeleteReportsByFilter: typeof bulkDeleteReportsByFilter;
+declare const meta_countReportsByReasonTypes: typeof countReportsByReasonTypes;
+declare const meta_createReport: typeof createReport;
+declare const meta_deleteReport: typeof deleteReport;
+declare const meta_getReport: typeof getReport;
+declare const meta_queryReports: typeof queryReports;
+declare const meta_updateExtendedFields: typeof updateExtendedFields;
+declare const meta_updateReport: typeof updateReport;
+declare const meta_upsertReport: typeof upsertReport;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkDeleteReportsByFilter as bulkDeleteReportsByFilter, meta_countReportsByReasonTypes as countReportsByReasonTypes, meta_createReport as createReport, meta_deleteReport as deleteReport, meta_getReport as getReport, meta_queryReports as queryReports, meta_updateExtendedFields as updateExtendedFields, meta_updateReport as updateReport, meta_upsertReport as upsertReport };
+}
+
+export { meta as reports };