@wix/auto_sdk_payments_payment-acceptance-configurations 1.0.3 → 1.0.5

package/build/internal/meta.d.ts

@@ -0,0 +1,322 @@
+import { C as CreatePaymentAcceptanceConfigurationRequest$1, g as CreatePaymentAcceptanceConfigurationResponse$1, G as GetPaymentAcceptanceConfigurationRequest$1, h as GetPaymentAcceptanceConfigurationResponse$1, i as UpdatePaymentAcceptanceConfigurationRequest$1, j as UpdatePaymentAcceptanceConfigurationResponse$1, D as DeletePaymentAcceptanceConfigurationRequest$1, k as DeletePaymentAcceptanceConfigurationResponse$1, Q as QueryPaymentAcceptanceConfigurationsRequest$1, p as QueryPaymentAcceptanceConfigurationsResponse$1, s as BulkUpdatePaymentAcceptanceConfigurationTagsRequest$1, b as BulkUpdatePaymentAcceptanceConfigurationTagsResponse$1, v as BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest$1, d as BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse$1 } from './payments-payment-acceptance-configurations-v1-payment-acceptance-configuration-payment-acceptance-configurations.universal-jqObRsin.js';
+
+/** PaymentAcceptanceConfiguration */
+interface PaymentAcceptanceConfiguration {
+    /**
+     * id
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    id?: string | null;
+    /**
+     * app_id
+     * @format GUID
+     * @immutable
+     */
+    appId?: string | null;
+    /**
+     * rules
+     * @maxSize 1000
+     */
+    rules?: PaymentAcceptanceRule[];
+    /**
+     * revision
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date when PaymentAcceptanceConfiguration was created
+     * @readonly
+     * @immutable
+     */
+    createdDate?: Date | null;
+    /**
+     * Date when PaymentAcceptanceConfiguration was updated
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+interface PaymentAcceptanceRule {
+    /**
+     * payment_method_type_id
+     * @format GUID
+     */
+    paymentMethodTypeId?: string;
+    /**
+     * account_connection_id
+     * @format GUID
+     */
+    accountConnectionId?: string;
+    /** merchant_enabled */
+    merchantEnabled?: boolean;
+}
+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>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+interface CreatePaymentAcceptanceConfigurationRequest {
+    /** PaymentAcceptanceConfiguration to be created. */
+    paymentAcceptanceConfiguration: PaymentAcceptanceConfiguration;
+}
+interface CreatePaymentAcceptanceConfigurationResponse {
+    /** The created PaymentAcceptanceConfiguration. */
+    paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
+}
+interface GetPaymentAcceptanceConfigurationRequest {
+    /**
+     * ID of the PaymentAcceptanceConfiguration to retrieve.
+     * @format GUID
+     */
+    paymentAcceptanceConfigurationId: string;
+}
+interface GetPaymentAcceptanceConfigurationResponse {
+    /** The requested PaymentAcceptanceConfiguration. */
+    paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
+}
+interface UpdatePaymentAcceptanceConfigurationRequest {
+    /** PaymentAcceptanceConfiguration to be updated, may be partial. */
+    paymentAcceptanceConfiguration: PaymentAcceptanceConfiguration;
+}
+interface UpdatePaymentAcceptanceConfigurationResponse {
+    /** Updated PaymentAcceptanceConfiguration. */
+    paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
+}
+interface DeletePaymentAcceptanceConfigurationRequest {
+    /**
+     * Id of payment acceptance configuration to delete
+     * @format GUID
+     */
+    paymentAcceptanceConfigurationId: string;
+}
+interface DeletePaymentAcceptanceConfigurationResponse {
+}
+interface QueryPaymentAcceptanceConfigurationsRequest {
+    /** 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<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
+     */
+    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.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    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.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryPaymentAcceptanceConfigurationsResponse {
+    /** List of PaymentAcceptanceConfigurations. */
+    paymentAcceptanceConfigurations?: PaymentAcceptanceConfiguration[];
+    /** 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.
+     *
+     * + `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.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface BulkUpdatePaymentAcceptanceConfigurationTagsRequest {
+    /**
+     * List of NileProtoTagsEntities that their tags will update.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    ids: string[];
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdatePaymentAcceptanceConfigurationTagsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdatePaymentAcceptanceConfigurationTagsResult[];
+    /** Metadata regarding the bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkUpdatePaymentAcceptanceConfigurationTagsResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse {
+    /**
+     * Job ID
+     * @format GUID
+     */
+    jobId?: string;
+}
+
+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 createPaymentAcceptanceConfiguration(): __PublicMethodMetaInfo<'POST', {}, CreatePaymentAcceptanceConfigurationRequest$1, CreatePaymentAcceptanceConfigurationRequest, CreatePaymentAcceptanceConfigurationResponse$1, CreatePaymentAcceptanceConfigurationResponse>;
+declare function getPaymentAcceptanceConfiguration(): __PublicMethodMetaInfo<'GET', {
+    paymentAcceptanceConfigurationId: string;
+}, GetPaymentAcceptanceConfigurationRequest$1, GetPaymentAcceptanceConfigurationRequest, GetPaymentAcceptanceConfigurationResponse$1, GetPaymentAcceptanceConfigurationResponse>;
+declare function updatePaymentAcceptanceConfiguration(): __PublicMethodMetaInfo<'PATCH', {
+    paymentAcceptanceConfigurationId: string;
+}, UpdatePaymentAcceptanceConfigurationRequest$1, UpdatePaymentAcceptanceConfigurationRequest, UpdatePaymentAcceptanceConfigurationResponse$1, UpdatePaymentAcceptanceConfigurationResponse>;
+declare function deletePaymentAcceptanceConfiguration(): __PublicMethodMetaInfo<'DELETE', {
+    paymentAcceptanceConfigurationId: string;
+}, DeletePaymentAcceptanceConfigurationRequest$1, DeletePaymentAcceptanceConfigurationRequest, DeletePaymentAcceptanceConfigurationResponse$1, DeletePaymentAcceptanceConfigurationResponse>;
+declare function queryPaymentAcceptanceConfigurations(): __PublicMethodMetaInfo<'GET', {}, QueryPaymentAcceptanceConfigurationsRequest$1, QueryPaymentAcceptanceConfigurationsRequest, QueryPaymentAcceptanceConfigurationsResponse$1, QueryPaymentAcceptanceConfigurationsResponse>;
+declare function bulkUpdatePaymentAcceptanceConfigurationTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdatePaymentAcceptanceConfigurationTagsRequest$1, BulkUpdatePaymentAcceptanceConfigurationTagsRequest, BulkUpdatePaymentAcceptanceConfigurationTagsResponse$1, BulkUpdatePaymentAcceptanceConfigurationTagsResponse>;
+declare function bulkUpdatePaymentAcceptanceConfigurationTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest$1, BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest, BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse$1, BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse>;
+
+export { type __PublicMethodMetaInfo, bulkUpdatePaymentAcceptanceConfigurationTags, bulkUpdatePaymentAcceptanceConfigurationTagsByFilter, createPaymentAcceptanceConfiguration, deletePaymentAcceptanceConfiguration, getPaymentAcceptanceConfiguration, queryPaymentAcceptanceConfigurations, updatePaymentAcceptanceConfiguration };