stripe 22.2.0 → 22.3.0-alpha.2

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

@@ -0,0 +1,334 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
+export declare class ApprovalRequestResource extends StripeResource {
+    /**
+     * GET /v2/core/approval_requests
+     * Lists approval requests with optional filtering.
+     */
+    list(params?: V2.Core.ApprovalRequestListParams, options?: RequestOptions): V2ListPromise<ApprovalRequest>;
+    /**
+     * GET /v2/core/approval_requests/:id
+     * Retrieves an approval request by ID.
+     */
+    retrieve(id: string, params?: V2.Core.ApprovalRequestRetrieveParams, options?: RequestOptions): Promise<Response<ApprovalRequest>>;
+    /**
+     * POST /v2/core/approval_requests/:id/cancel
+     * Cancels a pending approval request.
+     */
+    cancel(id: string, params?: V2.Core.ApprovalRequestCancelParams, options?: RequestOptions): Promise<Response<ApprovalRequest>>;
+    /**
+     * POST /v2/core/approval_requests/:id/execute
+     * Executes an approved approval request.
+     */
+    execute(id: string, params?: V2.Core.ApprovalRequestExecuteParams, options?: RequestOptions): Promise<Response<ApprovalRequest>>;
+    /**
+     * POST /v2/core/approval_requests/:id/submit
+     * Moves a pending approval request into the reviewer queue for auto-execution upon approval.
+     */
+    submit(id: string, params?: V2.Core.ApprovalRequestSubmitParams, options?: RequestOptions): Promise<Response<ApprovalRequest>>;
+}
+export interface ApprovalRequest {
+    /**
+     * The unique identifier for this ApprovalRequest.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.core.approval_request';
+    /**
+     * The action that was requested.
+     */
+    action: V2.Core.ApprovalRequest.Action;
+    /**
+     * Time this ApprovalRequest was created.
+     */
+    created: string;
+    /**
+     * The URL to the dashboard for this ApprovalRequest.
+     */
+    dashboard_url?: string;
+    /**
+     * A description of the approval request.
+     */
+    description?: string;
+    /**
+     * The timestamp at which this ApprovalRequest will expire.
+     */
+    expires_at: string;
+    /**
+     * Whether this ApprovalRequest is livemode.
+     */
+    livemode: boolean;
+    /**
+     * The requester of this ApprovalRequest.
+     */
+    requested_by: V2.Core.ApprovalRequest.RequestedBy;
+    /**
+     * The review of this ApprovalRequest if it has been reviewed.
+     */
+    review?: V2.Core.ApprovalRequest.Review;
+    /**
+     * The rule associated with this ApprovalRequest.
+     */
+    rule?: V2.Core.ApprovalRequest.Rule;
+    /**
+     * The status of this ApprovalRequest.
+     */
+    status: V2.Core.ApprovalRequest.Status;
+    /**
+     * The details of the status of this ApprovalRequest.
+     */
+    status_details?: V2.Core.ApprovalRequest.StatusDetails;
+    /**
+     * The transitions of the status of this ApprovalRequest.
+     */
+    status_transitions?: V2.Core.ApprovalRequest.StatusTransitions;
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace ApprovalRequest {
+            type Action = 'charge.create' | 'dispute.close' | 'inbound_transfers.money_management.create' | 'invoice.create' | 'outbound_payments.money_management.create' | 'outbound_transfers.money_management.create' | 'payment_intent.create' | 'payment_intent.update' | 'payout.create' | 'price.update' | 'refund.create' | 'setup_intent.create' | 'subscription.create' | 'subscription.update' | 'topup.create' | 'transfer.create';
+            interface RequestedBy {
+                /**
+                 * Stripe-defined identifier for the requester (e.g. a restricted API key token).
+                 */
+                id: string;
+                /**
+                 * Merchant-defined name for the requester.
+                 */
+                name?: string;
+            }
+            interface Review {
+                /**
+                 * The reason provided by the reviewer.
+                 */
+                reason?: string;
+                /**
+                 * The result of the review.
+                 */
+                result: Review.Result;
+                /**
+                 * Timestamp when the review was performed.
+                 */
+                reviewed_at: string;
+                /**
+                 * The reviewer who performed the review.
+                 */
+                reviewed_by: Review.ReviewedBy;
+            }
+            interface Rule {
+                /**
+                 * The name of the rule.
+                 */
+                name: string;
+            }
+            type Status = 'approved' | 'canceled' | 'execution_failed' | 'execution_started' | 'execution_succeeded' | 'expired' | 'failed' | 'pending' | 'rejected' | 'requires_execution' | 'requires_review' | 'succeeded';
+            interface StatusDetails {
+                /**
+                 * Deprecated: use requires_execution status instead.
+                 */
+                approved?: StatusDetails.Approved;
+                /**
+                 * Deprecated: use canceled status instead.
+                 */
+                canceled?: StatusDetails.Canceled;
+                /**
+                 * Deprecated: use failed status instead.
+                 */
+                execution_failed?: StatusDetails.ExecutionFailed;
+                /**
+                 * Deprecated: use requires_execution status instead.
+                 */
+                execution_started?: StatusDetails.ExecutionStarted;
+                /**
+                 * Deprecated: use succeeded status instead.
+                 */
+                execution_succeeded?: StatusDetails.ExecutionSucceeded;
+                /**
+                 * Deprecated: use expired status instead.
+                 */
+                expired?: StatusDetails.Expired;
+                /**
+                 * Details when the approval request failed.
+                 */
+                failed?: StatusDetails.Failed;
+                /**
+                 * Deprecated: use requires_review status instead.
+                 */
+                pending?: StatusDetails.Pending;
+                /**
+                 * Deprecated: use rejected status instead.
+                 */
+                rejected?: StatusDetails.Rejected;
+                /**
+                 * Details when the approval request succeeded.
+                 */
+                succeeded?: StatusDetails.Succeeded;
+            }
+            interface StatusTransitions {
+                /**
+                 * Timestamp when the approval request was canceled.
+                 */
+                canceled_at?: string;
+                /**
+                 * Timestamp when the approval request expired.
+                 */
+                expired_at?: string;
+                /**
+                 * Timestamp when the approval request failed.
+                 */
+                failed_at?: string;
+                /**
+                 * Timestamp when the approval request was rejected.
+                 */
+                rejected_at?: string;
+                /**
+                 * Timestamp when the approval request moved to requires_execution status.
+                 */
+                requires_execution_at?: string;
+                /**
+                 * Timestamp when the approval request succeeded.
+                 */
+                succeeded_at?: string;
+            }
+            namespace Review {
+                type Result = 'approved' | 'rejected';
+                interface ReviewedBy {
+                    /**
+                     * Stripe-defined identifier for the reviewer (e.g. a restricted API key token).
+                     */
+                    id: string;
+                    /**
+                     * Merchant-defined name for the reviewer.
+                     */
+                    name: string;
+                }
+            }
+            namespace StatusDetails {
+                interface Approved {
+                    /**
+                     * The reason provided when approving the request.
+                     */
+                    reason?: string;
+                }
+                interface Canceled {
+                }
+                interface ExecutionFailed {
+                    /**
+                     * The error code for the failed execution.
+                     */
+                    code: string;
+                    /**
+                     * The error message for the failed execution.
+                     */
+                    message: string;
+                    /**
+                     * The error type for the failed execution.
+                     */
+                    type: string;
+                }
+                interface ExecutionStarted {
+                }
+                interface ExecutionSucceeded {
+                    /**
+                     * The result of the successful execution.
+                     */
+                    result: ExecutionSucceeded.Result;
+                }
+                interface Expired {
+                }
+                interface Failed {
+                    /**
+                     * The error code for the failed execution.
+                     */
+                    error_code: string;
+                    /**
+                     * The error message for the failed execution.
+                     */
+                    error_message: string;
+                    /**
+                     * The error type for the failed execution.
+                     */
+                    error_type: string;
+                }
+                interface Pending {
+                }
+                interface Rejected {
+                    /**
+                     * The reason provided when rejecting the request.
+                     */
+                    reason?: string;
+                }
+                interface Succeeded {
+                    /**
+                     * The result of the successful execution.
+                     */
+                    result: Succeeded.Result;
+                }
+                namespace ExecutionSucceeded {
+                    interface Result {
+                        /**
+                         * The unique identifier of the executed object.
+                         */
+                        id: string;
+                        /**
+                         * The object type of the executed resource.
+                         */
+                        object: string;
+                    }
+                }
+                namespace Succeeded {
+                    interface Result {
+                        /**
+                         * The unique identifier of the executed object.
+                         */
+                        id: string;
+                        /**
+                         * The object type of the executed resource.
+                         */
+                        object: string;
+                    }
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        interface ApprovalRequestRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        interface ApprovalRequestListParams {
+            /**
+             * Maximum number of results to return.
+             */
+            limit?: number;
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        interface ApprovalRequestCancelParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        interface ApprovalRequestExecuteParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        interface ApprovalRequestSubmitParams {
+            /**
+             * The reason for submitting the approval request.
+             */
+            reason?: string;
+        }
+    }
+}

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

@@ -0,0 +1,46 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApprovalRequestResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+class ApprovalRequestResource extends StripeResource_js_1.StripeResource {
+    /**
+     * GET /v2/core/approval_requests
+     * Lists approval requests with optional filtering.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/core/approval_requests', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * GET /v2/core/approval_requests/:id
+     * Retrieves an approval request by ID.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/core/approval_requests/${id}`, params, options);
+    }
+    /**
+     * POST /v2/core/approval_requests/:id/cancel
+     * Cancels a pending approval request.
+     */
+    cancel(id, params, options) {
+        return this._makeRequest('POST', `/v2/core/approval_requests/${id}/cancel`, params, options);
+    }
+    /**
+     * POST /v2/core/approval_requests/:id/execute
+     * Executes an approved approval request.
+     */
+    execute(id, params, options) {
+        return this._makeRequest('POST', `/v2/core/approval_requests/${id}/execute`, params, options);
+    }
+    /**
+     * POST /v2/core/approval_requests/:id/submit
+     * Moves a pending approval request into the reviewer queue for auto-execution upon approval.
+     */
+    submit(id, params, options) {
+        return this._makeRequest('POST', `/v2/core/approval_requests/${id}/submit`, params, options);
+    }
+}
+exports.ApprovalRequestResource = ApprovalRequestResource;
+//# sourceMappingURL=ApprovalRequests.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApprovalRequests.js","sourceRoot":"","sources":["../../../../src/resources/V2/Core/ApprovalRequests.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAG1D,MAAa,uBAAwB,SAAQ,kCAAc;IACzD;;;OAGG;IACH,IAAI,CACF,MAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,4BAA4B,EAC5B,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,QAAQ,CACN,EAAU,EACV,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,8BAA8B,EAAE,EAAE,EAClC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,MAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,8BAA8B,EAAE,SAAS,EACzC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,OAAO,CACL,EAAU,EACV,MAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,8BAA8B,EAAE,UAAU,EAC1C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,MAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,8BAA8B,EAAE,SAAS,EACzC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAnFD,0DAmFC"}