Skip to content

Standardize parameter interface names#2025

Merged
pakrym-stripe merged 3 commits intomasterfrom
pakrym/Standardize_parameter_interface_names
Feb 22, 2024
Merged

Standardize parameter interface names#2025
pakrym-stripe merged 3 commits intomasterfrom
pakrym/Standardize_parameter_interface_names

Conversation

@pakrym-stripe
Copy link
Copy Markdown
Contributor

@pakrym-stripe pakrym-stripe commented Feb 22, 2024

Standardizes param class names to <ResourceName><MethodName>Params.

Adds type-forwards to preserve existing types.

Changelog

  • CapabilityListParams renamed to AccountListCapabilitiesParams
  • CapabilityRetrieveParams renamed to AccountRetrieveCapabilityParams
  • CapabilityUpdateParams renamed to AccountUpdateCapabilityParams
  • CashBalanceRetrieveParams renamed to CustomerRetrieveCashBalanceParams
  • CashBalanceUpdateParams renamed to CustomerUpdateCashBalanceParams
  • CreditNoteLineItemListParams renamed to CreditNoteListLineItemsParams
  • CustomerBalanceTransactionCreateParams renamed to CustomerCreateBalanceTransactionParams
  • CustomerBalanceTransactionListParams renamed to CustomerListBalanceTransactionsParams
  • CustomerBalanceTransactionRetrieveParams renamed to CustomerRetrieveBalanceTransactionParams
  • CustomerBalanceTransactionUpdateParams renamed to CustomerUpdateBalanceTransactionParams
  • CustomerCashBalanceTransactionListParams renamed to CustomerListCashBalanceTransactionsParams
  • CustomerCashBalanceTransactionRetrieveParams renamed to CustomerRetrieveCashBalanceTransactionParams
  • CustomerSourceCreateParams renamed to CustomerCreateSourceParams
  • CustomerSourceDeleteParams renamed to CustomerDeleteSourceParams
  • CustomerSourceListParams renamed to CustomerListSourcesParams
  • CustomerSourceRetrieveParams renamed to CustomerRetrieveSourceParams
  • CustomerSourceUpdateParams renamed to CustomerUpdateSourceParams
  • CustomerSourceVerifyParams renamed to CustomerVerifySourceParams
  • ExternalAccountCreateParams renamed to AccountCreateExternalAccountParams
  • ExternalAccountDeleteParams renamed to AccountDeleteExternalAccountParams
  • ExternalAccountListParams renamed to AccountListExternalAccountsParams
  • ExternalAccountRetrieveParams renamed to AccountRetrieveExternalAccountParams
  • ExternalAccountUpdateParams renamed to AccountUpdateExternalAccountParams
  • FeeRefundCreateParams renamed to ApplicationFeeCreateRefundParams
  • FeeRefundListParams renamed to ApplicationFeeListRefundsParams
  • FeeRefundRetrieveParams renamed to ApplicationFeeRetrieveRefundParams
  • FeeRefundUpdateParams renamed to ApplicationFeeUpdateRefundParams
  • InvoiceLineItemListParams renamed to InvoiceListLineItemsParams
  • InvoiceLineItemUpdateParams renamed to InvoiceUpdateLineItemParams
  • LoginLinkCreateParams renamed to AccountCreateLoginLinkParams
  • PersonCreateParams renamed to AccountCreatePersonParams
  • PersonDeleteParams renamed to AccountDeletePersonParams
  • PersonListParams renamed to AccountListPersonsParams
  • PersonRetrieveParams renamed to AccountRetrievePersonParams
  • PersonUpdateParams renamed to AccountUpdatePersonParams
  • TaxIdCreateParams renamed to CustomerCreateTaxIdParams
  • TaxIdDeleteParams renamed to CustomerDeleteTaxIdParams
  • TaxIdListParams renamed to CustomerListTaxIdsParams
  • TaxIdRetrieveParams renamed to CustomerRetrieveTaxIdParams
  • TransferReversalCreateParams renamed to TransferCreateReversalParams
  • TransferReversalListParams renamed to TransferListReversalsParams
  • TransferReversalRetrieveParams renamed to TransferRetrieveReversalParams
  • TransferReversalUpdateParams renamed to TransferUpdateReversalParams
  • UsageRecordCreateParams renamed to SubscriptionItemCreateUsageRecordParams
  • UsageRecordSummaryListParams renamed to SubscriptionItemListUsageRecordSummariesParams

Old names will still work but are deprecated and will be removed in future versions.

@pakrym-stripe pakrym-stripe marked this pull request as draft February 22, 2024 15:38
…rdCreateParams and UsageRecordSummaryListParams imports in typescriptTest.ts.
@pakrym-stripe pakrym-stripe marked this pull request as ready for review February 22, 2024 17:28
Copy link
Copy Markdown
Contributor

@anniel-stripe anniel-stripe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this!

@pakrym-stripe pakrym-stripe merged commit 1798bb2 into master Feb 22, 2024
@pakrym-stripe pakrym-stripe deleted the pakrym/Standardize_parameter_interface_names branch February 22, 2024 17:38
gurus00 pushed a commit to gurus00/stripe-node that referenced this pull request Feb 11, 2025
gurus00 pushed a commit to gurus00/stripe-node that referenced this pull request Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants