stripe 22.1.0 → 22.2.0-alpha.2

package/cjs/resources/V2/Iam/ActivityLogs.d.ts

@@ -0,0 +1,204 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { RequestOptions, ApiListPromise } from '../../../lib.js';
+export declare class ActivityLogResource extends StripeResource {
+    /**
+     * List activity logs of an account.
+     */
+    list(params?: V2.Iam.ActivityLogListParams, options?: RequestOptions): ApiListPromise<ActivityLog>;
+}
+export interface ActivityLog {
+    /**
+     * Unique identifier of the activity log entry.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.iam.activity_log';
+    /**
+     * The actor that performed the action.
+     */
+    actor: V2.Iam.ActivityLog.Actor;
+    /**
+     * The account on which the action was performed.
+     */
+    context: string;
+    /**
+     * Timestamp when the activity log entry was created.
+     */
+    created: string;
+    /**
+     * Action-specific details of the activity log entry.
+     */
+    details: V2.Iam.ActivityLog.Details;
+    /**
+     * Whether the action was performed in live mode.
+     */
+    livemode: boolean;
+    /**
+     * The type of action that was performed.
+     */
+    type: V2.Iam.ActivityLog.Type;
+}
+export declare namespace V2 {
+    namespace Iam {
+        namespace ActivityLog {
+            interface Actor {
+                /**
+                 * Set when the actor is an API key.
+                 */
+                api_key?: Actor.ApiKey;
+                /**
+                 * The type of actor.
+                 */
+                type: Actor.Type;
+                /**
+                 * Set when the actor is a user.
+                 */
+                user?: Actor.User;
+            }
+            interface Details {
+                /**
+                 * Details of an API key action.
+                 */
+                api_key?: Details.ApiKey;
+                /**
+                 * The action group type of the activity log entry.
+                 */
+                type: Details.Type;
+                /**
+                 * Details of a user invite action.
+                 */
+                user_invite?: Details.UserInvite;
+                /**
+                 * Details of a user role change action.
+                 */
+                user_roles?: Details.UserRoles;
+            }
+            type Type = 'api_key_created' | 'api_key_deleted' | 'api_key_updated' | 'api_key_viewed' | 'user_invite_accepted' | 'user_invite_created' | 'user_invite_deleted' | 'user_roles_deleted' | 'user_roles_updated';
+            namespace Actor {
+                interface ApiKey {
+                    /**
+                     * Unique identifier of the API key.
+                     */
+                    id: string;
+                }
+                type Type = 'api_key' | 'user';
+                interface User {
+                    /**
+                     * Email address of the user.
+                     */
+                    email: string;
+                }
+            }
+            namespace Details {
+                interface ApiKey {
+                    /**
+                     * Timestamp when the API key was created.
+                     */
+                    created: string;
+                    /**
+                     * Timestamp when the API key expires.
+                     */
+                    expires_at?: string;
+                    /**
+                     * Unique identifier of the API key.
+                     */
+                    id: string;
+                    /**
+                     * List of IP addresses allowed to use this API key.
+                     */
+                    ip_allowlist: Array<string>;
+                    /**
+                     * Information about the entity managing this API key.
+                     */
+                    managed_by?: ApiKey.ManagedBy;
+                    /**
+                     * Name of the API key.
+                     */
+                    name?: string;
+                    /**
+                     * Unique identifier of the new API key, set when this key was rotated.
+                     */
+                    new_key?: string;
+                    /**
+                     * Note or description for the API key.
+                     */
+                    note?: string;
+                    /**
+                     * Type of the API key.
+                     */
+                    type: ApiKey.Type;
+                }
+                type Type = 'api_key' | 'user_invite' | 'user_roles';
+                interface UserInvite {
+                    /**
+                     * Email address of the invited user.
+                     */
+                    invited_user_email: string;
+                    /**
+                     * Roles assigned to the invited user.
+                     */
+                    roles: Array<string>;
+                }
+                interface UserRoles {
+                    /**
+                     * Roles the user has after the change.
+                     */
+                    new_roles: Array<string>;
+                    /**
+                     * Roles the user had before the change.
+                     */
+                    old_roles: Array<string>;
+                    /**
+                     * Email address of the user whose roles were changed.
+                     */
+                    user_email: string;
+                }
+                namespace ApiKey {
+                    interface ManagedBy {
+                        /**
+                         * An application.
+                         */
+                        application?: ManagedBy.Application;
+                        /**
+                         * The type of entity.
+                         */
+                        type: 'application';
+                    }
+                    type Type = 'publishable_key' | 'secret_key';
+                    namespace ManagedBy {
+                        interface Application {
+                            /**
+                             * Identifier of the application.
+                             */
+                            id: string;
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Iam {
+        interface ActivityLogListParams {
+            /**
+             * Filter results to only include activity logs for the specified action group types.
+             */
+            action_groups?: Array<ActivityLogListParams.ActionGroup>;
+            /**
+             * Filter results to only include activity logs for the specified action types.
+             */
+            actions?: Array<ActivityLogListParams.Action>;
+            /**
+             * Maximum number of results to return per page.
+             */
+            limit?: number;
+        }
+        namespace ActivityLogListParams {
+            type ActionGroup = 'api_key' | 'user_invite' | 'user_roles';
+            type Action = 'api_key_created' | 'api_key_deleted' | 'api_key_updated' | 'api_key_viewed' | 'user_invite_accepted' | 'user_invite_created' | 'user_invite_deleted' | 'user_roles_deleted' | 'user_roles_updated';
+        }
+    }
+}

package/cjs/resources/V2/Iam/ActivityLogs.js

@@ -0,0 +1,17 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActivityLogResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+class ActivityLogResource extends StripeResource_js_1.StripeResource {
+    /**
+     * List activity logs of an account.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/iam/activity_logs', params, options, {
+            methodType: 'list',
+        });
+    }
+}
+exports.ActivityLogResource = ActivityLogResource;
+//# sourceMappingURL=ActivityLogs.js.map

package/cjs/resources/V2/Iam/ActivityLogs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActivityLogs.js","sourceRoot":"","sources":["../../../../src/resources/V2/Iam/ActivityLogs.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAG1D,MAAa,mBAAoB,SAAQ,kCAAc;IACrD;;OAEG;IACH,IAAI,CACF,MAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,uBAAuB,EAAE,MAAM,EAAE,OAAO,EAAE;YACxE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;CACF;AAZD,kDAYC"}

package/cjs/resources/V2/Iam/ApiKeys.d.ts

@@ -0,0 +1,280 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { RequestOptions, ApiListPromise, Response } from '../../../lib.js';
+export declare class ApiKeyResource extends StripeResource {
+    /**
+     * List all API Keys of an account.
+     */
+    list(params?: V2.Iam.ApiKeyListParams, options?: RequestOptions): ApiListPromise<ApiKey>;
+    /**
+     * Create an API Key. To create a secret key in livemode, a public key for encryption must be provided.
+     */
+    create(params: V2.Iam.ApiKeyCreateParams, options?: RequestOptions): Promise<Response<ApiKey>>;
+    /**
+     * Retrieve an API Key. For livemode secret keys, secret tokens are only returned on creation, and never returned here.
+     */
+    retrieve(id: string, params?: V2.Iam.ApiKeyRetrieveParams, options?: RequestOptions): Promise<Response<ApiKey>>;
+    /**
+     * Update an API Key. Only parameters that are specified in the request will be updated.
+     */
+    update(id: string, params?: V2.Iam.ApiKeyUpdateParams, options?: RequestOptions): Promise<Response<ApiKey>>;
+    /**
+     * Expire an API Key. The specified key becomes invalid immediately.
+     */
+    expire(id: string, params?: V2.Iam.ApiKeyExpireParams, options?: RequestOptions): Promise<Response<ApiKey>>;
+    /**
+     * Rotate an API Key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.
+     */
+    rotate(id: string, params?: V2.Iam.ApiKeyRotateParams, options?: RequestOptions): Promise<Response<ApiKey>>;
+}
+export interface ApiKey {
+    /**
+     * Unique identifier of the API key.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.iam.api_key';
+    /**
+     * Timestamp when the API key was created.
+     */
+    created: string;
+    /**
+     * Timestamp when the API key expires.
+     */
+    expires_at?: string;
+    /**
+     * List of IP addresses allowed to use this API key. Addresses use IPv4 protocol, and may be a CIDR range (e.g., [100.10.38.255, 100.10.38.0/24]).
+     */
+    ip_allowlist: Array<string>;
+    /**
+     * Timestamp when the API key was last used.
+     */
+    last_used?: 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;
+    /**
+     * Account that manages this API key (for keys managed by platforms).
+     */
+    managed_by?: V2.Iam.ApiKey.ManagedBy;
+    /**
+     * Name of the API key.
+     */
+    name?: string;
+    /**
+     * Note or description for the API key.
+     */
+    note?: string;
+    /**
+     * Token set for a publishable key.
+     */
+    publishable_key?: V2.Iam.ApiKey.PublishableKey;
+    /**
+     * Token set for a secret key.
+     */
+    secret_key?: V2.Iam.ApiKey.SecretKey;
+    /**
+     * Current status of the API key (e.g., active, expired).
+     */
+    status: V2.Iam.ApiKey.Status;
+    /**
+     * Type of the API key.
+     */
+    type: V2.Iam.ApiKey.Type;
+}
+export declare namespace V2 {
+    namespace Iam {
+        namespace ApiKey {
+            interface ManagedBy {
+                /**
+                 * An application.
+                 */
+                application?: ManagedBy.Application;
+                /**
+                 * The type of entity.
+                 */
+                type: 'application';
+            }
+            interface PublishableKey {
+                /**
+                 * The plaintext token for the API key.
+                 */
+                token: string;
+            }
+            interface SecretKey {
+                /**
+                 * The encrypted secret for the API key. Only included when a key is first created.
+                 */
+                encrypted_secret?: SecretKey.EncryptedSecret;
+                /**
+                 * Redacted version of the secret token for display purposes.
+                 */
+                secret_token_redacted?: string;
+                /**
+                 * The plaintext token for the API key. Only included for testmode keys.
+                 */
+                token?: string;
+            }
+            type Status = 'active' | 'expired';
+            type Type = 'publishable_key' | 'secret_key';
+            namespace ManagedBy {
+                interface Application {
+                    /**
+                     * Identifier of the application.
+                     */
+                    id: string;
+                }
+            }
+            namespace SecretKey {
+                interface EncryptedSecret {
+                    /**
+                     * The encrypted secret data in base64 format.
+                     */
+                    ciphertext: string;
+                    /**
+                     * The format of the encrypted secret (e.g., jwe_compact).
+                     */
+                    format: string;
+                    /**
+                     * The caller's identifier of the public key provided.
+                     */
+                    recipient_key_id?: string;
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Iam {
+        interface ApiKeyCreateParams {
+            /**
+             * Type of the API key to create (secret or publishable).
+             */
+            type: ApiKeyCreateParams.Type;
+            /**
+             * Name for the API key.
+             */
+            name?: string;
+            /**
+             * Note or description for the API key.
+             */
+            note?: string;
+            /**
+             * Public key for encrypting the API key secret.
+             * This must a PEM-formatted RSA key suitable for encryption, >= 2048 bits.
+             * A public key is required when creating secret keys.
+             * Publishable keys are not encrypted and a public key should not be included.
+             */
+            public_key?: ApiKeyCreateParams.PublicKey;
+        }
+        namespace ApiKeyCreateParams {
+            type Type = 'publishable_key' | 'secret_key';
+            interface PublicKey {
+                /**
+                 * Caller's identifier of the public key. This is used for tracking purposes only, and will be echoed in the response if provided.
+                 */
+                id?: string;
+                /**
+                 * PEM-formatted public key.
+                 */
+                pem_key?: PublicKey.PemKey;
+            }
+            namespace PublicKey {
+                interface PemKey {
+                    /**
+                     * The encryption algorithm used with this key (e.g., RSA).
+                     */
+                    algorithm: string;
+                    /**
+                     * The PEM-encoded public key data. Newlines are required between header/footer and body, and optional within the body.
+                     */
+                    data: string;
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Iam {
+        interface ApiKeyRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Iam {
+        interface ApiKeyUpdateParams {
+            /**
+             * Name to set for the API key. If blank, the field is left unchanged.
+             */
+            name?: string;
+            /**
+             * Note or description to set for the API key. If blank, the field is left unchanged.
+             */
+            note?: string;
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Iam {
+        interface ApiKeyListParams {
+            /**
+             * Whether to include expired API keys in the response.
+             */
+            include_expired?: boolean;
+            /**
+             * Limit of items to return per page.
+             */
+            limit?: number;
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Iam {
+        interface ApiKeyExpireParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Iam {
+        interface ApiKeyRotateParams {
+            /**
+             * Duration in minutes before the current key expires, with a maximum of 7 days (10080 minutes).
+             * If not provided, the current key expires immediately.
+             */
+            expire_current_key_in_minutes?: number;
+            /**
+             * Public key for encrypting the new API key secret.
+             * This must a PEM-formatted RSA key suitable for encryption, >= 2048 bits.
+             * A public key is required when rotating secret keys.
+             * Publishable keys are not encrypted and a public key should not be included.
+             */
+            public_key?: ApiKeyRotateParams.PublicKey;
+        }
+        namespace ApiKeyRotateParams {
+            interface PublicKey {
+                /**
+                 * Caller's identifier of the public key. This is used for tracking purposes only, and will be echoed in the response if provided.
+                 */
+                id?: string;
+                /**
+                 * PEM-formatted public key.
+                 */
+                pem_key?: PublicKey.PemKey;
+            }
+            namespace PublicKey {
+                interface PemKey {
+                    /**
+                     * The encryption algorithm used with this key (e.g., RSA).
+                     */
+                    algorithm: string;
+                    /**
+                     * The PEM-encoded public key data. Newlines are required between header/footer and body, and optional within the body.
+                     */
+                    data: string;
+                }
+            }
+        }
+    }
+}

package/cjs/resources/V2/Iam/ApiKeys.js

@@ -0,0 +1,47 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeyResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+class ApiKeyResource extends StripeResource_js_1.StripeResource {
+    /**
+     * List all API Keys of an account.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/iam/api_keys', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Create an API Key. To create a secret key in livemode, a public key for encryption must be provided.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v2/iam/api_keys', params, options);
+    }
+    /**
+     * Retrieve an API Key. For livemode secret keys, secret tokens are only returned on creation, and never returned here.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/iam/api_keys/${id}`, params, options);
+    }
+    /**
+     * Update an API Key. Only parameters that are specified in the request will be updated.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v2/iam/api_keys/${id}`, params, options);
+    }
+    /**
+     * Expire an API Key. The specified key becomes invalid immediately.
+     */
+    expire(id, params, options) {
+        return this._makeRequest('POST', `/v2/iam/api_keys/${id}/expire`, params, options);
+    }
+    /**
+     * Rotate an API Key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.
+     */
+    rotate(id, params, options) {
+        return this._makeRequest('POST', `/v2/iam/api_keys/${id}/rotate`, params, options);
+    }
+}
+exports.ApiKeyResource = ApiKeyResource;
+//# sourceMappingURL=ApiKeys.js.map

package/cjs/resources/V2/Iam/ApiKeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiKeys.js","sourceRoot":"","sources":["../../../../src/resources/V2/Iam/ApiKeys.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAG1D,MAAa,cAAe,SAAQ,kCAAc;IAChD;;OAEG;IACH,IAAI,CACF,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,OAAO,EAAE;YACnE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,kBAAkB,EAClB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,oBAAoB,EAAE,EAAE,EACxB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,oBAAoB,EAAE,EAAE,EACxB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,oBAAoB,EAAE,SAAS,EAC/B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,oBAAoB,EAAE,SAAS,EAC/B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAtFD,wCAsFC"}

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

@@ -0,0 +1,22 @@
+import { Stripe } from '../../../stripe.core.js';
+import { V2 as V2Namespace0, ActivityLog, ActivityLogResource } from './ActivityLogs.js';
+import { V2 as V2Namespace1, ApiKey, ApiKeyResource } from './ApiKeys.js';
+export { ActivityLog } from './ActivityLogs.js';
+export { ApiKey } from './ApiKeys.js';
+export declare class Iam {
+    private readonly stripe;
+    activityLogs: ActivityLogResource;
+    apiKeys: ApiKeyResource;
+    constructor(stripe: Stripe);
+}
+export declare namespace Iam {
+    export type ActivityLogListParams = V2Namespace0.Iam.ActivityLogListParams;
+    export { ActivityLog };
+    export type ApiKeyListParams = V2Namespace1.Iam.ApiKeyListParams;
+    export type ApiKeyCreateParams = V2Namespace1.Iam.ApiKeyCreateParams;
+    export type ApiKeyRetrieveParams = V2Namespace1.Iam.ApiKeyRetrieveParams;
+    export type ApiKeyUpdateParams = V2Namespace1.Iam.ApiKeyUpdateParams;
+    export type ApiKeyExpireParams = V2Namespace1.Iam.ApiKeyExpireParams;
+    export type ApiKeyRotateParams = V2Namespace1.Iam.ApiKeyRotateParams;
+    export { ApiKey };
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Iam = void 0;
+const ActivityLogs_js_1 = require("./ActivityLogs.js");
+const ApiKeys_js_1 = require("./ApiKeys.js");
+class Iam {
+    constructor(stripe) {
+        this.stripe = stripe;
+        this.activityLogs = new ActivityLogs_js_1.ActivityLogResource(stripe);
+        this.apiKeys = new ApiKeys_js_1.ApiKeyResource(stripe);
+    }
+}
+exports.Iam = Iam;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/V2/Iam/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,uDAI2B;AAC3B,6CAAwE;AAKxE,MAAa,GAAG;IAId,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,qCAAmB,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,OAAO,GAAG,IAAI,2BAAc,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;CACF;AARD,kBAQC"}