Skip to content

Improve API docs #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lucassus merged 3 commits into from
Jul 24, 2025
Merged

Improve API docs #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
895d392
Automated commit message
maxio-sdk Jul 24, 2025
5a91c83
Refresh pnpm lock
lucassus Jul 24, 2025
74a5bba
Remove redundant error message assertion in customFieldsController tests
lucassus Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ The following parameters are configurable for the API Client:
The API client can be initialized as follows:

```ts
import { Client, Environment } from '@maxio-com/advanced-billing-sdk';

const client = new Client({
basicAuthCredentials: {
username: 'BasicAuthUserName',
Expand Down
2 changes: 2 additions & 0 deletions doc/client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ The following parameters are configurable for the API Client:
The API client can be initialized as follows:

```ts
import { Client, Environment } from '@maxio-com/advanced-billing-sdk';

const client = new Client({
basicAuthCredentials: {
username: 'BasicAuthUserName',
Expand Down
12 changes: 6 additions & 6 deletions doc/controllers/advance-invoice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ async issueAdvanceInvoice(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [Invoice](../../doc/models/invoice.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`Invoice`](../../doc/models/invoice.md).

## Example Usage

Expand All @@ -53,9 +53,9 @@ const body: IssueAdvanceInvoiceRequest = {

try {
const { result, ...httpResponse } = await advanceInvoiceController.issueAdvanceInvoice(
subscriptionId,
body
);
subscriptionId,
body
);
// Get more response info...
// const { statusCode, headers } = httpResponse;
} catch (error) {
Expand Down Expand Up @@ -94,7 +94,7 @@ async readAdvanceInvoice(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [Invoice](../../doc/models/invoice.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`Invoice`](../../doc/models/invoice.md).

## Example Usage

Expand Down Expand Up @@ -143,7 +143,7 @@ async voidAdvanceInvoice(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [Invoice](../../doc/models/invoice.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`Invoice`](../../doc/models/invoice.md).

## Example Usage

Expand Down
54 changes: 36 additions & 18 deletions doc/controllers/api-exports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,15 @@ Example: `GET https://{subdomain}.chargify.com/api_exports/proforma_invoices/123

```ts
async listExportedProformaInvoices(
batchId: string,
perPage?: number,
page?: number,
{
batchId,
perPage,
page,
}: {
batchId: string;
perPage?: number;
page?: number;
},
requestOptions?: RequestOptions
): Promise<ApiResponse<ProformaInvoice[]>>
```
Expand All @@ -47,7 +53,7 @@ async listExportedProformaInvoices(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [ProformaInvoice[]](../../doc/models/proforma-invoice.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`ProformaInvoice[]`](../../doc/models/proforma-invoice.md).

## Example Usage

Expand Down Expand Up @@ -85,9 +91,15 @@ Example: `GET https://{subdomain}.chargify.com/api_exports/invoices/123/rows?per

```ts
async listExportedInvoices(
batchId: string,
perPage?: number,
page?: number,
{
batchId,
perPage,
page,
}: {
batchId: string;
perPage?: number;
page?: number;
},
requestOptions?: RequestOptions
): Promise<ApiResponse<Invoice[]>>
```
Expand All @@ -103,7 +115,7 @@ async listExportedInvoices(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [Invoice[]](../../doc/models/invoice.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`Invoice[]`](../../doc/models/invoice.md).

## Example Usage

Expand Down Expand Up @@ -141,9 +153,15 @@ Example: `GET https://{subdomain}.chargify.com/api_exports/subscriptions/123/row

```ts
async listExportedSubscriptions(
batchId: string,
perPage?: number,
page?: number,
{
batchId,
perPage,
page,
}: {
batchId: string;
perPage?: number;
page?: number;
},
requestOptions?: RequestOptions
): Promise<ApiResponse<Subscription[]>>
```
Expand All @@ -159,7 +177,7 @@ async listExportedSubscriptions(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [Subscription[]](../../doc/models/subscription.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`Subscription[]`](../../doc/models/subscription.md).

## Example Usage

Expand Down Expand Up @@ -209,7 +227,7 @@ async exportProformaInvoices(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [BatchJobResponse](../../doc/models/batch-job-response.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`BatchJobResponse`](../../doc/models/batch-job-response.md).

## Example Usage

Expand Down Expand Up @@ -252,7 +270,7 @@ async exportInvoices(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [BatchJobResponse](../../doc/models/batch-job-response.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`BatchJobResponse`](../../doc/models/batch-job-response.md).

## Example Usage

Expand Down Expand Up @@ -295,7 +313,7 @@ async exportSubscriptions(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [BatchJobResponse](../../doc/models/batch-job-response.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`BatchJobResponse`](../../doc/models/batch-job-response.md).

## Example Usage

Expand Down Expand Up @@ -339,7 +357,7 @@ async readProformaInvoicesExport(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [BatchJobResponse](../../doc/models/batch-job-response.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`BatchJobResponse`](../../doc/models/batch-job-response.md).

## Example Usage

Expand Down Expand Up @@ -385,7 +403,7 @@ async readInvoicesExport(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [BatchJobResponse](../../doc/models/batch-job-response.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`BatchJobResponse`](../../doc/models/batch-job-response.md).

## Example Usage

Expand Down Expand Up @@ -431,7 +449,7 @@ async readSubscriptionsExport(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [BatchJobResponse](../../doc/models/batch-job-response.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`BatchJobResponse`](../../doc/models/batch-job-response.md).

## Example Usage

Expand Down
8 changes: 4 additions & 4 deletions doc/controllers/billing-portal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ async enableBillingPortalForCustomer(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [CustomerResponse](../../doc/models/customer-response.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`CustomerResponse`](../../doc/models/customer-response.md).

## Example Usage

Expand Down Expand Up @@ -106,7 +106,7 @@ async readBillingPortalLink(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [PortalManagementLink](../../doc/models/portal-management-link.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`PortalManagementLink`](../../doc/models/portal-management-link.md).

## Example Usage

Expand Down Expand Up @@ -178,7 +178,7 @@ async resendBillingPortalInvitation(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [ResentInvitation](../../doc/models/resent-invitation.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`ResentInvitation`](../../doc/models/resent-invitation.md).

## Example Usage

Expand Down Expand Up @@ -242,7 +242,7 @@ async revokeBillingPortalAccess(

## Response Type

This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [RevokedInvitation](../../doc/models/revoked-invitation.md).
This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [`RevokedInvitation`](../../doc/models/revoked-invitation.md).

## Example Usage

Expand Down
Loading