stripe 22.2.0 → 22.3.0-alpha.2

package/esm/resources/SharedPayment/GrantedTokens.js

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../StripeResource.js';
+export class GrantedTokenResource extends StripeResource {
+    /**
+     * Retrieves an existing SharedPaymentGrantedToken object
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/shared_payment/granted_tokens/${id}`, params, options);
+    }
+}
+//# sourceMappingURL=GrantedTokens.js.map

package/esm/resources/SharedPayment/GrantedTokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GrantedTokens.js","sourceRoot":"","sources":["../../../src/resources/SharedPayment/GrantedTokens.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAOvD,MAAM,OAAO,oBAAqB,SAAQ,cAAc;IACtD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qCAAqC,EAAE,EAAE,EACzC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}

package/esm/resources/SharedPayment/IssuedTokens.d.ts

@@ -0,0 +1,322 @@
+import { StripeResource } from '../../StripeResource.js';
+import { RequestOptions, Response } from '../../lib.js';
+export declare class IssuedTokenResource extends StripeResource {
+    /**
+     * Retrieves an existing SharedPaymentIssuedToken object
+     */
+    retrieve(id: string, params?: SharedPayment.IssuedTokenRetrieveParams, options?: RequestOptions): Promise<Response<IssuedToken>>;
+    /**
+     * Creates a new SharedPaymentIssuedToken object
+     */
+    create(params: SharedPayment.IssuedTokenCreateParams, options?: RequestOptions): Promise<Response<IssuedToken>>;
+    /**
+     * Revokes a SharedPaymentIssuedToken
+     */
+    revoke(id: string, params?: SharedPayment.IssuedTokenRevokeParams, options?: RequestOptions): Promise<Response<IssuedToken>>;
+}
+export interface IssuedToken {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'shared_payment.issued_token';
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+    /**
+     * Time at which this SharedPaymentIssuedToken was deactivated.
+     */
+    deactivated_at: number | null;
+    /**
+     * The reason why the SharedPaymentIssuedToken has been deactivated.
+     */
+    deactivated_reason: SharedPayment.IssuedToken.DeactivatedReason | null;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * If present, describes the action required to make this `SharedPaymentIssuedToken` usable for payments. Present when the token is in `requires_action` state.
+     */
+    next_action: SharedPayment.IssuedToken.NextAction | null;
+    /**
+     * ID of an existing PaymentMethod.
+     */
+    payment_method: string;
+    /**
+     * If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
+     */
+    return_url?: string | null;
+    /**
+     * Risk details of the SharedPaymentIssuedToken.
+     */
+    risk_details?: SharedPayment.IssuedToken.RiskDetails | null;
+    /**
+     * Seller details of the SharedPaymentIssuedToken, including network_id and external_id.
+     */
+    seller_details: SharedPayment.IssuedToken.SellerDetails | null;
+    /**
+     * Indicates that you intend to save the PaymentMethod of this SharedPaymentToken to a customer later.
+     */
+    setup_future_usage: 'on_session' | null;
+    /**
+     * Metadata about the SharedPaymentIssuedToken.
+     */
+    shared_metadata: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Status of this SharedPaymentIssuedToken, one of `active`, `requires_action`, or `deactivated`.
+     */
+    status: SharedPayment.IssuedToken.Status | null;
+    /**
+     * Usage details of the SharedPaymentIssuedToken
+     */
+    usage_details: SharedPayment.IssuedToken.UsageDetails | null;
+    /**
+     * Usage limits of the SharedPaymentIssuedToken.
+     */
+    usage_limits: SharedPayment.IssuedToken.UsageLimits | null;
+}
+export declare namespace SharedPayment {
+    namespace IssuedToken {
+        type DeactivatedReason = 'consumed' | 'expired' | 'resolved' | 'revoked';
+        interface NextAction {
+            /**
+             * Specifies the type of next action required. Determines which child attribute contains action details.
+             */
+            type: 'use_stripe_sdk';
+            /**
+             * Contains details for handling the next action using Stripe.js, iOS, or Android SDKs. Present when `next_action.type` is `use_stripe_sdk`.
+             */
+            use_stripe_sdk: NextAction.UseStripeSdk | null;
+        }
+        interface RiskDetails {
+            /**
+             * Risk insights for this token, including scores and recommended actions for each risk type.
+             */
+            insights: RiskDetails.Insights;
+        }
+        interface SellerDetails {
+            /**
+             * A unique id within a network that identifies a logical seller. This should usually be the merchant id on the seller platform.
+             */
+            external_id: string;
+            /**
+             * The unique and logical string that identifies the seller platform that this SharedToken is being created for.
+             */
+            network_business_profile: string;
+        }
+        type Status = 'active' | 'deactivated' | 'requires_action';
+        interface UsageDetails {
+            /**
+             * The total amount captured using this SharedPaymentToken.
+             */
+            amount_captured: UsageDetails.AmountCaptured | null;
+        }
+        interface UsageLimits {
+            /**
+             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+             */
+            currency: string;
+            /**
+             * Time at which this SharedPaymentToken expires and can no longer be used to confirm a PaymentIntent.
+             */
+            expires_at: number | null;
+            /**
+             * Max amount that can be captured using this SharedPaymentToken.
+             */
+            max_amount: number;
+            /**
+             * The recurring interval at which the shared payment token's amount usage restrictions reset.
+             */
+            recurring_interval?: UsageLimits.RecurringInterval | null;
+        }
+        namespace NextAction {
+            interface UseStripeSdk {
+                /**
+                 * A base64-encoded string used by Stripe.js and the iOS and Android client SDKs to handle the next action. Its content is subject to change.
+                 */
+                value: string;
+            }
+        }
+        namespace RiskDetails {
+            interface Insights {
+                /**
+                 * Bot risk insight.
+                 */
+                bot?: Insights.Bot | null;
+                /**
+                 * Card issuer decline risk insight.
+                 */
+                card_issuer_decline?: Insights.CardIssuerDecline | null;
+                /**
+                 * Card testing risk insight.
+                 */
+                card_testing?: Insights.CardTesting | null;
+                /**
+                 * Fraudulent dispute risk insight.
+                 */
+                fraudulent_dispute: Insights.FraudulentDispute | null;
+                /**
+                 * Stolen card risk insight.
+                 */
+                stolen_card?: Insights.StolenCard | null;
+            }
+            namespace Insights {
+                interface Bot {
+                    /**
+                     * Recommended action for this insight.
+                     */
+                    recommended_action: string;
+                    /**
+                     * Risk score for this insight.
+                     */
+                    score: number;
+                }
+                interface CardIssuerDecline {
+                    /**
+                     * Recommended action for this insight.
+                     */
+                    recommended_action: string;
+                    /**
+                     * Risk score for this insight.
+                     */
+                    score: number;
+                }
+                interface CardTesting {
+                    /**
+                     * Recommended action for this insight.
+                     */
+                    recommended_action: string;
+                    /**
+                     * Risk score for this insight.
+                     */
+                    score: number;
+                }
+                interface FraudulentDispute {
+                    /**
+                     * Recommended action for this insight.
+                     */
+                    recommended_action: string;
+                    /**
+                     * Risk score for this insight.
+                     */
+                    score: number;
+                }
+                interface StolenCard {
+                    /**
+                     * Recommended action for this insight.
+                     */
+                    recommended_action: string;
+                    /**
+                     * Risk score for this insight.
+                     */
+                    score: number;
+                }
+            }
+        }
+        namespace UsageDetails {
+            interface AmountCaptured {
+                /**
+                 * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+                 */
+                currency: string;
+                /**
+                 * Integer value of the amount in the smallest currency unit.
+                 */
+                value: number;
+            }
+        }
+        namespace UsageLimits {
+            type RecurringInterval = 'month' | 'week' | 'year';
+        }
+    }
+}
+export declare namespace SharedPayment {
+    interface IssuedTokenCreateParams {
+        /**
+         * The PaymentMethod that is going to be shared by the SharedPaymentIssuedToken.
+         */
+        payment_method: string;
+        /**
+         * Seller details of the SharedPaymentIssuedToken, including network_id and external_id.
+         */
+        seller_details: IssuedTokenCreateParams.SellerDetails;
+        /**
+         * Limits on how this SharedPaymentToken can be used.
+         */
+        usage_limits: IssuedTokenCreateParams.UsageLimits;
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+        /**
+         * If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
+         */
+        return_url?: string;
+        /**
+         * Indicates that you intend to save the PaymentMethod of this SharedPaymentToken to a customer later.
+         */
+        setup_future_usage?: 'on_session';
+        /**
+         * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to the SharedPaymentIssuedToken. The values here are visible by default with the party that you share this SharedPaymentIssuedToken with.
+         */
+        shared_metadata?: {
+            [key: string]: string;
+        };
+    }
+    namespace IssuedTokenCreateParams {
+        interface SellerDetails {
+            /**
+             * A unique id within a network that identifies a logical seller, usually this would be the unique merchant id.
+             */
+            external_id?: string;
+            /**
+             * A string that identifies the network that this SharedToken is being created for.
+             */
+            network_business_profile?: string;
+        }
+        interface UsageLimits {
+            /**
+             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+             */
+            currency: string;
+            /**
+             * Time at which this SharedPaymentToken expires and can no longer be used to confirm a PaymentIntent.
+             */
+            expires_at?: number;
+            /**
+             * Max amount that can be captured using this SharedPaymentToken
+             */
+            max_amount: number;
+            /**
+             * The recurring interval at which the shared payment token's amount usage restrictions reset.
+             */
+            recurring_interval?: UsageLimits.RecurringInterval;
+        }
+        namespace UsageLimits {
+            type RecurringInterval = 'month' | 'week' | 'year';
+        }
+    }
+}
+export declare namespace SharedPayment {
+    interface IssuedTokenRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace SharedPayment {
+    interface IssuedTokenRevokeParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}

package/esm/resources/SharedPayment/IssuedTokens.js

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../StripeResource.js';
+export class IssuedTokenResource extends StripeResource {
+    /**
+     * Retrieves an existing SharedPaymentIssuedToken object
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/shared_payment/issued_tokens/${id}`, params, options);
+    }
+    /**
+     * Creates a new SharedPaymentIssuedToken object
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/shared_payment/issued_tokens', params, options);
+    }
+    /**
+     * Revokes a SharedPaymentIssuedToken
+     */
+    revoke(id, params, options) {
+        return this._makeRequest('POST', `/v1/shared_payment/issued_tokens/${id}/revoke`, params, options);
+    }
+}
+//# sourceMappingURL=IssuedTokens.js.map

package/esm/resources/SharedPayment/IssuedTokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IssuedTokens.js","sourceRoot":"","sources":["../../../src/resources/SharedPayment/IssuedTokens.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAGvD,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACrD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAgD,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,oCAAoC,EAAE,EAAE,EACxC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,kCAAkC,EAClC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,oCAAoC,EAAE,SAAS,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}

package/esm/resources/SharedPayment/index.d.ts

@@ -0,0 +1,19 @@
+import { Stripe } from '../../stripe.core.js';
+import { SharedPayment as SharedPaymentNamespace0, GrantedToken, GrantedTokenResource } from './GrantedTokens.js';
+import { SharedPayment as SharedPaymentNamespace1, IssuedToken, IssuedTokenResource } from './IssuedTokens.js';
+export { GrantedToken } from './GrantedTokens.js';
+export { IssuedToken } from './IssuedTokens.js';
+export declare class SharedPayment {
+    private readonly stripe;
+    grantedTokens: GrantedTokenResource;
+    issuedTokens: IssuedTokenResource;
+    constructor(stripe: Stripe);
+}
+export declare namespace SharedPayment {
+    export import GrantedTokenRetrieveParams = SharedPaymentNamespace0.GrantedTokenRetrieveParams;
+    export { GrantedToken };
+    export import IssuedTokenRetrieveParams = SharedPaymentNamespace1.IssuedTokenRetrieveParams;
+    export import IssuedTokenCreateParams = SharedPaymentNamespace1.IssuedTokenCreateParams;
+    export import IssuedTokenRevokeParams = SharedPaymentNamespace1.IssuedTokenRevokeParams;
+    export { IssuedToken };
+}

package/esm/resources/SharedPayment/index.js

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec
+import { GrantedTokenResource, } from './GrantedTokens.js';
+import { IssuedTokenResource, } from './IssuedTokens.js';
+export class SharedPayment {
+    constructor(stripe) {
+        this.stripe = stripe;
+        this.grantedTokens = new GrantedTokenResource(stripe);
+        this.issuedTokens = new IssuedTokenResource(stripe);
+    }
+}
+//# sourceMappingURL=index.js.map

package/esm/resources/SharedPayment/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/SharedPayment/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAGvC,OAAO,EAGL,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAGL,mBAAmB,GACpB,MAAM,mBAAmB,CAAC;AAK3B,MAAM,OAAO,aAAa;IAIxB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,aAAa,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;CACF"}

package/esm/resources/Sources.d.ts

@@ -90,6 +90,7 @@ export interface Source {
      */
     owner: Source.Owner | null;
     p24?: Source.P24;
+    paypal?: Source.Paypal;
     receiver?: Source.Receiver;
     redirect?: Source.Redirect;
     sepa_credit_transfer?: Source.SepaCreditTransfer;
@@ -169,6 +170,7 @@ export declare namespace Source {
         address_line1_check?: string | null;
         address_zip_check?: string | null;
         brand?: string | null;
+        brand_product?: string | null;
         country?: string | null;
         cvc_check?: string | null;
         description?: string;
@@ -190,6 +192,7 @@ export declare namespace Source {
         authorization_code?: string | null;
         authorization_response_code?: string;
         brand?: string | null;
+        brand_product?: string | null;
         country?: string | null;
         cvm_type?: string;
         data_type?: string | null;
@@ -315,6 +318,17 @@ export declare namespace Source {
     interface P24 {
         reference?: string | null;
     }
+    interface Paypal {
+        billing_agreement?: string | null;
+        fingerprint?: string | null;
+        payer_id?: string | null;
+        reference_id?: string;
+        reference_transaction_amount?: string;
+        reference_transaction_charged?: boolean;
+        statement_descriptor?: string | null;
+        transaction_id?: string;
+        verified_email?: string | null;
+    }
     interface Receiver {
         /**
          * The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
@@ -414,6 +428,7 @@ export declare namespace Source {
         address_zip_check?: string | null;
         authenticated?: boolean | null;
         brand?: string | null;
+        brand_product?: string | null;
         card?: string | null;
         country?: string | null;
         customer?: string | null;
@@ -431,7 +446,7 @@ export declare namespace Source {
         three_d_secure?: string;
         tokenization_method?: string | null;
     }
-    type Type = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'alipay' | 'au_becs_debit' | 'bancontact' | 'card' | 'card_present' | 'eps' | 'giropay' | 'ideal' | 'klarna' | 'multibanco' | 'p24' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'three_d_secure' | 'wechat';
+    type Type = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'alipay' | 'au_becs_debit' | 'bancontact' | 'card' | 'card_present' | 'eps' | 'giropay' | 'ideal' | 'klarna' | 'multibanco' | 'p24' | 'paypal' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'three_d_secure' | 'wechat';
     interface Wechat {
         prepay_id?: string;
         qr_code_url?: string | null;