/** ReviewRequest is the main entity of ReviewRequests */ interface ReviewRequest$1 extends ReviewRequestStatusOptionsOneOf$1 { /** Options for sent status */ sentOptions?: SentOptions$1; /** Options for failed status */ failedOptions?: FailedOptions$1; /** * Review request ID. * @readonly */ id?: string | null; /** * Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision. * @readonly */ revision?: string | null; /** * Represents the time this review request was created. * @readonly */ createdDate?: Date | null; /** * Represents the time this review request was last updated. * @readonly */ updatedDate?: Date | null; /** Represents the time this review request to be sent. */ sendDate?: Date | null; /** Namespace of app integrated with reviews. */ namespace?: string; /** Details the order for which the review request is made. */ order?: Order$1; /** List of items relevant to the review request. */ items?: Item$1[]; /** Recipient of review request. */ recipient?: Recipient$1; /** Indicates notification channel of review request */ communicationChannel?: CommunicationChannel$1; /** * Indicates status of review request. * @readonly */ status?: ReviewRequestStatus$1; /** * The ID of the automation activation. * It is used to track and update the status of the review request. */ automationActivationId?: string | null; /** * Requester of the review request * @readonly */ requestedBy?: IdentificationData$1; } /** @oneof */ interface ReviewRequestStatusOptionsOneOf$1 { /** Options for sent status */ sentOptions?: SentOptions$1; /** Options for failed status */ failedOptions?: FailedOptions$1; } interface Order$1 { /** Order ID. */ id?: string; /** * Order number. * @readonly */ number?: string | null; } /** Item to review */ interface Item$1 { /** * ID of the item within its catalog, corresponding to: * + `product.id` for [Stores](https://dev.wix.com/docs/rest/business-solutions/stores/about-wix-stores). */ catalogItemId?: string; /** ID of the review created for this item by the review request recipient. */ reviewId?: string | null; } /** Entity for which review request was created */ interface Recipient$1 { /** Contact id of recipient */ contactId?: string; } declare enum CommunicationChannel$1 { UNKNOWN_COMMUNICATION_CHANNEL = "UNKNOWN_COMMUNICATION_CHANNEL", EMAIL = "EMAIL" } declare enum ReviewRequestStatus$1 { /** Indicates unknown status of review request. */ UNKNOWN_REVIEW_REQUEST_STATUS = "UNKNOWN_REVIEW_REQUEST_STATUS", /** Indicates review request was scheduled. */ SCHEDULED = "SCHEDULED", /** Indicates review request was canceled. */ CANCELED = "CANCELED", /** Indicates review request failed. */ FAILED = "FAILED", /** Indicates review request was sent. */ SENT = "SENT" } interface SentOptions$1 { /** Indicates if the review request was opened by the recipient. */ opened?: boolean; } interface FailedOptions$1 { /** Reason for review request failure. */ reason?: FailureReason$1; /** Error message for review request failure. */ message?: string | null; } declare enum FailureReason$1 { /** Unknown reason for review request failure. */ UNKNOWN_FAILURE_REASON = "UNKNOWN_FAILURE_REASON", /** Review request failed due to failure in activation flow. */ ACTIVATION_FAILED = "ACTIVATION_FAILED", /** Email bounced when sent to a recipient. */ BOUNCED = "BOUNCED", /** Review request failed due to inactive subscription. */ SUBSCRIPTION_INACTIVE = "SUBSCRIPTION_INACTIVE" } interface IdentificationData$1 extends IdentificationDataIdOneOf$1 { /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app.s */ appId?: string; /** * Identity type * @readonly */ identityType?: IdentityType$1; } /** @oneof */ interface IdentificationDataIdOneOf$1 { /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app.s */ appId?: string; } declare enum IdentityType$1 { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } interface CreateReviewRequestRequest$1 { /** ReviewRequest to be created */ reviewRequest: ReviewRequest$1; } interface CreateReviewRequestResponse$1 { /** The created ReviewRequest */ reviewRequest?: ReviewRequest$1; } interface GetReviewRequestRequest$1 { /** Id of the ReviewRequest to retrieve */ reviewRequestId: string; } interface GetReviewRequestResponse$1 { /** The retrieved ReviewRequest */ reviewRequest?: ReviewRequest$1; } interface DeleteReviewRequestRequest$1 { /** Id of the ReviewRequest to delete */ reviewRequestId: string; } interface DeleteReviewRequestResponse$1 { } interface QueryReviewRequestsRequest$1 { /** WQL expression */ query: CursorQuery$1; } interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging$1; /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; /** * Sort object in the following format: * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` */ sort?: Sorting$1[]; } /** @oneof */ interface CursorQueryPagingMethodOneOf$1 { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ 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. * Not relevant for the first request. */ cursor?: string | null; } interface QueryReviewRequestsResponse$1 { /** The retrieved ReviewRequests */ reviewRequests?: ReviewRequest$1[]; /** Paging metadata */ pagingMetadata?: CursorPagingMetadata$1; } /** This is the preferred message for cursor-paging enabled services */ 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. * * + `true`: Another page of results can be retrieved. * + `false`: This is the last 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 CountReviewRequestsByFilterRequest$1 { /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; } interface CountReviewRequestsByFilterResponse$1 { /** Number of review requests that meet the specified criteria. */ count?: number; } interface BulkCancelReviewRequestsByFilterRequest$1 { /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; } interface BulkCancelReviewRequestsByFilterResponse$1 { /** Bulk job ID. The job's status can be retrieved with Get Bulk Job or List Bulk Jobs. */ jobId?: string; } interface SentOptionsNonNullableFields$1 { opened: boolean; } interface FailedOptionsNonNullableFields$1 { reason: FailureReason$1; } interface OrderNonNullableFields$1 { id: string; } interface ItemNonNullableFields$1 { catalogItemId: string; } interface RecipientNonNullableFields$1 { contactId: string; } interface IdentificationDataNonNullableFields$1 { anonymousVisitorId: string; memberId: string; wixUserId: string; appId: string; identityType: IdentityType$1; } interface ReviewRequestNonNullableFields$1 { sentOptions?: SentOptionsNonNullableFields$1; failedOptions?: FailedOptionsNonNullableFields$1; namespace: string; order?: OrderNonNullableFields$1; items: ItemNonNullableFields$1[]; recipient?: RecipientNonNullableFields$1; communicationChannel: CommunicationChannel$1; status: ReviewRequestStatus$1; requestedBy?: IdentificationDataNonNullableFields$1; } interface CreateReviewRequestResponseNonNullableFields$1 { reviewRequest?: ReviewRequestNonNullableFields$1; } interface GetReviewRequestResponseNonNullableFields$1 { reviewRequest?: ReviewRequestNonNullableFields$1; } interface QueryReviewRequestsResponseNonNullableFields$1 { reviewRequests: ReviewRequestNonNullableFields$1[]; } interface CountReviewRequestsByFilterResponseNonNullableFields$1 { count: number; } interface BulkCancelReviewRequestsByFilterResponseNonNullableFields$1 { jobId: string; } /** ReviewRequest is the main entity of ReviewRequests */ interface ReviewRequest extends ReviewRequestStatusOptionsOneOf { /** Options for sent status */ sentOptions?: SentOptions; /** Options for failed status */ failedOptions?: FailedOptions; /** * Review request ID. * @readonly */ _id?: string | null; /** * Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision. * @readonly */ revision?: string | null; /** * Represents the time this review request was created. * @readonly */ _createdDate?: Date | null; /** * Represents the time this review request was last updated. * @readonly */ _updatedDate?: Date | null; /** Represents the time this review request to be sent. */ sendDate?: Date | null; /** Namespace of app integrated with reviews. */ namespace?: string; /** Details the order for which the review request is made. */ order?: Order; /** List of items relevant to the review request. */ items?: Item[]; /** Recipient of review request. */ recipient?: Recipient; /** Indicates notification channel of review request */ communicationChannel?: CommunicationChannel; /** * Indicates status of review request. * @readonly */ status?: ReviewRequestStatus; /** * The ID of the automation activation. * It is used to track and update the status of the review request. */ automationActivationId?: string | null; /** * Requester of the review request * @readonly */ requestedBy?: IdentificationData; } /** @oneof */ interface ReviewRequestStatusOptionsOneOf { /** Options for sent status */ sentOptions?: SentOptions; /** Options for failed status */ failedOptions?: FailedOptions; } interface Order { /** Order ID. */ _id?: string; /** * Order number. * @readonly */ number?: string | null; } /** Item to review */ interface Item { /** * ID of the item within its catalog, corresponding to: * + `product.id` for [Stores](https://dev.wix.com/docs/rest/business-solutions/stores/about-wix-stores). */ catalogItemId?: string; /** ID of the review created for this item by the review request recipient. */ reviewId?: string | null; } /** Entity for which review request was created */ interface Recipient { /** Contact id of recipient */ contactId?: string; } declare enum CommunicationChannel { UNKNOWN_COMMUNICATION_CHANNEL = "UNKNOWN_COMMUNICATION_CHANNEL", EMAIL = "EMAIL" } declare enum ReviewRequestStatus { /** Indicates unknown status of review request. */ UNKNOWN_REVIEW_REQUEST_STATUS = "UNKNOWN_REVIEW_REQUEST_STATUS", /** Indicates review request was scheduled. */ SCHEDULED = "SCHEDULED", /** Indicates review request was canceled. */ CANCELED = "CANCELED", /** Indicates review request failed. */ FAILED = "FAILED", /** Indicates review request was sent. */ SENT = "SENT" } interface SentOptions { /** Indicates if the review request was opened by the recipient. */ opened?: boolean; } interface FailedOptions { /** Reason for review request failure. */ reason?: FailureReason; /** Error message for review request failure. */ message?: string | null; } declare enum FailureReason { /** Unknown reason for review request failure. */ UNKNOWN_FAILURE_REASON = "UNKNOWN_FAILURE_REASON", /** Review request failed due to failure in activation flow. */ ACTIVATION_FAILED = "ACTIVATION_FAILED", /** Email bounced when sent to a recipient. */ BOUNCED = "BOUNCED", /** Review request failed due to inactive subscription. */ SUBSCRIPTION_INACTIVE = "SUBSCRIPTION_INACTIVE" } interface IdentificationData extends IdentificationDataIdOneOf { /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app.s */ appId?: string; /** * Identity type * @readonly */ identityType?: IdentityType; } /** @oneof */ interface IdentificationDataIdOneOf { /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app.s */ appId?: string; } declare enum IdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } interface CreateReviewRequestRequest { /** ReviewRequest to be created */ reviewRequest: ReviewRequest; } interface CreateReviewRequestResponse { /** The created ReviewRequest */ reviewRequest?: ReviewRequest; } interface GetReviewRequestRequest { /** Id of the ReviewRequest to retrieve */ reviewRequestId: string; } interface GetReviewRequestResponse { /** The retrieved ReviewRequest */ reviewRequest?: ReviewRequest; } interface DeleteReviewRequestRequest { /** Id of the ReviewRequest to delete */ reviewRequestId: string; } interface DeleteReviewRequestResponse { } interface QueryReviewRequestsRequest { /** WQL expression */ query: CursorQuery; } interface CursorQuery extends CursorQueryPagingMethodOneOf { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; /** * Sort object in the following format: * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` */ sort?: Sorting[]; } /** @oneof */ interface CursorQueryPagingMethodOneOf { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ 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. * Not relevant for the first request. */ cursor?: string | null; } interface QueryReviewRequestsResponse { /** The retrieved ReviewRequests */ reviewRequests?: ReviewRequest[]; /** Paging metadata */ pagingMetadata?: CursorPagingMetadata; } /** This is the preferred message for cursor-paging enabled services */ 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. * * + `true`: Another page of results can be retrieved. * + `false`: This is the last 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 CountReviewRequestsByFilterRequest { /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; } interface CountReviewRequestsByFilterResponse { /** Number of review requests that meet the specified criteria. */ count?: number; } interface BulkCancelReviewRequestsByFilterRequest { /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; } interface BulkCancelReviewRequestsByFilterResponse { /** Bulk job ID. The job's status can be retrieved with Get Bulk Job or List Bulk Jobs. */ jobId?: string; } interface SentOptionsNonNullableFields { opened: boolean; } interface FailedOptionsNonNullableFields { reason: FailureReason; } interface OrderNonNullableFields { _id: string; } interface ItemNonNullableFields { catalogItemId: string; } interface RecipientNonNullableFields { contactId: string; } interface IdentificationDataNonNullableFields { anonymousVisitorId: string; memberId: string; wixUserId: string; appId: string; identityType: IdentityType; } interface ReviewRequestNonNullableFields { sentOptions?: SentOptionsNonNullableFields; failedOptions?: FailedOptionsNonNullableFields; namespace: string; order?: OrderNonNullableFields; items: ItemNonNullableFields[]; recipient?: RecipientNonNullableFields; communicationChannel: CommunicationChannel; status: ReviewRequestStatus; requestedBy?: IdentificationDataNonNullableFields; } interface CreateReviewRequestResponseNonNullableFields { reviewRequest?: ReviewRequestNonNullableFields; } interface GetReviewRequestResponseNonNullableFields { reviewRequest?: ReviewRequestNonNullableFields; } interface QueryReviewRequestsResponseNonNullableFields { reviewRequests: ReviewRequestNonNullableFields[]; } interface CountReviewRequestsByFilterResponseNonNullableFields { count: number; } interface BulkCancelReviewRequestsByFilterResponseNonNullableFields { jobId: string; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createReviewRequest(): __PublicMethodMetaInfo<'POST', {}, CreateReviewRequestRequest, CreateReviewRequestRequest$1, CreateReviewRequestResponse & CreateReviewRequestResponseNonNullableFields, CreateReviewRequestResponse$1 & CreateReviewRequestResponseNonNullableFields$1>; declare function getReviewRequest(): __PublicMethodMetaInfo<'GET', { reviewRequestId: string; }, GetReviewRequestRequest, GetReviewRequestRequest$1, GetReviewRequestResponse & GetReviewRequestResponseNonNullableFields, GetReviewRequestResponse$1 & GetReviewRequestResponseNonNullableFields$1>; declare function deleteReviewRequest(): __PublicMethodMetaInfo<'DELETE', { reviewRequestId: string; }, DeleteReviewRequestRequest, DeleteReviewRequestRequest$1, DeleteReviewRequestResponse, DeleteReviewRequestResponse$1>; declare function queryReviewRequests(): __PublicMethodMetaInfo<'POST', {}, QueryReviewRequestsRequest, QueryReviewRequestsRequest$1, QueryReviewRequestsResponse & QueryReviewRequestsResponseNonNullableFields, QueryReviewRequestsResponse$1 & QueryReviewRequestsResponseNonNullableFields$1>; declare function countReviewRequestsByFilter(): __PublicMethodMetaInfo<'POST', {}, CountReviewRequestsByFilterRequest, CountReviewRequestsByFilterRequest$1, CountReviewRequestsByFilterResponse & CountReviewRequestsByFilterResponseNonNullableFields, CountReviewRequestsByFilterResponse$1 & CountReviewRequestsByFilterResponseNonNullableFields$1>; declare function bulkCancelReviewRequestsByFilter(): __PublicMethodMetaInfo<'PUT', {}, BulkCancelReviewRequestsByFilterRequest, BulkCancelReviewRequestsByFilterRequest$1, BulkCancelReviewRequestsByFilterResponse & BulkCancelReviewRequestsByFilterResponseNonNullableFields, BulkCancelReviewRequestsByFilterResponse$1 & BulkCancelReviewRequestsByFilterResponseNonNullableFields$1>; type meta___PublicMethodMetaInfo = __PublicMethodMetaInfo; declare const meta_bulkCancelReviewRequestsByFilter: typeof bulkCancelReviewRequestsByFilter; declare const meta_countReviewRequestsByFilter: typeof countReviewRequestsByFilter; declare const meta_createReviewRequest: typeof createReviewRequest; declare const meta_deleteReviewRequest: typeof deleteReviewRequest; declare const meta_getReviewRequest: typeof getReviewRequest; declare const meta_queryReviewRequests: typeof queryReviewRequests; declare namespace meta { export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkCancelReviewRequestsByFilter as bulkCancelReviewRequestsByFilter, meta_countReviewRequestsByFilter as countReviewRequestsByFilter, meta_createReviewRequest as createReviewRequest, meta_deleteReviewRequest as deleteReviewRequest, meta_getReviewRequest as getReviewRequest, meta_queryReviewRequests as queryReviewRequests }; } export { meta as reviews };