@delopay/sdk 0.56.1 → 0.58.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{chunk-G2TIZ4KS.js → chunk-2ZY2CLJC.js} +28 -1
- package/dist/chunk-2ZY2CLJC.js.map +1 -0
- package/dist/index.cjs +27 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +84 -3
- package/dist/index.d.ts +84 -3
- package/dist/index.js +1 -1
- package/dist/internal.cjs +27 -0
- package/dist/internal.cjs.map +1 -1
- package/dist/internal.d.cts +1 -1
- package/dist/internal.d.ts +1 -1
- package/dist/internal.js +1 -1
- package/package.json +1 -1
- package/dist/chunk-G2TIZ4KS.js.map +0 -1
package/dist/index.d.cts
CHANGED
|
@@ -1660,15 +1660,71 @@ interface SwitchProfileRequest {
|
|
|
1660
1660
|
}
|
|
1661
1661
|
interface InviteUsersRequest {
|
|
1662
1662
|
email: string;
|
|
1663
|
+
name: string;
|
|
1663
1664
|
role_id: string;
|
|
1664
1665
|
profile_ids?: string[];
|
|
1665
1666
|
}
|
|
1666
1667
|
interface InviteUsersResponse {
|
|
1667
1668
|
email: string;
|
|
1668
1669
|
is_email_sent: boolean;
|
|
1670
|
+
/**
|
|
1671
|
+
* Temporary password, present only when the invite email could not be
|
|
1672
|
+
* delivered. Shown once — share it with the invitee out of band. They are
|
|
1673
|
+
* forced to change it on first sign-in.
|
|
1674
|
+
*/
|
|
1669
1675
|
password?: string | null;
|
|
1670
1676
|
error?: string | null;
|
|
1671
1677
|
}
|
|
1678
|
+
interface AddUserRequest {
|
|
1679
|
+
email: string;
|
|
1680
|
+
name: string;
|
|
1681
|
+
/**
|
|
1682
|
+
* Password for the new member. Omit it to have the server generate one, which
|
|
1683
|
+
* is then returned once in `AddUserResponse.password`. Supplying it keeps the
|
|
1684
|
+
* password out of the response, since you already have it.
|
|
1685
|
+
*/
|
|
1686
|
+
password?: string;
|
|
1687
|
+
role_id: string;
|
|
1688
|
+
/**
|
|
1689
|
+
* Shop IDs to scope the role to, when `role_id` is a shop-scoped role. If
|
|
1690
|
+
* omitted, a shop-scoped role falls back to your current shop.
|
|
1691
|
+
*/
|
|
1692
|
+
profile_ids?: string[];
|
|
1693
|
+
}
|
|
1694
|
+
interface UpdateUserRoleRequest {
|
|
1695
|
+
email: string;
|
|
1696
|
+
role_id: string;
|
|
1697
|
+
/**
|
|
1698
|
+
* Shop whose membership to update. Send this when managing a shop's team as a
|
|
1699
|
+
* merchant-scoped admin: your token points at your own shop, not the one you
|
|
1700
|
+
* are viewing, so without it the member is looked up in the wrong shop and
|
|
1701
|
+
* appears not to be a member at all. Defaults to your own shop when omitted.
|
|
1702
|
+
*/
|
|
1703
|
+
profile_id?: string;
|
|
1704
|
+
}
|
|
1705
|
+
interface DeleteUserRoleRequest {
|
|
1706
|
+
email: string;
|
|
1707
|
+
/**
|
|
1708
|
+
* Shop to remove the member from. Send this when managing a shop's team as a
|
|
1709
|
+
* merchant-scoped admin: your token points at your own shop, not the one you
|
|
1710
|
+
* are viewing, so without it the removal targets the wrong shop and fails.
|
|
1711
|
+
* Defaults to your own shop when omitted.
|
|
1712
|
+
*/
|
|
1713
|
+
profile_id?: string;
|
|
1714
|
+
}
|
|
1715
|
+
interface AddUserResponse {
|
|
1716
|
+
user_id: string;
|
|
1717
|
+
email: string;
|
|
1718
|
+
name: string;
|
|
1719
|
+
is_verified: boolean;
|
|
1720
|
+
is_active: boolean;
|
|
1721
|
+
/**
|
|
1722
|
+
* Present only when the server generated the password (the request omitted
|
|
1723
|
+
* one). Shown once — it is stored hashed and cannot be read back. The member
|
|
1724
|
+
* is forced to change it on first sign-in.
|
|
1725
|
+
*/
|
|
1726
|
+
password?: string;
|
|
1727
|
+
}
|
|
1672
1728
|
interface TotpResponse {
|
|
1673
1729
|
secret?: {
|
|
1674
1730
|
secret: string;
|
|
@@ -4146,6 +4202,19 @@ declare class Users {
|
|
|
4146
4202
|
listMerchants(): Promise<Record<string, unknown>[]>;
|
|
4147
4203
|
listProfiles(): Promise<Record<string, unknown>[]>;
|
|
4148
4204
|
inviteUsers(params: InviteUsersRequest[]): Promise<InviteUsersResponse[]>;
|
|
4205
|
+
/**
|
|
4206
|
+
* Add a team member directly, without sending an invite email.
|
|
4207
|
+
* `POST /user/employees/add`
|
|
4208
|
+
*
|
|
4209
|
+
* Unlike `inviteUsers`, the account is active immediately and you hand over
|
|
4210
|
+
* the credentials yourself. Omit `password` to have the server generate one
|
|
4211
|
+
* and return it once in `password` on the response; supply your own and it is
|
|
4212
|
+
* not echoed back. Either way the member must change it on first sign-in.
|
|
4213
|
+
*
|
|
4214
|
+
* Same role rules as invite: you cannot grant a role above your own, and a
|
|
4215
|
+
* shop-scoped caller can only target their own shop.
|
|
4216
|
+
*/
|
|
4217
|
+
addUser(params: AddUserRequest): Promise<AddUserResponse>;
|
|
4149
4218
|
acceptInvitation(params: Record<string, unknown>): Promise<AuthResponse>;
|
|
4150
4219
|
/**
|
|
4151
4220
|
* Accept an invitation via the email-link flow.
|
|
@@ -4193,8 +4262,20 @@ declare class Users {
|
|
|
4193
4262
|
entity_type?: string;
|
|
4194
4263
|
}): Promise<Record<string, unknown>[]>;
|
|
4195
4264
|
listUserRoles(params?: Record<string, unknown>): Promise<Record<string, unknown>[]>;
|
|
4196
|
-
|
|
4197
|
-
|
|
4265
|
+
/**
|
|
4266
|
+
* Change a team member's role. `POST /user/employees/update-role`
|
|
4267
|
+
*
|
|
4268
|
+
* Pass `profile_id` to name the shop when managing a shop's team as a
|
|
4269
|
+
* merchant-scoped admin — see {@link UpdateUserRoleRequest.profile_id}.
|
|
4270
|
+
*/
|
|
4271
|
+
updateUserRole(params: UpdateUserRoleRequest): Promise<Record<string, unknown>>;
|
|
4272
|
+
/**
|
|
4273
|
+
* Remove a team member. `DELETE /user/employees/delete`
|
|
4274
|
+
*
|
|
4275
|
+
* Pass `profile_id` to name the shop when managing a shop's team as a
|
|
4276
|
+
* merchant-scoped admin — see {@link DeleteUserRoleRequest.profile_id}.
|
|
4277
|
+
*/
|
|
4278
|
+
deleteUserRole(params: DeleteUserRoleRequest): Promise<Record<string, unknown>>;
|
|
4198
4279
|
/** Sign in via OIDC. `POST /user/oidc` */
|
|
4199
4280
|
signInOidc(params: Record<string, unknown>): Promise<AuthResponse>;
|
|
4200
4281
|
/** Transfer key. `POST /user/key/transfer` */
|
|
@@ -5111,4 +5192,4 @@ declare function parseImportedBranding(raw: unknown): CheckoutBranding;
|
|
|
5111
5192
|
declare function applyBrandingVariables(el: HTMLElement, b: CheckoutBranding): void;
|
|
5112
5193
|
declare function shadowFor(style: SurfaceStyle): string;
|
|
5113
5194
|
|
|
5114
|
-
export { type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceRequest, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type NonPillRadius, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, decodeBadges, decodeBranding, defaultBranding, encodeBadges, encodeBranding, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, leaf, logoDimensions, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
|
|
5195
|
+
export { type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceRequest, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type NonPillRadius, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, decodeBadges, decodeBranding, defaultBranding, encodeBadges, encodeBranding, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, leaf, logoDimensions, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
|
package/dist/index.d.ts
CHANGED
|
@@ -1660,15 +1660,71 @@ interface SwitchProfileRequest {
|
|
|
1660
1660
|
}
|
|
1661
1661
|
interface InviteUsersRequest {
|
|
1662
1662
|
email: string;
|
|
1663
|
+
name: string;
|
|
1663
1664
|
role_id: string;
|
|
1664
1665
|
profile_ids?: string[];
|
|
1665
1666
|
}
|
|
1666
1667
|
interface InviteUsersResponse {
|
|
1667
1668
|
email: string;
|
|
1668
1669
|
is_email_sent: boolean;
|
|
1670
|
+
/**
|
|
1671
|
+
* Temporary password, present only when the invite email could not be
|
|
1672
|
+
* delivered. Shown once — share it with the invitee out of band. They are
|
|
1673
|
+
* forced to change it on first sign-in.
|
|
1674
|
+
*/
|
|
1669
1675
|
password?: string | null;
|
|
1670
1676
|
error?: string | null;
|
|
1671
1677
|
}
|
|
1678
|
+
interface AddUserRequest {
|
|
1679
|
+
email: string;
|
|
1680
|
+
name: string;
|
|
1681
|
+
/**
|
|
1682
|
+
* Password for the new member. Omit it to have the server generate one, which
|
|
1683
|
+
* is then returned once in `AddUserResponse.password`. Supplying it keeps the
|
|
1684
|
+
* password out of the response, since you already have it.
|
|
1685
|
+
*/
|
|
1686
|
+
password?: string;
|
|
1687
|
+
role_id: string;
|
|
1688
|
+
/**
|
|
1689
|
+
* Shop IDs to scope the role to, when `role_id` is a shop-scoped role. If
|
|
1690
|
+
* omitted, a shop-scoped role falls back to your current shop.
|
|
1691
|
+
*/
|
|
1692
|
+
profile_ids?: string[];
|
|
1693
|
+
}
|
|
1694
|
+
interface UpdateUserRoleRequest {
|
|
1695
|
+
email: string;
|
|
1696
|
+
role_id: string;
|
|
1697
|
+
/**
|
|
1698
|
+
* Shop whose membership to update. Send this when managing a shop's team as a
|
|
1699
|
+
* merchant-scoped admin: your token points at your own shop, not the one you
|
|
1700
|
+
* are viewing, so without it the member is looked up in the wrong shop and
|
|
1701
|
+
* appears not to be a member at all. Defaults to your own shop when omitted.
|
|
1702
|
+
*/
|
|
1703
|
+
profile_id?: string;
|
|
1704
|
+
}
|
|
1705
|
+
interface DeleteUserRoleRequest {
|
|
1706
|
+
email: string;
|
|
1707
|
+
/**
|
|
1708
|
+
* Shop to remove the member from. Send this when managing a shop's team as a
|
|
1709
|
+
* merchant-scoped admin: your token points at your own shop, not the one you
|
|
1710
|
+
* are viewing, so without it the removal targets the wrong shop and fails.
|
|
1711
|
+
* Defaults to your own shop when omitted.
|
|
1712
|
+
*/
|
|
1713
|
+
profile_id?: string;
|
|
1714
|
+
}
|
|
1715
|
+
interface AddUserResponse {
|
|
1716
|
+
user_id: string;
|
|
1717
|
+
email: string;
|
|
1718
|
+
name: string;
|
|
1719
|
+
is_verified: boolean;
|
|
1720
|
+
is_active: boolean;
|
|
1721
|
+
/**
|
|
1722
|
+
* Present only when the server generated the password (the request omitted
|
|
1723
|
+
* one). Shown once — it is stored hashed and cannot be read back. The member
|
|
1724
|
+
* is forced to change it on first sign-in.
|
|
1725
|
+
*/
|
|
1726
|
+
password?: string;
|
|
1727
|
+
}
|
|
1672
1728
|
interface TotpResponse {
|
|
1673
1729
|
secret?: {
|
|
1674
1730
|
secret: string;
|
|
@@ -4146,6 +4202,19 @@ declare class Users {
|
|
|
4146
4202
|
listMerchants(): Promise<Record<string, unknown>[]>;
|
|
4147
4203
|
listProfiles(): Promise<Record<string, unknown>[]>;
|
|
4148
4204
|
inviteUsers(params: InviteUsersRequest[]): Promise<InviteUsersResponse[]>;
|
|
4205
|
+
/**
|
|
4206
|
+
* Add a team member directly, without sending an invite email.
|
|
4207
|
+
* `POST /user/employees/add`
|
|
4208
|
+
*
|
|
4209
|
+
* Unlike `inviteUsers`, the account is active immediately and you hand over
|
|
4210
|
+
* the credentials yourself. Omit `password` to have the server generate one
|
|
4211
|
+
* and return it once in `password` on the response; supply your own and it is
|
|
4212
|
+
* not echoed back. Either way the member must change it on first sign-in.
|
|
4213
|
+
*
|
|
4214
|
+
* Same role rules as invite: you cannot grant a role above your own, and a
|
|
4215
|
+
* shop-scoped caller can only target their own shop.
|
|
4216
|
+
*/
|
|
4217
|
+
addUser(params: AddUserRequest): Promise<AddUserResponse>;
|
|
4149
4218
|
acceptInvitation(params: Record<string, unknown>): Promise<AuthResponse>;
|
|
4150
4219
|
/**
|
|
4151
4220
|
* Accept an invitation via the email-link flow.
|
|
@@ -4193,8 +4262,20 @@ declare class Users {
|
|
|
4193
4262
|
entity_type?: string;
|
|
4194
4263
|
}): Promise<Record<string, unknown>[]>;
|
|
4195
4264
|
listUserRoles(params?: Record<string, unknown>): Promise<Record<string, unknown>[]>;
|
|
4196
|
-
|
|
4197
|
-
|
|
4265
|
+
/**
|
|
4266
|
+
* Change a team member's role. `POST /user/employees/update-role`
|
|
4267
|
+
*
|
|
4268
|
+
* Pass `profile_id` to name the shop when managing a shop's team as a
|
|
4269
|
+
* merchant-scoped admin — see {@link UpdateUserRoleRequest.profile_id}.
|
|
4270
|
+
*/
|
|
4271
|
+
updateUserRole(params: UpdateUserRoleRequest): Promise<Record<string, unknown>>;
|
|
4272
|
+
/**
|
|
4273
|
+
* Remove a team member. `DELETE /user/employees/delete`
|
|
4274
|
+
*
|
|
4275
|
+
* Pass `profile_id` to name the shop when managing a shop's team as a
|
|
4276
|
+
* merchant-scoped admin — see {@link DeleteUserRoleRequest.profile_id}.
|
|
4277
|
+
*/
|
|
4278
|
+
deleteUserRole(params: DeleteUserRoleRequest): Promise<Record<string, unknown>>;
|
|
4198
4279
|
/** Sign in via OIDC. `POST /user/oidc` */
|
|
4199
4280
|
signInOidc(params: Record<string, unknown>): Promise<AuthResponse>;
|
|
4200
4281
|
/** Transfer key. `POST /user/key/transfer` */
|
|
@@ -5111,4 +5192,4 @@ declare function parseImportedBranding(raw: unknown): CheckoutBranding;
|
|
|
5111
5192
|
declare function applyBrandingVariables(el: HTMLElement, b: CheckoutBranding): void;
|
|
5112
5193
|
declare function shadowFor(style: SurfaceStyle): string;
|
|
5113
5194
|
|
|
5114
|
-
export { type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceRequest, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type NonPillRadius, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, decodeBadges, decodeBranding, defaultBranding, encodeBadges, encodeBranding, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, leaf, logoDimensions, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
|
|
5195
|
+
export { type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceRequest, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type NonPillRadius, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, decodeBadges, decodeBranding, defaultBranding, encodeBadges, encodeBranding, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, leaf, logoDimensions, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
|
package/dist/index.js
CHANGED
package/dist/internal.cjs
CHANGED
|
@@ -2310,6 +2310,21 @@ var Users = class {
|
|
|
2310
2310
|
async inviteUsers(params) {
|
|
2311
2311
|
return this.request("POST", "/user/employees/invite", { body: params });
|
|
2312
2312
|
}
|
|
2313
|
+
/**
|
|
2314
|
+
* Add a team member directly, without sending an invite email.
|
|
2315
|
+
* `POST /user/employees/add`
|
|
2316
|
+
*
|
|
2317
|
+
* Unlike `inviteUsers`, the account is active immediately and you hand over
|
|
2318
|
+
* the credentials yourself. Omit `password` to have the server generate one
|
|
2319
|
+
* and return it once in `password` on the response; supply your own and it is
|
|
2320
|
+
* not echoed back. Either way the member must change it on first sign-in.
|
|
2321
|
+
*
|
|
2322
|
+
* Same role rules as invite: you cannot grant a role above your own, and a
|
|
2323
|
+
* shop-scoped caller can only target their own shop.
|
|
2324
|
+
*/
|
|
2325
|
+
async addUser(params) {
|
|
2326
|
+
return this.request("POST", "/user/employees/add", { body: params });
|
|
2327
|
+
}
|
|
2313
2328
|
async acceptInvitation(params) {
|
|
2314
2329
|
return this.request("POST", "/user/employees/invite/accept", { body: params });
|
|
2315
2330
|
}
|
|
@@ -2381,9 +2396,21 @@ var Users = class {
|
|
|
2381
2396
|
async listUserRoles(params) {
|
|
2382
2397
|
return this.request("POST", "/user/employees", { body: params });
|
|
2383
2398
|
}
|
|
2399
|
+
/**
|
|
2400
|
+
* Change a team member's role. `POST /user/employees/update-role`
|
|
2401
|
+
*
|
|
2402
|
+
* Pass `profile_id` to name the shop when managing a shop's team as a
|
|
2403
|
+
* merchant-scoped admin — see {@link UpdateUserRoleRequest.profile_id}.
|
|
2404
|
+
*/
|
|
2384
2405
|
async updateUserRole(params) {
|
|
2385
2406
|
return this.request("POST", "/user/employees/update-role", { body: params });
|
|
2386
2407
|
}
|
|
2408
|
+
/**
|
|
2409
|
+
* Remove a team member. `DELETE /user/employees/delete`
|
|
2410
|
+
*
|
|
2411
|
+
* Pass `profile_id` to name the shop when managing a shop's team as a
|
|
2412
|
+
* merchant-scoped admin — see {@link DeleteUserRoleRequest.profile_id}.
|
|
2413
|
+
*/
|
|
2387
2414
|
async deleteUserRole(params) {
|
|
2388
2415
|
return this.request("DELETE", "/user/employees/delete", { body: params });
|
|
2389
2416
|
}
|