stripe 22.2.0 → 22.3.0-beta.1

package/cjs/resources/Mandates.d.ts

@@ -1,7 +1,12 @@
 import { StripeResource } from '../StripeResource.js';
 import { PaymentMethod } from './PaymentMethods.js';
-import { RequestOptions, Response } from '../lib.js';
+import { PaginationParams } from '../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../lib.js';
 export declare class MandateResource extends StripeResource {
+    /**
+     * Retrieves a list of Mandates for a given PaymentMethod.
+     */
+    list(params: MandateListParams, options?: RequestOptions): ApiListPromise<Mandate>;
     /**
      * Retrieves a Mandate object.
      */
@@ -191,10 +196,19 @@ export declare namespace Mandate {
              * The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
              */
             billing_agreement_id: string | null;
+            /**
+             * Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
+             */
+            fingerprint?: string | null;
             /**
              * PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
              */
             payer_id: string | null;
+            /**
+             * Owner's verified email. Values are verified or provided by PayPal directly
+             * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+             */
+            verified_email?: string | null;
         }
         interface Payto {
             /**
@@ -320,3 +334,21 @@ export interface MandateRetrieveParams {
      */
     expand?: Array<string>;
 }
+export interface MandateListParams extends PaginationParams {
+    payment_method: string;
+    /**
+     * The status of the mandates to retrieve. Status indicates whether or not you can use it to initiate a payment, and can have a value of `active`, `pending`, or `inactive`.
+     */
+    status: MandateListParams.Status;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * The Stripe account ID that the mandates are intended for. Learn more about the [use case for connected accounts payments](https://docs.stripe.com/payments/connected-accounts).
+     */
+    on_behalf_of?: string;
+}
+export declare namespace MandateListParams {
+    type Status = 'active' | 'inactive' | 'pending';
+}

package/cjs/resources/Mandates.js

@@ -4,6 +4,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MandateResource = void 0;
 const StripeResource_js_1 = require("../StripeResource.js");
 class MandateResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Retrieves a list of Mandates for a given PaymentMethod.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/mandates', params, options, {
+            methodType: 'list',
+        });
+    }
     /**
      * Retrieves a Mandate object.
      */

package/cjs/resources/Mandates.js.map

@@ -1 +1 @@
-{"version":3,"file":"Mandates.js","sourceRoot":"","sources":["../../src/resources/Mandates.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AAIpD,MAAa,eAAgB,SAAQ,kCAAc;IACjD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,gBAAgB,EAAE,EAAE,EACpB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAhBD,0CAgBC"}
+{"version":3,"file":"Mandates.js","sourceRoot":"","sources":["../../src/resources/Mandates.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AAKpD,MAAa,eAAgB,SAAQ,kCAAc;IACjD;;OAEG;IACH,IAAI,CACF,MAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE;YAC/D,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,gBAAgB,EAAE,EAAE,EACpB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AA3BD,0CA2BC"}

package/cjs/resources/Margins.d.ts

@@ -0,0 +1,115 @@
+import { StripeResource } from '../StripeResource.js';
+import { MetadataParam, PaginationParams, Metadata } from '../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../lib.js';
+export declare class MarginResource extends StripeResource {
+    /**
+     * Retrieve a list of your margins.
+     */
+    list(params?: MarginListParams, options?: RequestOptions): ApiListPromise<Margin>;
+    /**
+     * Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
+     */
+    create(params: MarginCreateParams, options?: RequestOptions): Promise<Response<Margin>>;
+    /**
+     * Retrieve a margin object with the given ID.
+     */
+    retrieve(id: string, params?: MarginRetrieveParams, options?: RequestOptions): Promise<Response<Margin>>;
+    /**
+     * Update the specified margin object. Certain fields of the margin object are not editable.
+     */
+    update(id: string, params?: MarginUpdateParams, options?: RequestOptions): Promise<Response<Margin>>;
+}
+export interface Margin {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'margin';
+    /**
+     * Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to `true`.
+     */
+    active: boolean;
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+     */
+    metadata: Metadata | null;
+    /**
+     * Name of the margin that's displayed on, for example, invoices.
+     */
+    name: string | null;
+    /**
+     * Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
+     */
+    percent_off: number;
+    /**
+     * Time at which the object was last updated. Measured in seconds since the Unix epoch.
+     */
+    updated: number;
+}
+export interface MarginCreateParams {
+    /**
+     * Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
+     */
+    percent_off: number;
+    /**
+     * Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`.
+     */
+    active?: boolean;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+     */
+    metadata?: MetadataParam;
+    /**
+     * Name of the margin, which is displayed to customers, such as on invoices.
+     */
+    name?: string;
+}
+export interface MarginRetrieveParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}
+export interface MarginUpdateParams {
+    /**
+     * Whether the margin can be applied to invoices, invoice items, or invoice line items or not.
+     */
+    active?: boolean;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+     */
+    metadata?: MetadataParam;
+    /**
+     * Name of the margin, which is displayed to customers, such as on invoices.
+     */
+    name?: string;
+}
+export interface MarginListParams extends PaginationParams {
+    /**
+     * Only return margins that are active or inactive. For example, pass `true` to only list active margins.
+     */
+    active?: boolean;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}

package/cjs/resources/Margins.js

@@ -0,0 +1,35 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarginResource = void 0;
+const StripeResource_js_1 = require("../StripeResource.js");
+class MarginResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Retrieve a list of your margins.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/billing/margins', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/billing/margins', params, options);
+    }
+    /**
+     * Retrieve a margin object with the given ID.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/billing/margins/${id}`, params, options);
+    }
+    /**
+     * Update the specified margin object. Certain fields of the margin object are not editable.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v1/billing/margins/${id}`, params, options);
+    }
+}
+exports.MarginResource = MarginResource;
+//# sourceMappingURL=Margins.js.map

package/cjs/resources/Margins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Margins.js","sourceRoot":"","sources":["../../src/resources/Margins.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AAIpD,MAAa,cAAe,SAAQ,kCAAc;IAChD;;OAEG;IACH,IAAI,CACF,MAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,OAAO,EAAE;YACtE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,qBAAqB,EACrB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,uBAAuB,EAAE,EAAE,EAC3B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,EAAE,EAAE,EAC3B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAxDD,wCAwDC"}