@wix/payments 1.0.5 → 1.0.7

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

@@ -1,3 +1,324 @@
+interface OnboardingAvailability$1 {
+    /**
+     * ID of this entity
+     * @readonly
+     */
+    id?: string;
+    /** Information about CBD specific flow. Will have DECLINED status if user is not in United States */
+    cbdFlow?: CbdFlow$1;
+    /** Information about all restricted goods user might sell. */
+    restrictedGoodsFlow?: RestrictedGoodsFlow$1;
+    /** Information about services Wix Partner sells. */
+    partnerFlow?: PartnerFlow$1;
+    /**
+     * True, only if Wix Payments available to user due to the way account was created. False otherwise.
+     * @readonly
+     */
+    wixPaymentsAvailable?: boolean;
+}
+interface CbdFlow$1 {
+    /**
+     * Current status of CBD flow.
+     * DECLINED - User does not sell CBD (or at least we do not know about it). Any payment service provider can be connected.
+     * POSSIBLE - User possibly sells CBD and we should ask for confirmation. User still can connect Wix Payments.
+     * CONFIRMED - User confirmed to sell CBD and now we should ask to complete attestation form. Only CBD providers can be connected. User can't connect Wix Payments.
+     */
+    status?: Status$3;
+    /** Information about completion of attestation form. Include date of signing. */
+    attestationInfo?: AttestationInfo$1;
+}
+declare enum Status$3 {
+    UNDEFINED = "UNDEFINED",
+    DECLINED = "DECLINED",
+    POSSIBLE = "POSSIBLE",
+    CONFIRMED = "CONFIRMED"
+}
+interface AttestationInfo$1 {
+    /**
+     * Date of signing attestation form (only if status is CONFIRMED)
+     * @readonly
+     */
+    attestationFormSignedDate?: Date;
+    /** True, if attestation form was signed. False otherwise. */
+    formSigned?: boolean | null;
+}
+interface RestrictedGoodsFlow$1 {
+    /**
+     * Current status of Restricted Goods flow.
+     * DECLINED - User confirmed that they don't sell any restricted goods. User may connect Wix Payments.
+     * CONFIRMED - User confirmed that they do sell restricted goods. User can't connect Wix Payments.
+     */
+    status?: RestrictedGoodsFlowStatus$1;
+    /** Contains detailed list of which restricted categories user sell. */
+    categories?: RestrictedGoodsCategory$1[];
+}
+declare enum RestrictedGoodsFlowStatus$1 {
+    UNDEFINED = "UNDEFINED",
+    DECLINED = "DECLINED",
+    CONFIRMED = "CONFIRMED"
+}
+declare enum RestrictedGoodsCategory$1 {
+    UNDEFINED = "UNDEFINED",
+    TOBACCO_ALCOHOL = "TOBACCO_ALCOHOL",
+    FIREARMS_WEAPONS = "FIREARMS_WEAPONS",
+    ADULT = "ADULT",
+    MEDICAL = "MEDICAL",
+    FINANCIAL = "FINANCIAL",
+    TRAVEL_AGENCIES = "TRAVEL_AGENCIES",
+    GAMBLING_LOTTERIES_SKILL_GAMES = "GAMBLING_LOTTERIES_SKILL_GAMES",
+    BINARY_OPTIONS_CRYPTOCURRENCIES = "BINARY_OPTIONS_CRYPTOCURRENCIES",
+    MARKETPLACES = "MARKETPLACES",
+    OTHER = "OTHER",
+    CBD = "CBD",
+    TOBACCO_E_CIGARETTES = "TOBACCO_E_CIGARETTES",
+    ALCOHOL = "ALCOHOL",
+    NUTRACEUTICALS = "NUTRACEUTICALS"
+}
+interface PartnerFlow$1 {
+    /**
+     * Current status of Partner flow.
+     * DECLINED - User sells only approved services and may connect Wix Payments.
+     * CONFIRMED - User sells not approved services and can't connect Wix Payments.
+     */
+    status?: PartnerFlowStatus$1;
+}
+declare enum PartnerFlowStatus$1 {
+    UNDEFINED = "UNDEFINED",
+    DECLINED = "DECLINED",
+    CONFIRMED = "CONFIRMED"
+}
+interface GetOnboardingAvailabilityRequest$1 {
+}
+interface GetOnboardingAvailabilityResponse$1 {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability$1;
+}
+interface UpdateCbdFlowRequest$1 {
+    /** New state of CBD flow for merchant. */
+    cbdFlow?: CbdFlow$1;
+}
+interface UpdateCbdFlowResponse$1 {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability$1;
+}
+interface UpdateRestrictedGoodsFlowRequest$1 {
+    /** New state of restricted goods flow for merchant. */
+    restrictedGoods?: RestrictedGoodsFlow$1;
+}
+interface UpdateRestrictedGoodsFlowResponse$1 {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability$1;
+}
+interface UpdatePartnerFlowRequest$1 {
+    /** New state of partner flow for merchant. */
+    partnerFlow?: PartnerFlow$1;
+}
+interface UpdatePartnerFlowResponse$1 {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability$1;
+}
+interface CbdFlowNonNullableFields$1 {
+    status: Status$3;
+}
+interface RestrictedGoodsFlowNonNullableFields$1 {
+    status: RestrictedGoodsFlowStatus$1;
+    categories: RestrictedGoodsCategory$1[];
+}
+interface PartnerFlowNonNullableFields$1 {
+    status: PartnerFlowStatus$1;
+}
+interface OnboardingAvailabilityNonNullableFields$1 {
+    id: string;
+    cbdFlow?: CbdFlowNonNullableFields$1;
+    restrictedGoodsFlow?: RestrictedGoodsFlowNonNullableFields$1;
+    partnerFlow?: PartnerFlowNonNullableFields$1;
+    wixPaymentsAvailable: boolean;
+}
+interface GetOnboardingAvailabilityResponseNonNullableFields$1 {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields$1;
+}
+interface UpdateCbdFlowResponseNonNullableFields$1 {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields$1;
+}
+interface UpdateRestrictedGoodsFlowResponseNonNullableFields$1 {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields$1;
+}
+interface UpdatePartnerFlowResponseNonNullableFields$1 {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields$1;
+}
+
+interface OnboardingAvailability {
+    /**
+     * ID of this entity
+     * @readonly
+     */
+    _id?: string;
+    /** Information about CBD specific flow. Will have DECLINED status if user is not in United States */
+    cbdFlow?: CbdFlow;
+    /** Information about all restricted goods user might sell. */
+    restrictedGoodsFlow?: RestrictedGoodsFlow;
+    /** Information about services Wix Partner sells. */
+    partnerFlow?: PartnerFlow;
+    /**
+     * True, only if Wix Payments available to user due to the way account was created. False otherwise.
+     * @readonly
+     */
+    wixPaymentsAvailable?: boolean;
+}
+interface CbdFlow {
+    /**
+     * Current status of CBD flow.
+     * DECLINED - User does not sell CBD (or at least we do not know about it). Any payment service provider can be connected.
+     * POSSIBLE - User possibly sells CBD and we should ask for confirmation. User still can connect Wix Payments.
+     * CONFIRMED - User confirmed to sell CBD and now we should ask to complete attestation form. Only CBD providers can be connected. User can't connect Wix Payments.
+     */
+    status?: Status$2;
+    /** Information about completion of attestation form. Include date of signing. */
+    attestationInfo?: AttestationInfo;
+}
+declare enum Status$2 {
+    UNDEFINED = "UNDEFINED",
+    DECLINED = "DECLINED",
+    POSSIBLE = "POSSIBLE",
+    CONFIRMED = "CONFIRMED"
+}
+interface AttestationInfo {
+    /**
+     * Date of signing attestation form (only if status is CONFIRMED)
+     * @readonly
+     */
+    attestationFormSignedDate?: Date;
+    /** True, if attestation form was signed. False otherwise. */
+    formSigned?: boolean | null;
+}
+interface RestrictedGoodsFlow {
+    /**
+     * Current status of Restricted Goods flow.
+     * DECLINED - User confirmed that they don't sell any restricted goods. User may connect Wix Payments.
+     * CONFIRMED - User confirmed that they do sell restricted goods. User can't connect Wix Payments.
+     */
+    status?: RestrictedGoodsFlowStatus;
+    /** Contains detailed list of which restricted categories user sell. */
+    categories?: RestrictedGoodsCategory[];
+}
+declare enum RestrictedGoodsFlowStatus {
+    UNDEFINED = "UNDEFINED",
+    DECLINED = "DECLINED",
+    CONFIRMED = "CONFIRMED"
+}
+declare enum RestrictedGoodsCategory {
+    UNDEFINED = "UNDEFINED",
+    TOBACCO_ALCOHOL = "TOBACCO_ALCOHOL",
+    FIREARMS_WEAPONS = "FIREARMS_WEAPONS",
+    ADULT = "ADULT",
+    MEDICAL = "MEDICAL",
+    FINANCIAL = "FINANCIAL",
+    TRAVEL_AGENCIES = "TRAVEL_AGENCIES",
+    GAMBLING_LOTTERIES_SKILL_GAMES = "GAMBLING_LOTTERIES_SKILL_GAMES",
+    BINARY_OPTIONS_CRYPTOCURRENCIES = "BINARY_OPTIONS_CRYPTOCURRENCIES",
+    MARKETPLACES = "MARKETPLACES",
+    OTHER = "OTHER",
+    CBD = "CBD",
+    TOBACCO_E_CIGARETTES = "TOBACCO_E_CIGARETTES",
+    ALCOHOL = "ALCOHOL",
+    NUTRACEUTICALS = "NUTRACEUTICALS"
+}
+interface PartnerFlow {
+    /**
+     * Current status of Partner flow.
+     * DECLINED - User sells only approved services and may connect Wix Payments.
+     * CONFIRMED - User sells not approved services and can't connect Wix Payments.
+     */
+    status?: PartnerFlowStatus;
+}
+declare enum PartnerFlowStatus {
+    UNDEFINED = "UNDEFINED",
+    DECLINED = "DECLINED",
+    CONFIRMED = "CONFIRMED"
+}
+interface GetOnboardingAvailabilityRequest {
+}
+interface GetOnboardingAvailabilityResponse {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability;
+}
+interface UpdateCbdFlowRequest {
+    /** New state of CBD flow for merchant. */
+    cbdFlow?: CbdFlow;
+}
+interface UpdateCbdFlowResponse {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability;
+}
+interface UpdateRestrictedGoodsFlowRequest {
+    /** New state of restricted goods flow for merchant. */
+    restrictedGoods?: RestrictedGoodsFlow;
+}
+interface UpdateRestrictedGoodsFlowResponse {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability;
+}
+interface UpdatePartnerFlowRequest {
+    /** New state of partner flow for merchant. */
+    partnerFlow?: PartnerFlow;
+}
+interface UpdatePartnerFlowResponse {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability;
+}
+interface CbdFlowNonNullableFields {
+    status: Status$2;
+}
+interface RestrictedGoodsFlowNonNullableFields {
+    status: RestrictedGoodsFlowStatus;
+    categories: RestrictedGoodsCategory[];
+}
+interface PartnerFlowNonNullableFields {
+    status: PartnerFlowStatus;
+}
+interface OnboardingAvailabilityNonNullableFields {
+    _id: string;
+    cbdFlow?: CbdFlowNonNullableFields;
+    restrictedGoodsFlow?: RestrictedGoodsFlowNonNullableFields;
+    partnerFlow?: PartnerFlowNonNullableFields;
+    wixPaymentsAvailable: boolean;
+}
+interface GetOnboardingAvailabilityResponseNonNullableFields {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
+}
+interface UpdateCbdFlowResponseNonNullableFields {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
+}
+interface UpdateRestrictedGoodsFlowResponseNonNullableFields {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
+}
+interface UpdatePartnerFlowResponseNonNullableFields {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
+}
+
+type __PublicMethodMetaInfo$1<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 getOnboardingAvailability(): __PublicMethodMetaInfo$1<'GET', {}, GetOnboardingAvailabilityRequest, GetOnboardingAvailabilityRequest$1, GetOnboardingAvailabilityResponse & GetOnboardingAvailabilityResponseNonNullableFields, GetOnboardingAvailabilityResponse$1 & GetOnboardingAvailabilityResponseNonNullableFields$1>;
+declare function updateCbdFlow(): __PublicMethodMetaInfo$1<'PATCH', {}, UpdateCbdFlowRequest, UpdateCbdFlowRequest$1, UpdateCbdFlowResponse & UpdateCbdFlowResponseNonNullableFields, UpdateCbdFlowResponse$1 & UpdateCbdFlowResponseNonNullableFields$1>;
+declare function updateRestrictedGoodsFlow(): __PublicMethodMetaInfo$1<'PATCH', {}, UpdateRestrictedGoodsFlowRequest, UpdateRestrictedGoodsFlowRequest$1, UpdateRestrictedGoodsFlowResponse & UpdateRestrictedGoodsFlowResponseNonNullableFields, UpdateRestrictedGoodsFlowResponse$1 & UpdateRestrictedGoodsFlowResponseNonNullableFields$1>;
+declare function updatePartnerFlow(): __PublicMethodMetaInfo$1<'PATCH', {}, UpdatePartnerFlowRequest, UpdatePartnerFlowRequest$1, UpdatePartnerFlowResponse & UpdatePartnerFlowResponseNonNullableFields, UpdatePartnerFlowResponse$1 & UpdatePartnerFlowResponseNonNullableFields$1>;
+
+declare const meta$1_getOnboardingAvailability: typeof getOnboardingAvailability;
+declare const meta$1_updateCbdFlow: typeof updateCbdFlow;
+declare const meta$1_updatePartnerFlow: typeof updatePartnerFlow;
+declare const meta$1_updateRestrictedGoodsFlow: typeof updateRestrictedGoodsFlow;
+declare namespace meta$1 {
+  export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_getOnboardingAvailability as getOnboardingAvailability, meta$1_updateCbdFlow as updateCbdFlow, meta$1_updatePartnerFlow as updatePartnerFlow, meta$1_updateRestrictedGoodsFlow as updateRestrictedGoodsFlow };
+}
+
 /**
  * A refund a record of an attempt of
  * returning funds for a charge from a merchant to a customer to who has made a purchase.
@@ -764,4 +1085,4 @@ declare namespace meta {
   export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createRefund as createRefund, meta_getRefund as getRefund, meta_getRefundability as getRefundability, meta_queryRefunds as queryRefunds, meta_updateExtendedFields as updateExtendedFields };
 }
 
-export { meta as refunds };
+export { meta$1 as onboardingAvailability, meta as refunds };