stripe 22.5.0 → 22.6.0-alpha.2

package/cjs/resources/Tax/Forms.d.ts

@@ -0,0 +1,228 @@
+import { StripeResource } from '../../StripeResource.js';
+import { Account } from './../Accounts.js';
+import { PaginationParams, OtherString } from '../../shared.js';
+import { RequestOptions, ApiListPromise, Response, StripeStreamResponse } from '../../lib.js';
+export declare class FormResource extends StripeResource {
+    /**
+     * Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
+     */
+    list(params: Tax.FormListParams, options?: RequestOptions): ApiListPromise<Form>;
+    /**
+     * Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
+     */
+    retrieve(id: string, params?: Tax.FormRetrieveParams, options?: RequestOptions): Promise<Response<Form>>;
+    /**
+     * Download the PDF for a tax form.
+     */
+    pdf(id: string, params?: Tax.FormPdfParams, options?: RequestOptions): Promise<StripeStreamResponse>;
+}
+export interface Form {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'tax.form';
+    au_serr?: Form.AuSerr;
+    ca_mrdp?: Form.CaMrdp;
+    /**
+     * The form that corrects this form, if any.
+     */
+    corrected_by: string | Form | null;
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+    eu_dac7?: Form.EuDac7;
+    /**
+     * A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction's tax authority.
+     */
+    filing_statuses: Array<Form.FilingStatus>;
+    gb_mrdp?: Form.GbMrdp;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    nz_mrdp?: Form.NzMrdp;
+    payee: Form.Payee;
+    /**
+     * The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.
+     */
+    type: Form.Type;
+    us_1099_k?: Form.Us1099K;
+    us_1099_misc?: Form.Us1099Misc;
+    us_1099_nec?: Form.Us1099Nec;
+}
+export declare namespace Form {
+    interface AuSerr {
+        /**
+         * End date of the period represented by the information reported on the tax form.
+         */
+        reporting_period_end_date: string;
+        /**
+         * Start date of the period represented by the information reported on the tax form.
+         */
+        reporting_period_start_date: string;
+    }
+    interface CaMrdp {
+        /**
+         * End date of the period represented by the information reported on the tax form.
+         */
+        reporting_period_end_date: string;
+        /**
+         * Start date of the period represented by the information reported on the tax form.
+         */
+        reporting_period_start_date: string;
+    }
+    interface EuDac7 {
+        /**
+         * End date of the period represented by the information reported on the tax form.
+         */
+        reporting_period_end_date: string;
+        /**
+         * Start date of the period represented by the information reported on the tax form.
+         */
+        reporting_period_start_date: string;
+    }
+    interface FilingStatus {
+        /**
+         * Time when the filing status was updated.
+         */
+        effective_at: number;
+        jurisdiction: FilingStatus.Jurisdiction;
+        /**
+         * The current status of the filed form.
+         */
+        value: FilingStatus.Value;
+    }
+    interface GbMrdp {
+        /**
+         * End date of the period represented by the information reported on the tax form.
+         */
+        reporting_period_end_date: string;
+        /**
+         * Start date of the period represented by the information reported on the tax form.
+         */
+        reporting_period_start_date: string;
+    }
+    interface NzMrdp {
+        /**
+         * End date of the period represented by the information reported on the tax form.
+         */
+        reporting_period_end_date: string;
+        /**
+         * Start date of the period represented by the information reported on the tax form.
+         */
+        reporting_period_start_date: string;
+    }
+    interface Payee {
+        /**
+         * The ID of the payee's Stripe account.
+         */
+        account: string | Account | null;
+        /**
+         * The external reference to this payee.
+         */
+        external_reference: string | null;
+        /**
+         * Either `account` or `external_reference`.
+         */
+        type: Payee.Type;
+    }
+    type Type = 'au_serr' | 'ca_mrdp' | 'eu_dac7' | 'gb_mrdp' | 'nz_mrdp' | 'us_1099_k' | 'us_1099_misc' | 'us_1099_nec' | OtherString;
+    interface Us1099K {
+        /**
+         * Year represented by the information reported on the tax form.
+         */
+        reporting_year: number;
+    }
+    interface Us1099Misc {
+        /**
+         * Year represented by the information reported on the tax form.
+         */
+        reporting_year: number;
+    }
+    interface Us1099Nec {
+        /**
+         * Year represented by the information reported on the tax form.
+         */
+        reporting_year: number;
+    }
+    namespace FilingStatus {
+        interface Jurisdiction {
+            /**
+             * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+             */
+            country: string;
+            /**
+             * Indicates the level of the jurisdiction where the form was filed.
+             */
+            level: Jurisdiction.Level;
+            /**
+             * [ISO 3166-2 U.S. state code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix, if any. For example, "NY" for New York, United States. Null for non-U.S. forms.
+             */
+            state: string | null;
+        }
+        type Value = 'accepted' | 'filed' | 'rejected' | OtherString;
+        namespace Jurisdiction {
+            type Level = 'country' | 'state' | OtherString;
+        }
+    }
+    namespace Payee {
+        type Type = 'account' | 'external_reference' | OtherString;
+    }
+}
+export declare namespace Tax {
+    interface FormRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace Tax {
+    interface FormListParams extends PaginationParams {
+        /**
+         * The payee whose volume is represented on the tax form.
+         */
+        payee: FormListParams.Payee;
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+        /**
+         * An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.
+         */
+        type?: FormListParams.Type;
+    }
+    namespace FormListParams {
+        interface Payee {
+            /**
+             * The ID of the Stripe account whose forms will be retrieved.
+             */
+            account?: string;
+            /**
+             * The external reference to the payee whose forms will be retrieved.
+             */
+            external_reference?: string;
+            /**
+             * Specifies the payee type. Either `account` or `external_reference`.
+             */
+            type?: Payee.Type;
+        }
+        type Type = 'au_serr' | 'ca_mrdp' | 'eu_dac7' | 'gb_mrdp' | 'nz_mrdp' | 'us_1099_k' | 'us_1099_misc' | 'us_1099_nec' | OtherString;
+        namespace Payee {
+            type Type = 'account' | 'external_reference' | OtherString;
+        }
+    }
+}
+export declare namespace Tax {
+    interface FormPdfParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}

package/cjs/resources/Tax/Forms.js

@@ -0,0 +1,32 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormResource = void 0;
+const StripeResource_js_1 = require("../../StripeResource.js");
+class FormResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/tax/forms', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/tax/forms/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Download the PDF for a tax form.
+     */
+    pdf(id, params, options) {
+        return this._makeRequest('GET', `/v1/tax/forms/${encodeURIComponent(id)}/pdf`, params, options, {
+            apiBase: 'files',
+            streaming: true,
+        });
+    }
+}
+exports.FormResource = FormResource;
+//# sourceMappingURL=Forms.js.map

package/cjs/resources/Tax/Forms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Forms.js","sourceRoot":"","sources":["../../../src/resources/Tax/Forms.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAUvD,MAAa,YAAa,SAAQ,kCAAc;IAC9C;;OAEG;IACH,IAAI,CACF,MAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE;YAChE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,iBAAiB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACzC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,GAAG,CACD,EAAU,EACV,MAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,iBAAiB,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAC7C,MAAM,EACN,OAAO,EACP;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,IAAI;SAChB,CACK,CAAC;IACX,CAAC;CACF;AA9CD,oCA8CC"}

package/cjs/resources/Tax/Locations.d.ts

@@ -0,0 +1,112 @@
+import { StripeResource } from '../../StripeResource.js';
+import { Address, Emptyable, PaginationParams } from '../../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../../lib.js';
+export declare class LocationResource extends StripeResource {
+    /**
+     * Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types.
+     *
+     * The response includes detailed information for each tax location, such as its address, name, description, and current operational status.
+     *
+     * You can paginate through the list by using the limit parameter to control the number of results returned in each request.
+     */
+    list(params: Tax.LocationListParams, options?: RequestOptions): ApiListPromise<Location>;
+    /**
+     * Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location.
+     */
+    create(params: Tax.LocationCreateParams, options?: RequestOptions): Promise<Response<Location>>;
+    /**
+     * Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the [integration guide](https://docs.stripe.com/tax/tax-for-tickets/integration-guide).
+     */
+    retrieve(id: string, params?: Tax.LocationRetrieveParams, options?: RequestOptions): Promise<Response<Location>>;
+}
+export interface Location {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'tax.location';
+    address: Address;
+    /**
+     * A descriptive text providing additional context about the tax location. This can include information about the venue, types of events held, services available, or any relevant details for better identification (e.g., "A spacious auditorium suitable for large concerts and events.").
+     */
+    description: string | 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;
+    /**
+     * The type of tax location to be defined. Currently the only option is `performance`.
+     */
+    type: 'performance';
+}
+export declare namespace Tax {
+    interface LocationCreateParams {
+        /**
+         * The physical address of the tax location.
+         */
+        address: LocationCreateParams.Address;
+        /**
+         * The type of tax location. The only supported value is "performance".
+         */
+        type: 'performance';
+        /**
+         * Details to identify the tax location by its venue, types of events held, or available services, such as "A spacious auditorium suitable for large concerts and events.".
+         */
+        description?: string;
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+    namespace LocationCreateParams {
+        interface Address {
+            /**
+             * City, district, suburb, town, or village.
+             */
+            city?: Emptyable<string>;
+            /**
+             * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+             */
+            country: string;
+            /**
+             * Address line 1, such as the street, PO Box, or company name.
+             */
+            line1?: Emptyable<string>;
+            /**
+             * Address line 2, such as the apartment, suite, unit, or building.
+             */
+            line2?: Emptyable<string>;
+            /**
+             * ZIP or postal code.
+             */
+            postal_code?: Emptyable<string>;
+            /**
+             * State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
+             */
+            state?: Emptyable<string>;
+        }
+    }
+}
+export declare namespace Tax {
+    interface LocationRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace Tax {
+    interface LocationListParams extends PaginationParams {
+        /**
+         * Type of the tax location. Currently the only option is `performance`.
+         */
+        type: 'performance';
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}

package/cjs/resources/Tax/Locations.js

@@ -0,0 +1,33 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocationResource = void 0;
+const StripeResource_js_1 = require("../../StripeResource.js");
+class LocationResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types.
+     *
+     * The response includes detailed information for each tax location, such as its address, name, description, and current operational status.
+     *
+     * You can paginate through the list by using the limit parameter to control the number of results returned in each request.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/tax/locations', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/tax/locations', params, options);
+    }
+    /**
+     * Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the [integration guide](https://docs.stripe.com/tax/tax-for-tickets/integration-guide).
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/tax/locations/${encodeURIComponent(id)}`, params, options);
+    }
+}
+exports.LocationResource = LocationResource;
+//# sourceMappingURL=Locations.js.map

package/cjs/resources/Tax/Locations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Locations.js","sourceRoot":"","sources":["../../../src/resources/Tax/Locations.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAIvD,MAAa,gBAAiB,SAAQ,kCAAc;IAClD;;;;;;OAMG;IACH,IAAI,CACF,MAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,OAAO,EAAE;YACpE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,mBAAmB,EACnB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qBAAqB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC7C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AA7CD,4CA6CC"}