operations

type ApplicationFee struct {
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount components.Amount `json:"amount"`
	// The description of the application fee. This will appear on settlement reports towards both you and the
	// connected merchant.
	Description string `json:"description"`
}

type CancelPaymentRequest struct {
	// Provide the ID of the related payment.
	PaymentID string `pathParam:"style=simple,explode=false,name=paymentId"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                   `header:"style=simple,explode=false,name=idempotency-key"`
	RequestBody    *CancelPaymentRequestBody `request:"mediaType=application/json"`
}

type CancelPaymentRequestBody struct {
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
}

type CancelPaymentResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The canceled payment object.
	PaymentResponse *components.PaymentResponse
}

type CancelRefundRequest struct {
	// Provide the ID of the related payment.
	PaymentID string `pathParam:"style=simple,explode=false,name=paymentId"`
	// Provide the ID of the related refund.
	RefundID string `pathParam:"style=simple,explode=false,name=refundId"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type CancelRefundResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// An empty response if the refund was successfully canceled.
	Any any
}

type CancelSubscriptionRequest struct {
	// Provide the ID of the related customer.
	CustomerID string `pathParam:"style=simple,explode=false,name=customerId"`
	// Provide the ID of the related subscription.
	SubscriptionID string `pathParam:"style=simple,explode=false,name=subscriptionId"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                        `header:"style=simple,explode=false,name=idempotency-key"`
	RequestBody    *CancelSubscriptionRequestBody `request:"mediaType=application/json"`
}

type CancelSubscriptionRequestBody struct {
	// Most API credentials are specifically created for either live mode or test mode. For organization-level credentials
	// such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `json:"testmode,omitempty"`
}

type CancelSubscriptionResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The updated subscription object with status `canceled`. For a complete reference of the subscription object,
	// refer to the [Get subscription endpoint](get-subscription) documentation.
	SubscriptionResponse *components.SubscriptionResponse
}

type Client struct {
	// Indicates the response contains a client object. Will always contain the string `client` for this resource type.
	Resource *string `json:"resource,omitempty"`
	// The identifier uniquely referring to this client. Example: `org_12345678`.
	ID *string `json:"id,omitempty"`
	// The commission object.
	Commission *ListClientsCommission `json:"commission,omitempty"`
	// The date and time the client organization was created, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
	// format.
	OrganizationCreatedAt *string `json:"organizationCreatedAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links    *ListClientsLinks `json:"_links,omitempty"`
	Embedded *ClientEmbedded   `json:"_embedded,omitempty"`
}

type ClientEmbedded struct {
	Organization *components.EntityOrganization     `json:"organization,omitempty"`
	Onboarding   *components.EntityOnboardingStatus `json:"onboarding,omitempty"`
	Capabilities *components.EntityCapability       `json:"capabilities,omitempty"`
}

type CreateCaptureRequest struct {
	// Provide the ID of the related payment.
	PaymentID string `pathParam:"style=simple,explode=false,name=paymentId"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                   `header:"style=simple,explode=false,name=idempotency-key"`
	EntityCapture  *components.EntityCapture `request:"mediaType=application/json"`
}

type CreateCaptureResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created capture object. For a complete reference of the
	// capture object, refer to the [Get capture endpoint](get-capture) documentation.
	CaptureResponse *components.CaptureResponse
}

type CreateClientLinkRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey   *string                      `header:"style=simple,explode=false,name=idempotency-key"`
	EntityClientLink *components.EntityClientLink `request:"mediaType=application/json"`
}

type CreateClientLinkResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created client link object.
	EntityClientLinkResponse *components.EntityClientLinkResponse
}

type CreateConnectBalanceTransferRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey        *string                           `header:"style=simple,explode=false,name=idempotency-key"`
	EntityBalanceTransfer *components.EntityBalanceTransfer `request:"mediaType=application/json"`
}

type CreateConnectBalanceTransferResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The balance transfer object.
	EntityBalanceTransferResponse *components.EntityBalanceTransferResponse
}

type CreateCustomerPaymentRequest struct {
	// Provide the ID of the related customer.
	CustomerID string `pathParam:"style=simple,explode=false,name=customerId"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                    `header:"style=simple,explode=false,name=idempotency-key"`
	PaymentRequest *components.PaymentRequest `request:"mediaType=application/json"`
}

type CreateCustomerPaymentResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created payment object.
	PaymentResponse *components.PaymentResponse
}

type CreateCustomerRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                    `header:"style=simple,explode=false,name=idempotency-key"`
	EntityCustomer *components.EntityCustomer `request:"mediaType=application/json"`
}

type CreateCustomerResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created customer object.
	CustomerResponse *components.CustomerResponse
}

type CreateMandateRequest struct {
	// Provide the ID of the related customer.
	CustomerID string `pathParam:"style=simple,explode=false,name=customerId"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                   `header:"style=simple,explode=false,name=idempotency-key"`
	EntityMandate  *components.EntityMandate `request:"mediaType=application/json"`
}

type CreateMandateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created mandate object.
	MandateResponse *components.MandateResponse
}

type CreatePaymentLinkRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                       `header:"style=simple,explode=false,name=idempotency-key"`
	RequestBody    *CreatePaymentLinkRequestBody `request:"mediaType=application/json"`
}

type CreatePaymentLinkRequestBody struct {
	ID *string `json:"id,omitempty"`
	// A short description of the payment link. The description is visible in the Dashboard and will be shown on the
	// customer's bank or card statement when possible.
	Description string `json:"description"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *components.AmountNullable `json:"amount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	MinimumAmount *components.AmountNullable `json:"minimumAmount,omitempty"`
	// The URL your customer will be redirected to after completing the payment process. If no redirect URL is provided,
	// the customer will be shown a generic message after completing the payment.
	RedirectURL *string `json:"redirectUrl,omitempty"`
	// The webhook URL where we will send payment status updates to.
	//
	// The webhookUrl is optional, but without a webhook you will miss out on important status changes to any payments
	// resulting from the payment link.
	//
	// The webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use
	// webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your
	// local machine.
	WebhookURL *string `json:"webhookUrl,omitempty"`
	// Optionally provide the order lines for the payment. Each line contains details such as a description of the item
	// ordered and its price.
	//
	// All lines must have the same currency as the payment.
	//
	// Required for payment methods `billie`, `in3`, `klarna`, `riverty` and `voucher`.
	Lines           []components.PaymentLineItem `json:"lines,omitempty"`
	BillingAddress  *components.PaymentAddress   `json:"billingAddress,omitempty"`
	ShippingAddress *components.PaymentAddress   `json:"shippingAddress,omitempty"`
	// The identifier referring to the [profile](get-profile) this entity belongs to.
	//
	// Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation
	// request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is
	// required.
	ProfileID *string `json:"profileId,omitempty"`
	// Indicates whether the payment link is reusable. If this field is set to `true`, customers can make multiple
	// payments using the same link.
	//
	// If no value is specified, the field defaults to `false`, allowing only a single payment per link.
	Reusable *bool `json:"reusable,omitempty"`
	// The date and time the payment link is set to expire, in ISO 8601 format. If no expiry date was provided up front,
	// the payment link will not expire automatically.
	ExpiresAt *string `json:"expiresAt,omitempty"`
	// An array of payment methods that are allowed to be used for this payment link. When this parameter is
	// not provided or is an empty array, all enabled payment methods will be available.
	//
	// Enum: 'applepay', 'bancomatpay', 'bancontact', 'banktransfer', 'belfius', 'blik', 'creditcard', 'eps', 'giftcard',
	// 'ideal', 'kbc', 'mybank', 'paybybank', 'paypal', 'paysafecard', 'pointofsale', 'przelewy24', 'satispay', 'trustly', 'twint',
	// 'in3', 'riverty', 'klarna', 'billie'.
	AllowedMethods []string `json:"allowedMethods,omitempty"`
	// With Mollie Connect you can charge fees on payment links that your app is processing on behalf of other Mollie
	// merchants.
	//
	// If you use OAuth to create payment links on a connected merchant's account, you can charge a fee using this
	// `applicationFee` parameter. If a payment on the payment link succeeds, the fee will be deducted from the merchant's balance and sent
	// to your own account balance.
	ApplicationFee *ApplicationFee                     `json:"applicationFee,omitempty"`
	SequenceType   *components.PaymentLinkSequenceType `json:"sequenceType,omitempty"`
	// **Only relevant when `sequenceType` is set to `first`**
	//
	// The ID of the [customer](get-customer) the payment link is being created for. If a value is not provided,
	// the customer will be required to input relevant information which will be used to establish a mandate after
	// the payment is made.
	CustomerID *string `json:"customerId,omitempty"`
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
}

type CreatePaymentLinkResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created payment link object.
	PaymentLinkResponse *components.PaymentLinkResponse
}

type CreatePaymentRequest struct {
	// This endpoint allows you to include additional information via the `include` query string parameter.
	Include *string `queryParam:"style=form,explode=true,name=include"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                    `header:"style=simple,explode=false,name=idempotency-key"`
	PaymentRequest *components.PaymentRequest `request:"mediaType=application/json"`
}

type CreatePaymentResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created payment object.
	PaymentResponse *components.PaymentResponse
}

type CreateProfileRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                  `header:"style=simple,explode=false,name=idempotency-key"`
	EntityProfile  components.EntityProfile `request:"mediaType=application/json"`
}

type CreateProfileResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created profile object.
	EntityProfileResponse *components.EntityProfileResponse
}

type CreateRefundRequest struct {
	// Provide the ID of the related payment.
	PaymentID string `pathParam:"style=simple,explode=false,name=paymentId"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                  `header:"style=simple,explode=false,name=idempotency-key"`
	EntityRefund   *components.EntityRefund `request:"mediaType=application/json"`
}

type CreateRefundResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created refund object.
	EntityRefundResponse *components.EntityRefundResponse
}

type CreateSalesInvoiceRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey     *string                        `header:"style=simple,explode=false,name=idempotency-key"`
	EntitySalesInvoice *components.EntitySalesInvoice `request:"mediaType=application/json"`
}

type CreateSalesInvoiceResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created invoice object. For a complete reference of the invoice object, refer to the
	// [Get sales invoice endpoint](get-sales-invoice) documentation.
	EntitySalesInvoiceResponse *components.EntitySalesInvoiceResponse
}

type CreateSubscriptionRequest struct {
	// Provide the ID of the related customer.
	CustomerID string `pathParam:"style=simple,explode=false,name=customerId"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey      *string                         `header:"style=simple,explode=false,name=idempotency-key"`
	SubscriptionRequest *components.SubscriptionRequest `request:"mediaType=application/json"`
}

type CreateSubscriptionResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The newly created subscription object.
	SubscriptionResponse *components.SubscriptionResponse
}

type CreateWebhookRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                   `header:"style=simple,explode=false,name=idempotency-key"`
	RequestBody    *CreateWebhookRequestBody `request:"mediaType=application/json"`
}

type CreateWebhookRequestBody struct {
	// A name that identifies the webhook.
	Name string `json:"name"`
	// The URL Mollie will send the events to. This URL must be publicly accessible.
	URL string `json:"url"`
	// The event's type
	WebhookEventTypes components.WebhookEventTypes `json:"eventTypes"`
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
}

type CreateWebhookResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The webhook object.
	CreateWebhook *components.CreateWebhook
}

type DeleteCustomerRequest struct {
	// Provide the ID of the related customer.
	CustomerID string `pathParam:"style=simple,explode=false,name=customerId"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                    `header:"style=simple,explode=false,name=idempotency-key"`
	RequestBody    *DeleteCustomerRequestBody `request:"mediaType=application/json"`
}

type DeleteCustomerRequestBody struct {
	// Most API credentials are specifically created for either live mode or test mode. For organization-level credentials
	// such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `json:"testmode,omitempty"`
}

type DeleteCustomerResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// An empty response.
	Any any
}

type DeletePaymentLinkRequest struct {
	// Provide the ID of the related payment link.
	PaymentLinkID string `pathParam:"style=simple,explode=false,name=paymentLinkId"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                       `header:"style=simple,explode=false,name=idempotency-key"`
	RequestBody    *DeletePaymentLinkRequestBody `request:"mediaType=application/json"`
}

type DeletePaymentLinkRequestBody struct {
	// Most API credentials are specifically created for either live mode or test mode. For organization-level credentials
	// such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `json:"testmode,omitempty"`
}

type DeletePaymentLinkResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// An empty response.
	Any any
}

type DeleteProfileRequest struct {
	// Provide the ID of the item you want to perform this operation on.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type DeleteProfileResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// An empty response.
	Any any
}

type DeleteSalesInvoiceRequest struct {
	// Provide the ID of the item you want to perform this operation on.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey           *string                              `header:"style=simple,explode=false,name=idempotency-key"`
	DeleteValuesSalesInvoice *components.DeleteValuesSalesInvoice `request:"mediaType=application/json"`
}

type DeleteSalesInvoiceResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// An empty response.
	Any any
}

type DeleteWebhookRequest struct {
	// Provide the ID of the item you want to perform this operation on.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string                   `header:"style=simple,explode=false,name=idempotency-key"`
	RequestBody    *DeleteWebhookRequestBody `request:"mediaType=application/json"`
}

type DeleteWebhookRequestBody struct {
	// Most API credentials are specifically created for either live mode or test mode. For organization-level credentials
	// such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `json:"testmode,omitempty"`
}

type DeleteWebhookResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// No content.
	Any any
}

type Documentation struct {
	Href *string `json:"href,omitempty"`
	Type *string `json:"type,omitempty"`
}

type GetBalanceReportRequest struct {
	// Provide the ID of the related balance.
	BalanceID string `pathParam:"style=simple,explode=false,name=balanceId"`
	// The start date of the report, in `YYYY-MM-DD` format. The from date is
	// 'inclusive', and in Central European Time. This means a report with for example `from=2024-01-01` will
	// include transactions from 2024-01-01 0:00:00 CET and onwards.
	From string `queryParam:"style=form,explode=true,name=from"`
	// The end date of the report, in `YYYY-MM-DD` format. The until date is 'exclusive', and in Central European Time.
	// This means a report with for example `until=2024-02-01` will include transactions up until
	// 2024-01-31 23:59:59 CET.
	Until string `queryParam:"style=form,explode=true,name=until"`
	// You can retrieve reports in two different formats. With the `status-balances` format, transactions are grouped
	// by status (e.g. `pending`, `available`), then by transaction type, and then by other sub-groupings where
	// available (e.g. payment method).
	//
	// With the `transaction-categories` format, transactions are grouped by
	// transaction type, then by status, and then again by other sub-groupings where available.
	Grouping *Grouping `queryParam:"style=form,explode=true,name=grouping"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetBalanceReportResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The balance report object.
	EntityBalanceReport *components.EntityBalanceReport
}

type GetBalanceRequest struct {
	// Provide the ID of the item you want to perform this operation on.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetBalanceResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The balance object.
	EntityBalance *components.EntityBalance
}

type GetCaptureRequest struct {
	// Provide the ID of the related payment.
	PaymentID string `pathParam:"style=simple,explode=false,name=paymentId"`
	// Provide the ID of the related capture.
	CaptureID string `pathParam:"style=simple,explode=false,name=captureId"`
	// This endpoint allows embedding related API items by appending the following values via the `embed` query string
	// parameter.
	Embed *string `queryParam:"style=form,explode=true,name=embed"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetCaptureResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The capture object.
	CaptureResponse *components.CaptureResponse
}

type GetChargebackRequest struct {
	// Provide the ID of the related payment.
	PaymentID string `pathParam:"style=simple,explode=false,name=paymentId"`
	// Provide the ID of the related chargeback.
	ChargebackID string `pathParam:"style=simple,explode=false,name=chargebackId"`
	// This endpoint allows embedding related API items by appending the following values via the `embed` query string
	// parameter.
	Embed *string `queryParam:"style=form,explode=true,name=embed"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetChargebackResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The chargeback object.
	EntityChargeback *components.EntityChargeback
}

type GetClientCommission struct {
	// The commission count.
	Count *int64 `json:"count,omitempty"`
}

type GetClientEmbedded struct {
	Organization *components.EntityOrganization     `json:"organization,omitempty"`
	Onboarding   *components.EntityOnboardingStatus `json:"onboarding,omitempty"`
	Capabilities *components.EntityCapability       `json:"capabilities,omitempty"`
}

type GetClientLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *components.URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Organization *components.URLObj `json:"organization,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Onboarding *components.URLObj `json:"onboarding,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *components.URLObj `json:"documentation,omitempty"`
}

type GetClientRequest struct {
	// Provide the ID of the item you want to perform this operation on.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// This endpoint allows embedding related API items by appending the following values via the `embed` query string
	// parameter.
	Embed *string `queryParam:"style=form,explode=true,name=embed"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetClientResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The client object.
	Object *GetClientResponseBody
}

type GetClientResponseBody struct {
	// Indicates the response contains a client object. Will always contain the string `client` for this resource type.
	Resource *string `json:"resource,omitempty"`
	// The identifier uniquely referring to this client. Example: `org_12345678`.
	ID *string `json:"id,omitempty"`
	// The commission object.
	Commission *GetClientCommission `json:"commission,omitempty"`
	// The date and time the client organization was created, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
	// format.
	OrganizationCreatedAt *string `json:"organizationCreatedAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links    *GetClientLinks    `json:"_links,omitempty"`
	Embedded *GetClientEmbedded `json:"_embedded,omitempty"`
}

type GetConnectBalanceTransferRequest struct {
	// Provide the ID of the item you want to perform this operation on.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetConnectBalanceTransferResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The Connect balance transfer object.
	EntityBalanceTransferResponse *components.EntityBalanceTransferResponse
}

type GetCurrentOrganizationRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetCurrentOrganizationResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The current organization object.
	EntityOrganization *components.EntityOrganization
}

type GetCurrentProfileRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetCurrentProfileResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The current profile object. For a complete reference of the profile object, refer to the
	// [Get profile](get-profile) endpoint documentation.
	EntityProfileResponse *components.EntityProfileResponse
}

type GetCustomerLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self components.URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Dashboard components.URLObj `json:"dashboard"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Payments *components.URLNullable `json:"payments,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Mandates *components.URLNullable `json:"mandates,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Subscriptions *components.URLNullable `json:"subscriptions,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation components.URLObj `json:"documentation"`
}

type GetCustomerRequest struct {
	// Provide the ID of the related customer.
	CustomerID string `pathParam:"style=simple,explode=false,name=customerId"`
	// This endpoint allows you to include additional information via the `include` query string parameter.
	Include *string `queryParam:"style=form,explode=true,name=include"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetCustomerResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The customer object.
	Object *GetCustomerResponseBody
}

type GetCustomerResponseBody struct {
	// Indicates the response contains a customer object. Will always contain the string `customer` for this endpoint.
	Resource *string `json:"resource,omitempty"`
	ID       *string `json:"id,omitempty"`
	// Whether this entity was created in live mode or in test mode.
	Mode *components.Mode `json:"mode,omitempty"`
	// The full name of the customer.
	Name *string `json:"name,omitempty"`
	// The email address of the customer.
	Email *string `json:"email,omitempty"`
	// Allows you to preset the language to be used.
	Locale *components.LocaleResponse `json:"locale,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata *components.Metadata `json:"metadata,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links  *GetCustomerLinks        `json:"_links,omitempty"`
	Events []components.EntityEvent `json:"events,omitempty"`
}

type GetInvoiceRequest struct {
	// Provide the ID of the item you want to perform this operation on.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetInvoiceResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The invoice object.
	EntityInvoice *components.EntityInvoice
}

type GetMandateRequest struct {
	// Provide the ID of the related customer.
	CustomerID string `pathParam:"style=simple,explode=false,name=customerId"`
	// Provide the ID of the related mandate.
	MandateID string `pathParam:"style=simple,explode=false,name=mandateId"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetMandateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The mandate object.
	MandateResponse *components.MandateResponse
}

type GetMethodRequest struct {
	// Provide the ID of the item you want to perform this operation on.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// Response language
	Locale *components.LocaleParameter `queryParam:"style=form,explode=true,name=locale"`
	// If provided, the `minimumAmount` and `maximumAmount` will be converted
	// to the given currency. An error is returned if the currency is not supported by the payment method.
	Currency *string `queryParam:"style=form,explode=true,name=currency"`
	// The identifier referring to the [profile](get-profile) you wish to
	// retrieve the resources for.
	//
	// Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For
	// organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
	ProfileID *string `queryParam:"style=form,explode=true,name=profileId"`
	// This endpoint allows you to include additional information via the `include` query string parameter.
	Include *string `queryParam:"style=form,explode=true,name=include"`
	// Set this parameter to `first` to only return the methods that
	// can be used for the first payment of a recurring sequence.
	//
	// Set it to `recurring` to only return methods that can be used for recurring payments or subscriptions.
	SequenceType *components.SequenceType `queryParam:"style=form,explode=true,name=sequenceType"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetMethodResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The payment method object.
	EntityMethod *components.EntityMethod
}

type GetNextSettlementRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetNextSettlementResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The next settlement object. For a complete reference of the settlement object, refer to the
	// [Get settlement](get-settlement) endpoint documentation.
	EntitySettlement *components.EntitySettlement
}

type GetOnboardingStatusRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetOnboardingStatusResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The onboarding status object of the current organization.
	EntityOnboardingStatus *components.EntityOnboardingStatus
}

type GetOpenSettlementRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetOpenSettlementResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// A settlement object describing your current balance. For a complete reference of the settlement object, refer to
	// the [Get settlement](get-settlement) endpoint documentation.
	EntitySettlement *components.EntitySettlement
}

type GetOrganizationRequest struct {
	// Provide the ID of the item you want to perform this operation on.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetOrganizationResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The organization object.
	EntityOrganization *components.EntityOrganization
}

type GetPartnerStatusLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *components.URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Signuplink *components.URLObj `json:"signuplink,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *components.URLObj `json:"documentation,omitempty"`
}

type GetPartnerStatusRequest struct {
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetPartnerStatusResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The partner status object.
	Object *GetPartnerStatusResponseBody
}

type GetPartnerStatusResponseBody struct {
	// Indicates the response contains a partner status object. Will always contain the string `partner` for
	// this endpoint.
	Resource string `json:"resource"`
	// Indicates the type of partner. Will be `null` if the currently authenticated organization is not
	// enrolled as a partner.
	PartnerType *PartnerType `json:"partnerType"`
	// Whether the current organization is receiving commissions.
	IsCommissionPartner *bool `json:"isCommissionPartner,omitempty"`
	// Array of User-Agent token objects. Present if the organization is a partner of type `useragent`, or if
	// they were in the past.
	UserAgentTokens []UserAgentToken `json:"userAgentTokens,omitempty"`
	// The date the partner contract was signed, in ISO 8601 format. Omitted if no contract has been signed
	// (yet).
	PartnerContractSignedAt *string `json:"partnerContractSignedAt,omitempty"`
	// Whether an update to the partner contract is available and requiring the organization's agreement.
	PartnerContractUpdateAvailable *bool `json:"partnerContractUpdateAvailable,omitempty"`
	// The expiration date of the signed partner contract, in ISO 8601 format. Omitted if contract has no
	// expiration date (yet).
	PartnerContractExpiresAt *string `json:"partnerContractExpiresAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *GetPartnerStatusLinks `json:"_links,omitempty"`
}

type GetPaymentLinkPaymentsEmbedded struct {
	// An array of payment objects.
	Payments []components.PaymentResponse `json:"payments,omitempty"`
}

type GetPaymentLinkPaymentsRequest struct {
	// Provide the ID of the related payment link.
	PaymentLinkID string `pathParam:"style=simple,explode=false,name=paymentLinkId"`
	// Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
	// result set.
	From *string `queryParam:"style=form,explode=true,name=from"`
	// The maximum number of items to return. Defaults to 50 items.
	Limit *int64 `queryParam:"style=form,explode=true,name=limit"`
	// Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from
	// newest to oldest.
	Sort *components.ListSort `queryParam:"style=form,explode=true,name=sort"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetPaymentLinkPaymentsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// A list of payment objects.
	Object *GetPaymentLinkPaymentsResponseBody
}

type GetPaymentLinkPaymentsResponseBody struct {
	// The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
	// as well.
	//
	// The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
	// limit is 50 items.
	Count    int64                          `json:"count"`
	Embedded GetPaymentLinkPaymentsEmbedded `json:"_embedded"`
	// Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field.
	Links components.ListLinks `json:"_links"`
}

type GetPaymentLinkRequest struct {
	// Provide the ID of the related payment link.
	PaymentLinkID string `pathParam:"style=simple,explode=false,name=paymentLinkId"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetPaymentLinkResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The payment link object.
	PaymentLinkResponse *components.PaymentLinkResponse
}

type GetPaymentRequest struct {
	// Provide the ID of the related payment.
	PaymentID string `pathParam:"style=simple,explode=false,name=paymentId"`
	// This endpoint allows you to include additional information via the `include` query string parameter.
	Include *string `queryParam:"style=form,explode=true,name=include"`
	// This endpoint allows embedding related API items by appending the following values via the `embed` query string
	// parameter.
	Embed *string `queryParam:"style=form,explode=true,name=embed"`
	// Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
	// parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
	// setting the `testmode` query parameter to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `queryParam:"style=form,explode=true,name=testmode"`
	// A unique key to ensure idempotent requests. This key should be a UUID v4 string.
	IdempotencyKey *string `header:"style=simple,explode=false,name=idempotency-key"`
}

type GetPaymentResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// The payment object.
	PaymentResponse *components.PaymentResponse
}