@wix/auto_sdk_ecom_order-payment-requests 1.0.0

package/build/internal/es/src/ecom-v1-order-payment-request-order-payment-requests.types.d.ts

@@ -0,0 +1,399 @@
+export interface OrderPaymentRequest {
+    /**
+     * Order payment request ID.
+     * @readonly
+     */
+    id?: string | null;
+    /** Additional parameters to identify the source of the order payment request. */
+    source?: Source;
+    /**
+     * status.
+     * @readonly
+     */
+    status?: Status;
+    /** Order ID. */
+    orderId?: string;
+    /**
+     * Order number.
+     * @readonly
+     */
+    orderNumber?: string | null;
+    /**
+     * Amount to collect.
+     * > **Note:** The amount can only be set once.
+     */
+    amount?: Price;
+    /**
+     * Currency code. The value will always match the currency used in the order.
+     * @readonly
+     */
+    currency?: string;
+    /**
+     * Payment gateway order id which is associated with this payment request
+     * @readonly
+     */
+    paymentGatewayOrderId?: string | null;
+    /** Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for. */
+    title?: string;
+    /** Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for. */
+    description?: string | null;
+    /** Image to be displayed to the customer on the payment page. */
+    image?: Image;
+    /** Time and date the order payment request expires. */
+    expirationDate?: Date | null;
+    /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls. */
+    extendedFields?: ExtendedFields;
+    /**
+     * Date and time the OrderPaymentRequest was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the OrderPaymentRequest was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+}
+export interface Source {
+    /** App Def ID that created the order payment request. */
+    appId?: string | null;
+    /** Reference to an ID from an external system, indicating the original source of the order payment request. */
+    externalId?: string;
+}
+export declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    UNPAID = "UNPAID",
+    PAID = "PAID",
+    EXPIRED = "EXPIRED"
+}
+export interface Price {
+    /** Amount. */
+    amount?: string;
+    /**
+     * Amount formatted with currency symbol.
+     * @readonly
+     */
+    formattedAmount?: string;
+}
+export interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+export 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>>;
+}
+/** Triggered when the the order payment request status changes to paid */
+export interface OrderPaymentRequestPaid {
+    /** The order that was updated */
+    orderPaymentRequest?: OrderPaymentRequest;
+}
+/** Triggered when the the order payment request status changes to expired */
+export interface OrderPaymentRequestExpired {
+    /** The order that was updated */
+    orderPaymentRequest?: OrderPaymentRequest;
+}
+export interface CreateOrderPaymentRequestRequest {
+    /** OrderPaymentRequest to be created. */
+    orderPaymentRequest?: OrderPaymentRequest;
+}
+export interface CreateOrderPaymentRequestResponse {
+    /** The created OrderPaymentRequest. */
+    orderPaymentRequest?: OrderPaymentRequest;
+    /** Order payment request URL. */
+    orderPaymentRequestUrl?: string;
+}
+export interface GetOrderPaymentRequestRequest {
+    /** ID of the OrderPaymentRequest to retrieve. */
+    orderPaymentRequestId: string;
+}
+export interface GetOrderPaymentRequestResponse {
+    /** The requested OrderPaymentRequest. */
+    orderPaymentRequest?: OrderPaymentRequest;
+}
+export interface UpdateOrderPaymentRequestRequest {
+    /** OrderPaymentRequest to be updated, may be partial. */
+    orderPaymentRequest: OrderPaymentRequest;
+}
+export interface UpdateOrderPaymentRequestResponse {
+    /** Updated OrderPaymentRequest. */
+    orderPaymentRequest?: OrderPaymentRequest;
+}
+export interface DeleteOrderPaymentRequestRequest {
+    /** Id of the OrderPaymentRequest to delete. */
+    orderPaymentRequestId: string;
+}
+export interface DeleteOrderPaymentRequestResponse {
+}
+export interface QueryOrderPaymentRequestsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+export 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<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export 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;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export 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;
+}
+export interface QueryOrderPaymentRequestsResponse {
+    /** List of payment requests. */
+    orderPaymentRequests?: OrderPaymentRequest[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export 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;
+}
+export 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;
+}
+export interface GetOrderPaymentRequestURLRequest {
+    /** Order Payment Request ID. */
+    orderPaymentRequestId: string;
+}
+export interface GetOrderPaymentRequestURLResponse {
+    /** Order Payment Request URL. */
+    orderPaymentRequestUrl?: string;
+}
+export 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;
+}
+export interface UpdateExtendedFieldsResponse {
+    /** Updated OrderPaymentRequest. */
+    orderPaymentRequest?: OrderPaymentRequest;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface Empty {
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** 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;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** 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;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface SourceNonNullableFields {
+    externalId: string;
+}
+interface PriceNonNullableFields {
+    amount: string;
+    formattedAmount: string;
+}
+interface ImageNonNullableFields {
+    id: string;
+    height: number;
+    width: number;
+}
+interface OrderPaymentRequestNonNullableFields {
+    source?: SourceNonNullableFields;
+    status: Status;
+    orderId: string;
+    amount?: PriceNonNullableFields;
+    currency: string;
+    title: string;
+    image?: ImageNonNullableFields;
+}
+export interface CreateOrderPaymentRequestResponseNonNullableFields {
+    orderPaymentRequest?: OrderPaymentRequestNonNullableFields;
+    orderPaymentRequestUrl: string;
+}
+export interface GetOrderPaymentRequestResponseNonNullableFields {
+    orderPaymentRequest?: OrderPaymentRequestNonNullableFields;
+}
+export interface UpdateOrderPaymentRequestResponseNonNullableFields {
+    orderPaymentRequest?: OrderPaymentRequestNonNullableFields;
+}
+export interface QueryOrderPaymentRequestsResponseNonNullableFields {
+    orderPaymentRequests: OrderPaymentRequestNonNullableFields[];
+}
+export interface GetOrderPaymentRequestURLResponseNonNullableFields {
+    orderPaymentRequestUrl: string;
+}
+export interface UpdateExtendedFieldsResponseNonNullableFields {
+    orderPaymentRequest?: OrderPaymentRequestNonNullableFields;
+}
+export {};

package/build/internal/es/src/ecom-v1-order-payment-request-order-payment-requests.types.js

@@ -0,0 +1,21 @@
+export var Status;
+(function (Status) {
+    Status["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
+    Status["UNPAID"] = "UNPAID";
+    Status["PAID"] = "PAID";
+    Status["EXPIRED"] = "EXPIRED";
+})(Status || (Status = {}));
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+//# sourceMappingURL=ecom-v1-order-payment-request-order-payment-requests.types.js.map

package/build/internal/es/src/ecom-v1-order-payment-request-order-payment-requests.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecom-v1-order-payment-request-order-payment-requests.types.js","sourceRoot":"","sources":["../../../../src/ecom-v1-order-payment-request-order-payment-requests.types.ts"],"names":[],"mappings":"AAgEA,MAAM,CAAN,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,2BAAiB,CAAA;IACjB,uBAAa,CAAA;IACb,6BAAmB,CAAA;AACrB,CAAC,EALW,MAAM,KAAN,MAAM,QAKjB;AAsID,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAuLD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}