Merge pull request #413 from VictorAvelar/fix-broken-links

Fix documentation broken urls

.github/workflows/documentation-links.yml

@@ -24,14 +24,14 @@ jobs:
         id: lychee
         uses: lycheeverse/lychee-action@7da8ec1fc4e01b5a12062ac6c589c10a4ce70d67
 
-      - name: Create Issue From File
-        if: env.lychee_exit_code != 0
-        uses: peter-evans/create-issue-from-file@e8ef132d6df98ed982188e460ebb3b5d4ef3a9cd
-        with:
-          title: Link Checker Report
-          content-filepath: ./lychee/out.md
-          labels: |
-            report
-            automated-issue
-            help-wanted
-          assignees: VictorAvelar
+      # - name: Create Issue From File
+      #   if: env.lychee_exit_code != 0
+      #   uses: peter-evans/create-issue-from-file@e8ef132d6df98ed982188e460ebb3b5d4ef3a9cd
+      #   with:
+      #     title: Link Checker Report
+      #     content-filepath: ./lychee/out.md
+      #     labels: |
+      #       report
+      #       automated-issue
+      #       help-wanted
+      #     assignees: VictorAvelar

docs/README.md

@@ -8,13 +8,9 @@ import "github.com/VictorAvelar/mollie-api-go/v4/mollie"
 
 Package mollie is a wrapper around Mollie's REST API.
 
-See: https://www.mollie.com/en/developers
+See: https://www.mollie.com/developers
 
-The Mollie API implements a Representational state transfer \(REST\) architecture.
-
-Sounds technical, but it’s really quite easy. It mainly breaks down to HTTP\-methods GET, PATCH, POST and DELETE matching the operations to read, update, create and delete.
-
-REST also implies a nice and clean structure for URLs or endpoints. This means you can reach any part of the Mollie API on https://api.mollie.com/v2/ adding the name of the resource you want to interact with.
+The Mollie API is a straightforward REST API. This means all endpoints either create, retrieve, or update objects. API calls are authenticated with an \[API credential\]\(https://docs.mollie.com/reference/authentication\). In some cases, you can receive live updates via \[webhooks\]\(https://docs.mollie.com/reference/webhooks\).
 
 ## Index
 
@@ -764,26 +760,30 @@ GetBalance retrieves a balance by its id.
 See: https://docs.mollie.com/reference/get-balance
 
 <a name="BalancesService.GetPrimaryReport"></a>
-### func \(\*BalancesService\) [GetPrimaryReport](<https://github.com/VictorAvelar/mollie-api-go/blob/master/mollie/balances.go#L268-L272>)
+### func \(\*BalancesService\) [GetPrimaryReport](<https://github.com/VictorAvelar/mollie-api-go/blob/master/mollie/balances.go#L270-L274>)
 
 ```go
 func (bs *BalancesService) GetPrimaryReport(ctx context.Context, options *BalanceReportOptions) (res *Response, br *BalanceReport, err error)
 ```
 
 GetPrimaryReport returns the report for the primary balance.
 
-See: https://docs.mollie.com/reference/get-primary-balance-report
+The alias \`primary\` is used instead of the balance ID to refer to the organization's primary balance.
+
+See: https://docs.mollie.com/reference/get-balance-report
 
 <a name="BalancesService.GetPrimaryTransactionsList"></a>
-### func \(\*BalancesService\) [GetPrimaryTransactionsList](<https://github.com/VictorAvelar/mollie-api-go/blob/master/mollie/balances.go#L296-L300>)
+### func \(\*BalancesService\) [GetPrimaryTransactionsList](<https://github.com/VictorAvelar/mollie-api-go/blob/master/mollie/balances.go#L300-L304>)
 
 ```go
 func (bs *BalancesService) GetPrimaryTransactionsList(ctx context.Context, options *ListBalanceTransactionsOptions) (res *Response, btl *BalanceTransactionsList, err error)
 ```
 
 GetPrimaryTransactionsList retrieves the list of movements \(transactions\) for the primary balance of the account.
 
-See: https://docs.mollie.com/reference/list-primary-balance-transactions
+The alias primary is used instead of the balance ID to refer to the organization's primary balance.
+
+See: https://docs.mollie.com/reference/list-balance-transactions
 
 <a name="BalancesService.GetReport"></a>
 ### func \(\*BalancesService\) [GetReport](<https://github.com/VictorAvelar/mollie-api-go/blob/master/mollie/balances.go#L257-L261>)
@@ -797,7 +797,7 @@ GetReport returns the balance report for the specified balance id.
 See: https://docs.mollie.com/reference/get-balance-report
 
 <a name="BalancesService.GetTransactionsList"></a>
-### func \(\*BalancesService\) [GetTransactionsList](<https://github.com/VictorAvelar/mollie-api-go/blob/master/mollie/balances.go#L280-L288>)
+### func \(\*BalancesService\) [GetTransactionsList](<https://github.com/VictorAvelar/mollie-api-go/blob/master/mollie/balances.go#L282-L290>)
 
 ```go
 func (bs *BalancesService) GetTransactionsList(ctx context.Context, balance string, options *ListBalanceTransactionsOptions) (res *Response, btl *BalanceTransactionsList, err error)
@@ -3745,7 +3745,7 @@ func (ors *OrdersService) UpdateOrderLine(ctx context.Context, orderID string, o
 
 UpdateOrderLine can be used to update an order line.
 
-See https://docs.mollie.com/reference/update-orderline
+See https://docs.mollie.com/reference/update-order-line
 
 <a name="Organization"></a>
 ## type [Organization](<https://github.com/VictorAvelar/mollie-api-go/blob/master/mollie/organizations.go#L11-L22>)
@@ -3853,7 +3853,7 @@ func (os *OrganizationsService) GetPartnerStatus(ctx context.Context) (res *Resp
 
 GetPartnerStatus retrieves details about the partner status of the currently authenticated organization.
 
-See: https://docs.mollie.com/reference/get-partner
+See: https://docs.mollie.com/reference/get-partner-status
 
 <a name="Owner"></a>
 ## type [Owner](<https://github.com/VictorAvelar/mollie-api-go/blob/master/mollie/common_types.go#L363-L368>)

lychee.toml

@@ -1,5 +1,5 @@
 exclude_path = [".github", ".devcontainer", "wiki", "mollie", "testdata"]
-exclude = ['^https://github\.com']
+exclude = ['^https://github\.com', '^https://api\.mollie\.com']
 cache = true
 max_redirects = 3
 require_https = true

mollie/balances.go

@@ -264,7 +264,9 @@ func (bs *BalancesService) GetReport(ctx context.Context, balance string, option
 
 // GetPrimaryReport returns the report for the primary balance.
 //
-// See: https://docs.mollie.com/reference/get-primary-balance-report
+// The alias `primary` is used instead of the balance ID to refer to the organization's primary balance.
+//
+// See: https://docs.mollie.com/reference/get-balance-report
 func (bs *BalancesService) GetPrimaryReport(ctx context.Context, options *BalanceReportOptions) (
 	res *Response,
 	br *BalanceReport,
@@ -292,7 +294,9 @@ func (bs *BalancesService) GetTransactionsList(
 // GetPrimaryTransactionsList retrieves the list of movements (transactions) for the
 // primary balance of the account.
 //
-// See: https://docs.mollie.com/reference/list-primary-balance-transactions
+// The alias primary is used instead of the balance ID to refer to the organization's primary balance.
+//
+// See: https://docs.mollie.com/reference/list-balance-transactions
 func (bs *BalancesService) GetPrimaryTransactionsList(ctx context.Context, options *ListBalanceTransactionsOptions) (
 	res *Response,
 	btl *BalanceTransactionsList,

mollie/doc.go

@@ -1,13 +1,9 @@
 // Package mollie is a wrapper around Mollie's REST API.
 //
-// See: https://www.mollie.com/en/developers
+// See: https://www.mollie.com/developers
 //
-// The Mollie API implements a Representational state transfer (REST) architecture.
-//
-// Sounds technical, but it’s really quite easy. It mainly breaks down to HTTP-methods
-// GET, PATCH, POST and DELETE matching the operations to read, update, create and delete.
-//
-// REST also implies a nice and clean structure for URLs or endpoints.
-// This means you can reach any part of the Mollie API on https://api.mollie.com/v2/ adding
-// the name of the resource you want to interact with.
+// The Mollie API is a straightforward REST API. This means all endpoints
+// either create, retrieve, or update objects. API calls are authenticated
+// with an [API credential](https://docs.mollie.com/reference/authentication).
+// In some cases, you can receive live updates via [webhooks](https://docs.mollie.com/reference/webhooks).
 package mollie

mollie/orders.go

@@ -429,7 +429,7 @@ func (ors *OrdersService) List(ctx context.Context, opts *ListOrdersOptions) (
 
 // UpdateOrderLine can be used to update an order line.
 //
-// See https://docs.mollie.com/reference/update-orderline
+// See https://docs.mollie.com/reference/update-order-line
 func (ors *OrdersService) UpdateOrderLine(
 	ctx context.Context,
 	orderID string,

mollie/organizations.go

@@ -88,7 +88,7 @@ func (os *OrganizationsService) GetCurrent(ctx context.Context) (res *Response,
 // GetPartnerStatus retrieves details about the partner status
 // of the currently authenticated organization.
 //
-// See: https://docs.mollie.com/reference/get-partner
+// See: https://docs.mollie.com/reference/get-partner-status
 func (os *OrganizationsService) GetPartnerStatus(ctx context.Context) (
 	res *Response,
 	ops *OrganizationPartnerStatus,