feat!: rename params types from <Action><Resource>Params to <Resource><Action>Params

reason: better sorting in go documentation

Author: angelofallars

README.md

@@ -47,7 +47,7 @@ func main() {
 	payrexClient := payrex.NewClient(os.Getenv("PAYREX_API_KEY"))
 
 	// Create a PaymentIntent
-	paymentIntent, err := payrexClient.PaymentIntents.Create(&payrex.CreatePaymentIntentParams{
+	paymentIntent, err := payrexClient.PaymentIntents.Create(&payrex.PaymentIntentCreateParams{
 		Amount:      100_00, // represents ₱100.00
 		Currency:    payrex.CurrencyPHP,
 		Description: payrex.NotNil("Dino Treat"),

billing_statement_line_item.go

@@ -30,7 +30,7 @@ func (s *ServiceBillingStatementLineItems) setup() {
 // Endpoint: POST /billing_statement_line_items
 //
 // API reference: https://docs.payrexhq.com/docs/api/billing_statement_line_items/create
-func (s *ServiceBillingStatementLineItems) Create(params *CreateBillingStatementLineItemParams) (*BillingStatementLineItem, error) {
+func (s *ServiceBillingStatementLineItems) Create(params *BillingStatementLineItemCreateParams) (*BillingStatementLineItem, error) {
 	return s.create(params)
 }
 
@@ -39,7 +39,7 @@ func (s *ServiceBillingStatementLineItems) Create(params *CreateBillingStatement
 // Endpoint: PUT /billing_statement_line_items/:id
 //
 // API reference: https://docs.payrexhq.com/docs/api/billing_statement_line_items/update
-func (s *ServiceBillingStatementLineItems) Update(id string, params *UpdateBillingStatementLineItemParams) (*BillingStatementLineItem, error) {
+func (s *ServiceBillingStatementLineItems) Update(id string, params *BillingStatementLineItemUpdateParams) (*BillingStatementLineItem, error) {
 	return s.update(id, params)
 }
 
@@ -52,20 +52,20 @@ func (s *ServiceBillingStatementLineItems) Delete(id string) (*DeletedResource,
 	return s.delete(id)
 }
 
-// CreateBillingStatementLineItemParams represents the available [ServiceBillingStatementLineItems.Create] parameters.
+// BillingStatementLineItemCreateParams represents the available [ServiceBillingStatementLineItems.Create] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/billing_statement_line_items/create
-type CreateBillingStatementLineItemParams struct {
+type BillingStatementLineItemCreateParams struct {
 	BillingStatementID string `form:"billing_statement_id"`
 	Description        string `form:"description"`
 	UnitPrice          int    `form:"unit_price"`
 	Quantity           int    `form:"quantity"`
 }
 
-// UpdateBillingStatementLineItemParams represents the available [ServiceBillingStatementLineItems.Update] parameters.
+// BillingStatementLineItemUpdateParams represents the available [ServiceBillingStatementLineItems.Update] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/billing_statement_line_items/update
-type UpdateBillingStatementLineItemParams struct {
+type BillingStatementLineItemUpdateParams struct {
 	Description *string `form:"description"`
 	UnitPrice   *int    `form:"unit_price"`
 	Quantity    *int    `form:"quantity"`

checkout_session.go

@@ -55,7 +55,7 @@ func (s *ServiceCheckoutSessions) setup() {
 // Endpoint: POST /checkout_sessions
 //
 // API reference: https://docs.payrexhq.com/docs/api/checkout_sessions/create
-func (s *ServiceCheckoutSessions) Create(params *CreateCheckoutSessionParams) (*CheckoutSession, error) {
+func (s *ServiceCheckoutSessions) Create(params *CheckoutSessionCreateParams) (*CheckoutSession, error) {
 	return s.create(params)
 }
 
@@ -88,10 +88,10 @@ func (s *ServiceCheckoutSessions) Expire(id string) (*CheckoutSession, error) {
 	return s.postID(id, "expire", nil)
 }
 
-// CreateCheckoutSessionParams represents the available [ServiceCheckoutSessions.Create] parameters.
+// CheckoutSessionCreateParams represents the available [ServiceCheckoutSessions.Create] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/checkout_sessions/create
-type CreateCheckoutSessionParams struct {
+type CheckoutSessionCreateParams struct {
 	CustomerReferenceID      *string                         `form:"customer_reference_id"`
 	Currency                 Currency                        `form:"currency"`
 	LineItems                []CheckoutSessionLineItemParams `form:"line_items"`

customer.go

@@ -32,7 +32,7 @@ func (s *ServiceCustomers) setup() {
 // Endpoint: POST /customers
 //
 // API reference: https://docs.payrexhq.com/docs/api/customers/create
-func (s *ServiceCustomers) Create(params *CreateCustomerParams) (*Customer, error) {
+func (s *ServiceCustomers) Create(params *CustomerCreateParams) (*Customer, error) {
 	return s.create(params)
 }
 
@@ -50,7 +50,7 @@ func (s *ServiceCustomers) Retrieve(id string) (*Customer, error) {
 // Endpoint: GET /customers
 //
 // API reference: https://docs.payrexhq.com/docs/api/customers/list
-func (s *ServiceCustomers) List(params *ListCustomersParams) (*Listing[Customer], error) {
+func (s *ServiceCustomers) List(params *CustomerListParams) (*Listing[Customer], error) {
 	return s.list(params)
 }
 
@@ -59,7 +59,7 @@ func (s *ServiceCustomers) List(params *ListCustomersParams) (*Listing[Customer]
 // Endpoint: PUT /customers/:id
 //
 // API reference: https://docs.payrexhq.com/docs/api/customers/update
-func (s *ServiceCustomers) Update(id string, params *UpdateCustomerParams) (*Customer, error) {
+func (s *ServiceCustomers) Update(id string, params *CustomerUpdateParams) (*Customer, error) {
 	return s.update(id, params)
 }
 
@@ -74,10 +74,10 @@ func (s *ServiceCustomers) Delete(id string) (*DeletedResource, error) {
 	return s.delete(id)
 }
 
-// CreateCustomerParams represents the available [ServiceCustomers.Create] parameters.
+// CustomerCreateParams represents the available [ServiceCustomers.Create] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/customers/create
-type CreateCustomerParams struct {
+type CustomerCreateParams struct {
 	Currency                           Currency           `form:"currency"`
 	Name                               string             `form:"name"`
 	Email                              string             `form:"email"`
@@ -86,10 +86,10 @@ type CreateCustomerParams struct {
 	Metadata                           *map[string]string `form:"metadata"`
 }
 
-// ListCustomersParams represents the available [ServiceCustomers.List] parameters.
+// CustomerListParams represents the available [ServiceCustomers.List] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/customers/list
-type ListCustomersParams struct {
+type CustomerListParams struct {
 	Limit    *int               `form:"int"`
 	Before   *string            `form:"before"`
 	After    *string            `form:"after"`
@@ -98,10 +98,10 @@ type ListCustomersParams struct {
 	Metadata *map[string]string `form:"metadata"`
 }
 
-// UpdateCustomerParams represents the available [ServiceCustomers.Update] parameters.
+// CustomerUpdateParams represents the available [ServiceCustomers.Update] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/customers/update
-type UpdateCustomerParams struct {
+type CustomerUpdateParams struct {
 	Currency                           *Currency          `form:"currency"`
 	Name                               *string            `form:"name"`
 	Email                              *string            `form:"email"`

customer_session.go

@@ -39,7 +39,7 @@ func (s *ServiceCustomerSessions) setup() {
 // Endpoint: POST /customer_sessions
 //
 // API reference: https://docs.payrexhq.com/docs/api/customer_sessions/create
-func (s *ServiceCustomerSessions) Create(params *CreateCustomerSessionParams) (*CustomerSession, error) {
+func (s *ServiceCustomerSessions) Create(params *CustomerSessionCreateParams) (*CustomerSession, error) {
 	return s.create(params)
 }
 
@@ -52,9 +52,9 @@ func (s *ServiceCustomerSessions) Retrieve(id string) (*CustomerSession, error)
 	return s.retrieve(id)
 }
 
-// CreateCustomerSessionParams represents the available [ServiceCustomerSessions.Create] parameters.
+// CustomerSessionCreateParams represents the available [ServiceCustomerSessions.Create] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/customer_sessions/create
-type CreateCustomerSessionParams struct {
+type CustomerSessionCreateParams struct {
 	CustomerID string `form:"customer_id"`
 }

payment.go

@@ -74,14 +74,14 @@ func (s *ServicePayments) Retrieve(id string) (*Payment, error) {
 // Endpoint: PUT /payments/:id
 //
 // API reference: https://docs.payrexhq.com/docs/api/payments/update
-func (s *ServicePayments) Update(id string, params *UpdatePaymentParams) (*Payment, error) {
+func (s *ServicePayments) Update(id string, params *PaymentUpdateParams) (*Payment, error) {
 	return s.update(id, params)
 }
 
-// UpdatePaymentParams represents the available [ServicePayments.Update] parameters.
+// PaymentUpdateParams represents the available [ServicePayments.Update] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/payments/update
-type UpdatePaymentParams struct {
+type PaymentUpdateParams struct {
 	Description *string            `form:"description"`
 	Metadata    *map[string]string `form:"metadata"`
 }

payment_intent.go

@@ -68,7 +68,7 @@ func (s *ServicePaymentIntents) Cancel(id string) (*PaymentIntent, error) {
 // Endpoint: POST /payment_intents/:id/capture
 //
 // API reference: https://docs.payrexhq.com/docs/api/payment_intents/capture
-func (s *ServicePaymentIntents) Capture(id string, params *CapturePaymentIntentParams) (*PaymentIntent, error) {
+func (s *ServicePaymentIntents) Capture(id string, params *PaymentIntentCaptureParams) (*PaymentIntent, error) {
 	if params == nil {
 		return nil, ErrNilParams
 	}
@@ -81,7 +81,7 @@ func (s *ServicePaymentIntents) Capture(id string, params *CapturePaymentIntentP
 // Endpoint: POST /payment_intents
 //
 // API reference: https://docs.payrexhq.com/docs/api/payment_intents/create
-func (s *ServicePaymentIntents) Create(params *CreatePaymentIntentParams) (*PaymentIntent, error) {
+func (s *ServicePaymentIntents) Create(params *PaymentIntentCreateParams) (*PaymentIntent, error) {
 	return s.create(params)
 }
 
@@ -94,17 +94,17 @@ func (s *ServicePaymentIntents) Retrieve(id string) (*PaymentIntent, error) {
 	return s.retrieve(id)
 }
 
-// CapturePaymentIntentParams represents the available [ServicePaymentIntents.Capture] parameters.
+// PaymentIntentCaptureParams represents the available [ServicePaymentIntents.Capture] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/payment_intents/capture
-type CapturePaymentIntentParams struct {
+type PaymentIntentCaptureParams struct {
 	Amount int `form:"amount"`
 }
 
-// CreatePaymentIntentParams represents the available [ServicePaymentIntents.Create] parameters.
+// PaymentIntentCreateParams represents the available [ServicePaymentIntents.Create] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/payment_intents/create
-type CreatePaymentIntentParams struct {
+type PaymentIntentCreateParams struct {
 	Amount               int                   `form:"amount"`
 	PaymentMethods       []PaymentMethod       `form:"payment_methods"`
 	Currency             Currency              `form:"currency"`

payout.go

@@ -73,18 +73,18 @@ func (s *ServicePayouts) setup() {
 // Endpoint: GET /payouts/:id/transactions
 //
 // API reference: https://docs.payrexhq.com/docs/api/payout_transactions/list
-func (s *ServicePayouts) ListTransactions(id string, params *ListPayoutTransactionsParams) (*Listing[PayoutTransaction], error) {
+func (s *ServicePayouts) ListTransactions(id string, params *PayoutTransactionListParams) (*Listing[PayoutTransaction], error) {
 	return request[Listing[PayoutTransaction]](s.client,
 		http.MethodGet,
 		s.path.make(id, "transactions"),
 		params,
 	)
 }
 
-// ListPayoutTransactionsParams represents the available [ServicePayouts.ListTransactions] parameters.
+// PayoutTransactionListParams represents the available [ServicePayouts.ListTransactions] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/payout_transactions/list
-type ListPayoutTransactionsParams struct {
+type PayoutTransactionListParams struct {
 	Limit  *int    `form:"limit"`
 	Before *string `form:"before"`
 	After  *string `form:"after"`

refund.go

@@ -53,7 +53,7 @@ func (s *ServiceRefunds) setup() {
 // Endpoint: POST /refunds
 //
 // API reference: https://docs.payrexhq.com/docs/api/refunds/create
-func (s *ServiceRefunds) Create(params *CreateRefundParams) (*Refund, error) {
+func (s *ServiceRefunds) Create(params *RefundCreateParams) (*Refund, error) {
 	return s.create(params)
 }
 
@@ -62,14 +62,14 @@ func (s *ServiceRefunds) Create(params *CreateRefundParams) (*Refund, error) {
 // Endpoint: PUT /refunds/:id
 //
 // API reference: https://docs.payrexhq.com/docs/api/refunds/update
-func (s *ServiceRefunds) Update(id string, params *UpdateRefundParams) (*Refund, error) {
+func (s *ServiceRefunds) Update(id string, params *RefundUpdateParams) (*Refund, error) {
 	return s.update(id, params)
 }
 
-// CreateRefundParams represents the available [ServiceRefunds.Create] parameters.
+// RefundCreateParams represents the available [ServiceRefunds.Create] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/refunds/create
-type CreateRefundParams struct {
+type RefundCreateParams struct {
 	Amount      int                `form:"amount"`
 	Currency    Currency           `form:"currency"`
 	Description *string            `form:"description"`
@@ -79,9 +79,9 @@ type CreateRefundParams struct {
 	Metadata    *map[string]string `form:"metadata"`
 }
 
-// UpdateRefundParams represents the available [ServiceRefunds.Update] parameters.
+// RefundUpdateParams represents the available [ServiceRefunds.Update] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/refunds/update
-type UpdateRefundParams struct {
+type RefundUpdateParams struct {
 	Metadata *map[string]string `form:"metadata"`
 }

webhook.go

@@ -35,7 +35,7 @@ func (s *ServiceWebhooks) setup() {
 // Endpoint: POST /webhooks
 //
 // API reference: https://docs.payrexhq.com/docs/api/webhooks/create
-func (s *ServiceWebhooks) Create(params *CreateWebhookParams) (*Webhook, error) {
+func (s *ServiceWebhooks) Create(params *WebhookCreateParams) (*Webhook, error) {
 	return s.create(params)
 }
 
@@ -53,7 +53,7 @@ func (s *ServiceWebhooks) Retrieve(id string) (*Webhook, error) {
 // Endpoint: GET /webhooks
 //
 // API reference: https://docs.payrexhq.com/docs/api/webhooks/list
-func (s *ServiceWebhooks) List(params *ListWebhooksParams) (*Listing[Webhook], error) {
+func (s *ServiceWebhooks) List(params *WebhookListParams) (*Listing[Webhook], error) {
 	return s.list(params)
 }
 
@@ -62,7 +62,7 @@ func (s *ServiceWebhooks) List(params *ListWebhooksParams) (*Listing[Webhook], e
 // Endpoint: PUT /webhooks/:id
 //
 // API reference: https://docs.payrexhq.com/docs/api/webhooks/update
-func (s *ServiceWebhooks) Update(id string, params *UpdateWebhookParams) (*Webhook, error) {
+func (s *ServiceWebhooks) Update(id string, params *WebhookUpdateParams) (*Webhook, error) {
 	return s.update(id, params)
 }
 
@@ -93,28 +93,28 @@ func (s *ServiceWebhooks) Delete(id string) (*DeletedResource, error) {
 	return s.delete(id)
 }
 
-// CreateWebhookParams represents the available [ServiceWebhooks.Create] parameters.
+// WebhookCreateParams represents the available [ServiceWebhooks.Create] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/webhooks/create
-type CreateWebhookParams struct {
+type WebhookCreateParams struct {
 	URL         string      `form:"url"`
 	Description *string     `form:"description"`
 	Events      []EventType `form:"events"`
 }
 
-// UpdateWebhookParams represents the available [ServiceWebhooks.Update] parameters.
+// WebhookUpdateParams represents the available [ServiceWebhooks.Update] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/webhooks/update
-type UpdateWebhookParams struct {
+type WebhookUpdateParams struct {
 	URL         *string      `form:"url"`
 	Description *string      `form:"description"`
 	Events      *[]EventType `form:"events"`
 }
 
-// ListWebhooksParams represents the available [ServiceWebhooks.List] parameters.
+// WebhookListParams represents the available [ServiceWebhooks.List] parameters.
 //
 // API reference: https://docs.payrexhq.com/docs/api/webhooks/list
-type ListWebhooksParams struct {
+type WebhookListParams struct {
 	Limit       *int    `form:"int"`
 	Before      *string `form:"before"`
 	After       *string `form:"after"`