stripe 22.2.0 → 22.3.0-beta.1

package/cjs/resources/V2/Core/Vault/index.d.ts

@@ -0,0 +1,28 @@
+import { Stripe } from '../../../../stripe.core.js';
+import { V2 as V2Namespace0, GbBankAccount, GbBankAccountResource } from './GbBankAccounts.js';
+import { V2 as V2Namespace1, UsBankAccount, UsBankAccountResource } from './UsBankAccounts.js';
+export { GbBankAccount } from './GbBankAccounts.js';
+export { UsBankAccount } from './UsBankAccounts.js';
+export declare class Vault {
+    private readonly stripe;
+    gbBankAccounts: GbBankAccountResource;
+    usBankAccounts: UsBankAccountResource;
+    constructor(stripe: Stripe);
+}
+export declare namespace Vault {
+    export import GbBankAccountListParams = V2Namespace0.Core.Vault.GbBankAccountListParams;
+    export import GbBankAccountCreateParams = V2Namespace0.Core.Vault.GbBankAccountCreateParams;
+    export import GbBankAccountRetrieveParams = V2Namespace0.Core.Vault.GbBankAccountRetrieveParams;
+    export import GbBankAccountAcknowledgeConfirmationOfPayeeParams = V2Namespace0.Core.Vault.GbBankAccountAcknowledgeConfirmationOfPayeeParams;
+    export import GbBankAccountArchiveParams = V2Namespace0.Core.Vault.GbBankAccountArchiveParams;
+    export import GbBankAccountInitiateConfirmationOfPayeeParams = V2Namespace0.Core.Vault.GbBankAccountInitiateConfirmationOfPayeeParams;
+    export { GbBankAccount };
+    export import UsBankAccountListParams = V2Namespace1.Core.Vault.UsBankAccountListParams;
+    export import UsBankAccountCreateParams = V2Namespace1.Core.Vault.UsBankAccountCreateParams;
+    export import UsBankAccountRetrieveParams = V2Namespace1.Core.Vault.UsBankAccountRetrieveParams;
+    export import UsBankAccountUpdateParams = V2Namespace1.Core.Vault.UsBankAccountUpdateParams;
+    export import UsBankAccountArchiveParams = V2Namespace1.Core.Vault.UsBankAccountArchiveParams;
+    export import UsBankAccountConfirmMicrodepositsParams = V2Namespace1.Core.Vault.UsBankAccountConfirmMicrodepositsParams;
+    export import UsBankAccountSendMicrodepositsParams = V2Namespace1.Core.Vault.UsBankAccountSendMicrodepositsParams;
+    export { UsBankAccount };
+}

package/cjs/resources/V2/Core/Vault/index.js

@@ -0,0 +1,15 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Vault = void 0;
+const GbBankAccounts_js_1 = require("./GbBankAccounts.js");
+const UsBankAccounts_js_1 = require("./UsBankAccounts.js");
+class Vault {
+    constructor(stripe) {
+        this.stripe = stripe;
+        this.gbBankAccounts = new GbBankAccounts_js_1.GbBankAccountResource(stripe);
+        this.usBankAccounts = new UsBankAccounts_js_1.UsBankAccountResource(stripe);
+    }
+}
+exports.Vault = Vault;
+//# sourceMappingURL=index.js.map

package/cjs/resources/V2/Core/Vault/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/resources/V2/Core/Vault/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,2DAI6B;AAC7B,2DAI6B;AAK7B,MAAa,KAAK;IAIhB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAqB,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAqB,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC;CACF;AARD,sBAQC"}

package/cjs/resources/V2/Core/index.d.ts

@@ -2,13 +2,16 @@ import { Stripe } from '../../../stripe.core.js';
 import { V2 as V2Namespace0, Account, AccountResource } from './Accounts.js';
 import { V2 as V2Namespace1, AccountLink, AccountLinkResource } from './AccountLinks.js';
 import { V2 as V2Namespace2, AccountToken, AccountTokenResource } from './AccountTokens.js';
+import { V2 as V2Namespace3, BatchJob, BatchJobResource } from './BatchJobs.js';
 import { EventBase, EventNotification, Event, Events, V2 as V2EventsNamespace, EventResource } from './Events.js';
-import { V2 as V2Namespace4, EventDestination, EventDestinationResource } from './EventDestinations.js';
+import { V2 as V2Namespace5, EventDestination, EventDestinationResource } from './EventDestinations.js';
 import { AccountPersonToken } from './AccountPersonTokens.js';
 import { AccountPerson } from './AccountPersons.js';
+import { Vault } from './Vault/index.js';
 export { Account } from './Accounts.js';
 export { AccountLink } from './AccountLinks.js';
 export { AccountToken } from './AccountTokens.js';
+export { BatchJob } from './BatchJobs.js';
 export { Event } from './Events.js';
 export { EventDestination } from './EventDestinations.js';
 export { AccountPersonToken } from './AccountPersonTokens.js';
@@ -18,8 +21,10 @@ export declare class Core {
     accounts: AccountResource;
     accountLinks: AccountLinkResource;
     accountTokens: AccountTokenResource;
+    batchJobs: BatchJobResource;
     events: EventResource;
     eventDestinations: EventDestinationResource;
+    vault: Vault;
     constructor(stripe: Stripe);
 }
 export declare namespace Core {
@@ -34,18 +39,23 @@ export declare namespace Core {
     export import AccountTokenCreateParams = V2Namespace2.Core.AccountTokenCreateParams;
     export import AccountTokenRetrieveParams = V2Namespace2.Core.AccountTokenRetrieveParams;
     export { AccountToken };
+    export import BatchJobCreateParams = V2Namespace3.Core.BatchJobCreateParams;
+    export import BatchJobRetrieveParams = V2Namespace3.Core.BatchJobRetrieveParams;
+    export import BatchJobCancelParams = V2Namespace3.Core.BatchJobCancelParams;
+    export { BatchJob };
     export import EventListParams = V2EventsNamespace.Core.EventListParams;
     export import EventRetrieveParams = V2EventsNamespace.Core.EventRetrieveParams;
     export { EventBase, Event, EventNotification, Events };
-    export import EventDestinationListParams = V2Namespace4.Core.EventDestinationListParams;
-    export import EventDestinationCreateParams = V2Namespace4.Core.EventDestinationCreateParams;
-    export import EventDestinationDeleteParams = V2Namespace4.Core.EventDestinationDeleteParams;
-    export import EventDestinationRetrieveParams = V2Namespace4.Core.EventDestinationRetrieveParams;
-    export import EventDestinationUpdateParams = V2Namespace4.Core.EventDestinationUpdateParams;
-    export import EventDestinationDisableParams = V2Namespace4.Core.EventDestinationDisableParams;
-    export import EventDestinationEnableParams = V2Namespace4.Core.EventDestinationEnableParams;
-    export import EventDestinationPingParams = V2Namespace4.Core.EventDestinationPingParams;
+    export import EventDestinationListParams = V2Namespace5.Core.EventDestinationListParams;
+    export import EventDestinationCreateParams = V2Namespace5.Core.EventDestinationCreateParams;
+    export import EventDestinationDeleteParams = V2Namespace5.Core.EventDestinationDeleteParams;
+    export import EventDestinationRetrieveParams = V2Namespace5.Core.EventDestinationRetrieveParams;
+    export import EventDestinationUpdateParams = V2Namespace5.Core.EventDestinationUpdateParams;
+    export import EventDestinationDisableParams = V2Namespace5.Core.EventDestinationDisableParams;
+    export import EventDestinationEnableParams = V2Namespace5.Core.EventDestinationEnableParams;
+    export import EventDestinationPingParams = V2Namespace5.Core.EventDestinationPingParams;
     export { EventDestination };
     export { AccountPersonToken };
     export { AccountPerson };
+    export { Vault };
 }

package/cjs/resources/V2/Core/index.js

@@ -5,16 +5,20 @@ exports.Core = void 0;
 const Accounts_js_1 = require("./Accounts.js");
 const AccountLinks_js_1 = require("./AccountLinks.js");
 const AccountTokens_js_1 = require("./AccountTokens.js");
+const BatchJobs_js_1 = require("./BatchJobs.js");
 const Events_js_1 = require("./Events.js");
 const EventDestinations_js_1 = require("./EventDestinations.js");
+const index_js_1 = require("./Vault/index.js");
 class Core {
     constructor(stripe) {
         this.stripe = stripe;
         this.accounts = new Accounts_js_1.AccountResource(stripe);
         this.accountLinks = new AccountLinks_js_1.AccountLinkResource(stripe);
         this.accountTokens = new AccountTokens_js_1.AccountTokenResource(stripe);
+        this.batchJobs = new BatchJobs_js_1.BatchJobResource(stripe);
         this.events = new Events_js_1.EventResource(stripe);
         this.eventDestinations = new EventDestinations_js_1.EventDestinationResource(stripe);
+        this.vault = new index_js_1.Vault(stripe);
     }
 }
 exports.Core = Core;

package/cjs/resources/V2/Core/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/V2/Core/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,+CAA2E;AAC3E,uDAI2B;AAC3B,yDAI4B;AAC5B,2CAOqB;AACrB,iEAIgC;AAYhC,MAAa,IAAI;IAOf,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAAe,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,qCAAmB,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,aAAa,GAAG,IAAI,uCAAoB,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,GAAG,IAAI,yBAAa,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,iBAAiB,GAAG,IAAI,+CAAwB,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;CACF;AAdD,oBAcC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/V2/Core/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,+CAA2E;AAC3E,uDAI2B;AAC3B,yDAI4B;AAC5B,iDAA8E;AAC9E,2CAOqB;AACrB,iEAIgC;AAGhC,+CAAuC;AAWvC,MAAa,IAAI;IASf,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAAe,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,qCAAmB,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,aAAa,GAAG,IAAI,uCAAoB,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,CAAC,SAAS,GAAG,IAAI,+BAAgB,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,IAAI,yBAAa,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,iBAAiB,GAAG,IAAI,+CAAwB,CAAC,MAAM,CAAC,CAAC;QAC9D,IAAI,CAAC,KAAK,GAAG,IAAI,gBAAK,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;CACF;AAlBD,oBAkBC"}

package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts

@@ -0,0 +1,156 @@
+import { StripeResource } from '../../../../StripeResource.js';
+import { RequestOptions, Response } from '../../../../lib.js';
+export declare class QueryRunResource extends StripeResource {
+    /**
+     * Creates a query run to execute ad-hoc SQL and returns a `QueryRun` object to track progress and retrieve results.
+     */
+    create(params: V2.Data.Reporting.QueryRunCreateParams, options?: RequestOptions): Promise<Response<QueryRun>>;
+    /**
+     * Fetches the current state and details of a previously created `QueryRun`. If the `QueryRun`
+     * has succeeded, the endpoint will provide details for how to retrieve the results.
+     */
+    retrieve(id: string, params?: V2.Data.Reporting.QueryRunRetrieveParams, options?: RequestOptions): Promise<Response<QueryRun>>;
+}
+export interface QueryRun {
+    /**
+     * The unique identifier of the `QueryRun` object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.data.reporting.query_run';
+    /**
+     * Time at which the object was created.
+     */
+    created: string;
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+    /**
+     * Details how to retrieve the results of a successfully completed `QueryRun`.
+     */
+    result?: V2.Data.Reporting.QueryRun.Result;
+    /**
+     * The options specified for customizing the output of the `QueryRun`.
+     */
+    result_options?: V2.Data.Reporting.QueryRun.ResultOptions;
+    /**
+     * The SQL that was executed.
+     */
+    sql: string;
+    /**
+     * The current status of the `QueryRun`.
+     */
+    status: V2.Data.Reporting.QueryRun.Status;
+    /**
+     * Additional details about the current state of the `QueryRun`. Populated when the `QueryRun`
+     * is in the `failed` state, providing more information about why the query failed.
+     */
+    status_details: {
+        [key: string]: V2.Data.Reporting.QueryRun.StatusDetails;
+    };
+}
+export declare namespace V2 {
+    namespace Data {
+        namespace Reporting {
+            namespace QueryRun {
+                interface Result {
+                    /**
+                     * Contains metadata about the file produced by the `ReportRun` or `QueryRun`, including
+                     * its content type, size, and a URL to download its contents.
+                     */
+                    file?: Result.File;
+                    /**
+                     * The type of the `ReportRun` or `QueryRun` result.
+                     */
+                    type: 'file';
+                }
+                interface ResultOptions {
+                    /**
+                     * If set, the generated results file will be compressed into a ZIP folder.
+                     * This is useful for reducing file size and download time for large results.
+                     */
+                    compress_file?: boolean;
+                }
+                type Status = 'failed' | 'running' | 'succeeded';
+                interface StatusDetails {
+                    /**
+                     * Error code categorizing the reason the `QueryRun` failed.
+                     */
+                    error_code?: StatusDetails.ErrorCode;
+                    /**
+                     * Error message with additional details about the failure.
+                     */
+                    error_message?: string;
+                }
+                namespace Result {
+                    interface File {
+                        /**
+                         * The content type of the file.
+                         */
+                        content_type: File.ContentType;
+                        /**
+                         * A pre-signed URL that allows secure, time-limited access to download the file.
+                         */
+                        download_url: File.DownloadUrl;
+                        /**
+                         * The total size of the file in bytes.
+                         */
+                        size: bigint;
+                    }
+                    namespace File {
+                        type ContentType = 'csv' | 'zip';
+                        interface DownloadUrl {
+                            /**
+                             * The time that the URL expires.
+                             */
+                            expires_at?: string;
+                            /**
+                             * The URL that can be used for accessing the file.
+                             */
+                            url: string;
+                        }
+                    }
+                }
+                namespace StatusDetails {
+                    type ErrorCode = 'file_size_above_limit' | 'internal_error';
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Data {
+        namespace Reporting {
+            interface QueryRunCreateParams {
+                /**
+                 * The SQL to execute.
+                 */
+                sql: string;
+                /**
+                 * Optional settings to customize the results of the `QueryRun`.
+                 */
+                result_options?: QueryRunCreateParams.ResultOptions;
+            }
+            namespace QueryRunCreateParams {
+                interface ResultOptions {
+                    /**
+                     * If set, the generated results file will be compressed into a ZIP folder.
+                     * This is useful for reducing file size and download time for large results.
+                     */
+                    compress_file?: boolean;
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Data {
+        namespace Reporting {
+            interface QueryRunRetrieveParams {
+            }
+        }
+    }
+}

package/cjs/resources/V2/Data/Reporting/QueryRuns.js

@@ -0,0 +1,46 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryRunResource = void 0;
+const StripeResource_js_1 = require("../../../../StripeResource.js");
+class QueryRunResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Creates a query run to execute ad-hoc SQL and returns a `QueryRun` object to track progress and retrieve results.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v2/data/reporting/query_runs', params, options, {
+            responseSchema: {
+                kind: 'object',
+                fields: {
+                    result: {
+                        kind: 'object',
+                        fields: {
+                            file: { kind: 'object', fields: { size: { kind: 'int64_string' } } },
+                        },
+                    },
+                },
+            },
+        });
+    }
+    /**
+     * Fetches the current state and details of a previously created `QueryRun`. If the `QueryRun`
+     * has succeeded, the endpoint will provide details for how to retrieve the results.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/data/reporting/query_runs/${id}`, params, options, {
+            responseSchema: {
+                kind: 'object',
+                fields: {
+                    result: {
+                        kind: 'object',
+                        fields: {
+                            file: { kind: 'object', fields: { size: { kind: 'int64_string' } } },
+                        },
+                    },
+                },
+            },
+        });
+    }
+}
+exports.QueryRunResource = QueryRunResource;
+//# sourceMappingURL=QueryRuns.js.map

package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryRuns.js","sourceRoot":"","sources":["../../../../../src/resources/V2/Data/Reporting/QueryRuns.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,qEAA6D;AAG7D,MAAa,gBAAiB,SAAQ,kCAAc;IAClD;;OAEG;IACH,MAAM,CACJ,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,+BAA+B,EAC/B,MAAM,EACN,OAAO,EACP;YACE,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE;4BACN,IAAI,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,IAAI,EAAE,cAAc,EAAC,EAAC,EAAC;yBAC/D;qBACF;iBACF;aACF;SACF,CACK,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,QAAQ,CACN,EAAU,EACV,MAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,iCAAiC,EAAE,EAAE,EACrC,MAAM,EACN,OAAO,EACP;YACE,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE;4BACN,IAAI,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,IAAI,EAAE,cAAc,EAAC,EAAC,EAAC;yBAC/D;qBACF;iBACF;aACF;SACF,CACK,CAAC;IACX,CAAC;CACF;AAzDD,4CAyDC"}

package/cjs/resources/V2/Data/Reporting/index.d.ts

@@ -0,0 +1,13 @@
+import { Stripe } from '../../../../stripe.core.js';
+import { V2 as V2Namespace0, QueryRun, QueryRunResource } from './QueryRuns.js';
+export { QueryRun } from './QueryRuns.js';
+export declare class Reporting {
+    private readonly stripe;
+    queryRuns: QueryRunResource;
+    constructor(stripe: Stripe);
+}
+export declare namespace Reporting {
+    export import QueryRunCreateParams = V2Namespace0.Data.Reporting.QueryRunCreateParams;
+    export import QueryRunRetrieveParams = V2Namespace0.Data.Reporting.QueryRunRetrieveParams;
+    export { QueryRun };
+}

package/cjs/resources/V2/Data/Reporting/index.js

@@ -0,0 +1,13 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Reporting = void 0;
+const QueryRuns_js_1 = require("./QueryRuns.js");
+class Reporting {
+    constructor(stripe) {
+        this.stripe = stripe;
+        this.queryRuns = new QueryRuns_js_1.QueryRunResource(stripe);
+    }
+}
+exports.Reporting = Reporting;
+//# sourceMappingURL=index.js.map

package/cjs/resources/V2/Data/Reporting/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/resources/V2/Data/Reporting/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,iDAA8E;AAI9E,MAAa,SAAS;IAGpB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,+BAAgB,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;CACF;AAND,8BAMC"}

package/cjs/resources/V2/Data/index.d.ts

@@ -0,0 +1,10 @@
+import { Stripe } from '../../../stripe.core.js';
+import { Reporting } from './Reporting/index.js';
+export declare class Data {
+    private readonly stripe;
+    reporting: Reporting;
+    constructor(stripe: Stripe);
+}
+export declare namespace Data {
+    export { Reporting };
+}

package/cjs/resources/V2/Data/index.js

@@ -0,0 +1,13 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Data = void 0;
+const index_js_1 = require("./Reporting/index.js");
+class Data {
+    constructor(stripe) {
+        this.stripe = stripe;
+        this.reporting = new index_js_1.Reporting(stripe);
+    }
+}
+exports.Data = Data;
+//# sourceMappingURL=index.js.map

package/cjs/resources/V2/Data/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/V2/Data/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,mDAA+C;AAE/C,MAAa,IAAI;IAGf,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,oBAAS,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;CACF;AAND,oBAMC"}

package/cjs/resources/V2/EventMisc.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=EventMisc.js.map

package/cjs/resources/V2/EventMisc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventMisc.js","sourceRoot":"","sources":["../../../src/resources/V2/EventMisc.ts"],"names":[],"mappings":""}

package/cjs/resources/V2/Extend/WorkflowRuns.d.ts

@@ -0,0 +1,166 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
+export declare class WorkflowRunResource extends StripeResource {
+    /**
+     * List all Workflow Runs.
+     */
+    list(params?: V2.Extend.WorkflowRunListParams, options?: RequestOptions): V2ListPromise<WorkflowRun>;
+    /**
+     * Retrieves the details of a Workflow Run by ID.
+     */
+    retrieve(id: string, params?: V2.Extend.WorkflowRunRetrieveParams, options?: RequestOptions): Promise<Response<WorkflowRun>>;
+}
+export interface WorkflowRun {
+    /**
+     * The unique ID of the Workflow Run.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.extend.workflow_run';
+    /**
+     * When the Workflow Run was created.
+     */
+    created: string;
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+    /**
+     * The current Workflow Run execution status.
+     */
+    status: V2.Extend.WorkflowRun.Status;
+    /**
+     * Details about the Workflow Run's status transitions.
+     */
+    status_details?: V2.Extend.WorkflowRun.StatusDetails;
+    /**
+     * Summary information about the Workflow Run's status transitions.
+     */
+    status_transitions: V2.Extend.WorkflowRun.StatusTransitions;
+    /**
+     * A record of the trigger that launched this Workflow Run.
+     */
+    trigger: V2.Extend.WorkflowRun.Trigger;
+    /**
+     * The Workflow this Run belongs to.
+     */
+    workflow: string;
+}
+export declare namespace V2 {
+    namespace Extend {
+        namespace WorkflowRun {
+            type Status = 'failed' | 'started' | 'succeeded';
+            interface StatusDetails {
+                /**
+                 * Details about the Workflow Run's transition into the FAILED state.
+                 */
+                failed?: StatusDetails.Failed;
+                /**
+                 * Details about the Workflow Run's transition in to the STARTED state.
+                 */
+                started?: StatusDetails.Started;
+                /**
+                 * Details about the Workflow Run's transition into the SUCCEEDED state.
+                 */
+                succeeded?: StatusDetails.Succeeded;
+            }
+            interface StatusTransitions {
+                /**
+                 * When the Workflow Run failed.
+                 */
+                failed_at?: string;
+                /**
+                 * When the Workflow Run was started.
+                 */
+                started_at?: string;
+                /**
+                 * When the Workflow Run succeeded.
+                 */
+                succeeded_at?: string;
+            }
+            interface Trigger {
+                /**
+                 * The Workflow Run was launched when Stripe emitted a certain event.
+                 */
+                event_trigger?: Trigger.EventTrigger;
+                /**
+                 * The Workflow Run was launched through a direct call, using either the Dashboard or the Stripe API.
+                 */
+                manual?: Trigger.Manual;
+                /**
+                 * Which type of trigger this is.
+                 */
+                type: Trigger.Type;
+            }
+            namespace StatusDetails {
+                interface Failed {
+                    /**
+                     * Optional details about the failure result.
+                     */
+                    error_message?: string;
+                }
+                interface Started {
+                }
+                interface Succeeded {
+                }
+            }
+            namespace Trigger {
+                interface EventTrigger {
+                    /**
+                     * The account that generated the triggering event.
+                     */
+                    context: string;
+                    /**
+                     * The Stripe event that triggered this Run.
+                     */
+                    id: string;
+                    /**
+                     * The Stripe event type triggered this Run.
+                     */
+                    type: string;
+                }
+                interface Manual {
+                    /**
+                     * The input parameters used when launching the Run.
+                     */
+                    input_parameters: Manual.InputParameters;
+                }
+                type Type = 'event_trigger' | 'manual';
+                namespace Manual {
+                    type InputParameters = {
+                        [key: string]: unknown;
+                    };
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Extend {
+        interface WorkflowRunRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Extend {
+        interface WorkflowRunListParams {
+            /**
+             * Restrict page size to no more than this number.
+             */
+            limit?: number;
+            /**
+             * When retrieving Workflow Runs, include only those with the specified status values. If not specified, all Runs are returned.
+             */
+            status?: Array<WorkflowRunListParams.Status>;
+            /**
+             * When retrieving Workflow Runs, include only those associated with the Workflows specified. If not specified, all Runs are returned.
+             */
+            workflow?: Array<string>;
+        }
+        namespace WorkflowRunListParams {
+            type Status = 'failed' | 'started' | 'succeeded';
+        }
+    }
+}

package/cjs/resources/V2/Extend/WorkflowRuns.js

@@ -0,0 +1,23 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowRunResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+class WorkflowRunResource extends StripeResource_js_1.StripeResource {
+    /**
+     * List all Workflow Runs.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/extend/workflow_runs', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Retrieves the details of a Workflow Run by ID.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/extend/workflow_runs/${id}`, params, options);
+    }
+}
+exports.WorkflowRunResource = WorkflowRunResource;
+//# sourceMappingURL=WorkflowRuns.js.map

package/cjs/resources/V2/Extend/WorkflowRuns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkflowRuns.js","sourceRoot":"","sources":["../../../../src/resources/V2/Extend/WorkflowRuns.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAG1D,MAAa,mBAAoB,SAAQ,kCAAc;IACrD;;OAEG;IACH,IAAI,CACF,MAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,0BAA0B,EAC1B,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,4BAA4B,EAAE,EAAE,EAChC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAjCD,kDAiCC"}