diff --git a/README.md b/README.md index dab171e5..e7218ea1 100644 --- a/README.md +++ b/README.md @@ -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', diff --git a/doc/client.md b/doc/client.md index 6cbba4e5..a7382842 100644 --- a/doc/client.md +++ b/doc/client.md @@ -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', diff --git a/doc/controllers/advance-invoice.md b/doc/controllers/advance-invoice.md index a3fc677c..44971557 100644 --- a/doc/controllers/advance-invoice.md +++ b/doc/controllers/advance-invoice.md @@ -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 @@ -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) { @@ -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 @@ -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 diff --git a/doc/controllers/api-exports.md b/doc/controllers/api-exports.md index 38a2a0eb..612cd858 100644 --- a/doc/controllers/api-exports.md +++ b/doc/controllers/api-exports.md @@ -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> ``` @@ -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 @@ -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> ``` @@ -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 @@ -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> ``` @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/doc/controllers/billing-portal.md b/doc/controllers/billing-portal.md index 1aececb3..3a462257 100644 --- a/doc/controllers/billing-portal.md +++ b/doc/controllers/billing-portal.md @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/doc/controllers/component-price-points.md b/doc/controllers/component-price-points.md index d909f689..a89ab816 100644 --- a/doc/controllers/component-price-points.md +++ b/doc/controllers/component-price-points.md @@ -49,7 +49,7 @@ async promoteComponentPricePointToDefault( ## 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 [ComponentResponse](../../doc/models/component-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 [`ComponentResponse`](../../doc/models/component-response.md). ## Example Usage @@ -60,9 +60,9 @@ const pricePointId = 10; try { const { result, ...httpResponse } = await componentPricePointsController.promoteComponentPricePointToDefault( - componentId, - pricePointId -); + componentId, + pricePointId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -129,7 +129,7 @@ async createComponentPricePoint( ## 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 [ComponentPricePointResponse](../../doc/models/component-price-point-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 [`ComponentPricePointResponse`](../../doc/models/component-price-point-response.md). ## Example Usage @@ -158,9 +158,9 @@ const body: CreateComponentPricePointRequest = { try { const { result, ...httpResponse } = await componentPricePointsController.createComponentPricePoint( - componentId, - body -); + componentId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -190,11 +190,19 @@ If the price point is set to `use_site_exchange_rate: true`, it will return pric ```ts async listComponentPricePoints( - componentId: number, - currencyPrices?: boolean, - page?: number, - perPage?: number, - filterType?: PricePointType[], + { + componentId, + currencyPrices, + page, + perPage, + filterType, + }: { + componentId: number; + currencyPrices?: boolean; + page?: number; + perPage?: number; + filterType?: PricePointType[]; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -212,7 +220,7 @@ async listComponentPricePoints( ## 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 [ComponentPricePointsResponse](../../doc/models/component-price-points-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 [`ComponentPricePointsResponse`](../../doc/models/component-price-points-response.md). ## Example Usage @@ -307,7 +315,7 @@ async bulkCreateComponentPricePoints( ## 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 [ComponentPricePointsResponse](../../doc/models/component-price-points-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 [`ComponentPricePointsResponse`](../../doc/models/component-price-points-response.md). ## Example Usage @@ -354,9 +362,9 @@ const body: CreateComponentPricePointsRequest = { try { const { result, ...httpResponse } = await componentPricePointsController.bulkCreateComponentPricePoints( - componentId, - body -); + componentId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -453,7 +461,7 @@ async updateComponentPricePoint( ## 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 [ComponentPricePointResponse](../../doc/models/component-price-point-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 [`ComponentPricePointResponse`](../../doc/models/component-price-point-response.md). ## Example Usage @@ -485,10 +493,10 @@ const body: UpdateComponentPricePointRequest = { try { const { result, ...httpResponse } = await componentPricePointsController.updateComponentPricePoint( - componentId, - pricePointId, - body -); + componentId, + pricePointId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -530,7 +538,7 @@ async readComponentPricePoint( ## 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 [ComponentPricePointResponse](../../doc/models/component-price-point-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 [`ComponentPricePointResponse`](../../doc/models/component-price-point-response.md). ## Example Usage @@ -541,9 +549,9 @@ const pricePointId: ReadComponentPricePointPricePointId = 188; try { const { result, ...httpResponse } = await componentPricePointsController.readComponentPricePoint( - componentId, - pricePointId -); + componentId, + pricePointId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -577,7 +585,7 @@ async archiveComponentPricePoint( ## 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 [ComponentPricePointResponse](../../doc/models/component-price-point-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 [`ComponentPricePointResponse`](../../doc/models/component-price-point-response.md). ## Example Usage @@ -588,9 +596,9 @@ const pricePointId: ArchiveComponentPricePointPricePointId = 188; try { const { result, ...httpResponse } = await componentPricePointsController.archiveComponentPricePoint( - componentId, - pricePointId -); + componentId, + pricePointId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -664,7 +672,7 @@ async unarchiveComponentPricePoint( ## 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 [ComponentPricePointResponse](../../doc/models/component-price-point-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 [`ComponentPricePointResponse`](../../doc/models/component-price-point-response.md). ## Example Usage @@ -675,9 +683,9 @@ const pricePointId = 10; try { const { result, ...httpResponse } = await componentPricePointsController.unarchiveComponentPricePoint( - componentId, - pricePointId -); + componentId, + pricePointId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -749,7 +757,7 @@ async createCurrencyPrices( ## 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 [ComponentCurrencyPricesResponse](../../doc/models/component-currency-prices-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 [`ComponentCurrencyPricesResponse`](../../doc/models/component-currency-prices-response.md). ## Example Usage @@ -773,9 +781,9 @@ const body: CreateCurrencyPricesRequest = { try { const { result, ...httpResponse } = await componentPricePointsController.createCurrencyPrices( - pricePointId, - body -); + pricePointId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -834,7 +842,7 @@ async updateCurrencyPrices( ## 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 [ComponentCurrencyPricesResponse](../../doc/models/component-currency-prices-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 [`ComponentCurrencyPricesResponse`](../../doc/models/component-currency-prices-response.md). ## Example Usage @@ -856,9 +864,9 @@ const body: UpdateCurrencyPricesRequest = { try { const { result, ...httpResponse } = await componentPricePointsController.updateCurrencyPrices( - pricePointId, - body -); + pricePointId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -899,11 +907,19 @@ This method allows to retrieve a list of Components Price Points belonging to a ```ts async listAllComponentPricePoints( - include?: ListComponentsPricePointsInclude, - page?: number, - perPage?: number, - direction?: SortingDirection, - filter?: ListPricePointsFilter, + { + include, + page, + perPage, + direction, + filter, + }: { + include?: ListComponentsPricePointsInclude; + page?: number; + perPage?: number; + direction?: SortingDirection; + filter?: ListPricePointsFilter; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -921,7 +937,7 @@ async listAllComponentPricePoints( ## 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 [ListComponentsPricePointsResponse](../../doc/models/list-components-price-points-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 [`ListComponentsPricePointsResponse`](../../doc/models/list-components-price-points-response.md). ## Example Usage diff --git a/doc/controllers/components.md b/doc/controllers/components.md index 76cce4f2..cf5eb370 100644 --- a/doc/controllers/components.md +++ b/doc/controllers/components.md @@ -52,7 +52,7 @@ async createMeteredComponent( ## 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 [ComponentResponse](../../doc/models/component-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 [`ComponentResponse`](../../doc/models/component-response.md). ## Example Usage @@ -76,9 +76,9 @@ const body: CreateMeteredComponent = { try { const { result, ...httpResponse } = await componentsController.createMeteredComponent( - productFamilyId, - body -); + productFamilyId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -183,7 +183,7 @@ async createQuantityBasedComponent( ## 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 [ComponentResponse](../../doc/models/component-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 [`ComponentResponse`](../../doc/models/component-response.md). ## Example Usage @@ -208,9 +208,9 @@ const body: CreateQuantityBasedComponent = { try { const { result, ...httpResponse } = await componentsController.createQuantityBasedComponent( - productFamilyId, - body -); + productFamilyId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -305,7 +305,7 @@ async createOnOffComponent( ## 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 [ComponentResponse](../../doc/models/component-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 [`ComponentResponse`](../../doc/models/component-response.md). ## Example Usage @@ -327,9 +327,9 @@ const body: CreateOnOffComponent = { try { const { result, ...httpResponse } = await componentsController.createOnOffComponent( - productFamilyId, - body -); + productFamilyId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -412,7 +412,7 @@ async createPrepaidUsageComponent( ## 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 [ComponentResponse](../../doc/models/component-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 [`ComponentResponse`](../../doc/models/component-response.md). ## Example Usage @@ -448,9 +448,9 @@ const body: CreatePrepaidComponent = { try { const { result, ...httpResponse } = await componentsController.createPrepaidUsageComponent( - productFamilyId, - body -); + productFamilyId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -559,7 +559,7 @@ async createEventBasedComponent( ## 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 [ComponentResponse](../../doc/models/component-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 [`ComponentResponse`](../../doc/models/component-response.md). ## Example Usage @@ -586,9 +586,9 @@ const body: CreateEBBComponent = { try { const { result, ...httpResponse } = await componentsController.createEventBasedComponent( - productFamilyId, - body -); + productFamilyId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -666,7 +666,7 @@ async findComponent( ## 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 [ComponentResponse](../../doc/models/component-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 [`ComponentResponse`](../../doc/models/component-response.md). ## Example Usage @@ -740,7 +740,7 @@ async readComponent( ## 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 [ComponentResponse](../../doc/models/component-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 [`ComponentResponse`](../../doc/models/component-response.md). ## Example Usage @@ -751,9 +751,9 @@ const componentId = 'component_id8'; try { const { result, ...httpResponse } = await componentsController.readComponent( - productFamilyId, - componentId -); + productFamilyId, + componentId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -822,7 +822,7 @@ async updateProductFamilyComponent( ## 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 [ComponentResponse](../../doc/models/component-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 [`ComponentResponse`](../../doc/models/component-response.md). ## Example Usage @@ -839,10 +839,10 @@ const body: UpdateComponentRequest = { try { const { result, ...httpResponse } = await componentsController.updateProductFamilyComponent( - productFamilyId, - componentId, - body -); + productFamilyId, + componentId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -912,7 +912,7 @@ async archiveComponent( ## 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 [Component](../../doc/models/component.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 [`Component`](../../doc/models/component.md). ## Example Usage @@ -923,9 +923,9 @@ const componentId = 'component_id8'; try { const { result, ...httpResponse } = await componentsController.archiveComponent( - productFamilyId, - componentId -); + productFamilyId, + componentId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -975,15 +975,27 @@ This request will return a list of components for a site. ```ts async listComponents( - dateField?: BasicDateField, - startDate?: string, - endDate?: string, - startDatetime?: string, - endDatetime?: string, - includeArchived?: boolean, - page?: number, - perPage?: number, - filter?: ListComponentsFilter, + { + dateField, + startDate, + endDate, + startDatetime, + endDatetime, + includeArchived, + page, + perPage, + filter, + }: { + dateField?: BasicDateField; + startDate?: string; + endDate?: string; + startDatetime?: string; + endDatetime?: string; + includeArchived?: boolean; + page?: number; + perPage?: number; + filter?: ListComponentsFilter; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -1005,7 +1017,7 @@ async listComponents( ## 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 [ComponentResponse[]](../../doc/models/component-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 [`ComponentResponse[]`](../../doc/models/component-response.md). ## Example Usage @@ -1159,7 +1171,7 @@ async updateComponent( ## 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 [ComponentResponse](../../doc/models/component-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 [`ComponentResponse`](../../doc/models/component-response.md). ## Example Usage @@ -1174,9 +1186,9 @@ const body: UpdateComponentRequest = { try { const { result, ...httpResponse } = await componentsController.updateComponent( - componentId, - body -); + componentId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1230,16 +1242,29 @@ This request will return a list of components for a particular product family. ```ts async listComponentsForProductFamily( - productFamilyId: number, - includeArchived?: boolean, - page?: number, - perPage?: number, - filter?: ListComponentsFilter, - dateField?: BasicDateField, - endDate?: string, - endDatetime?: string, - startDate?: string, - startDatetime?: string, + { + productFamilyId, + includeArchived, + page, + perPage, + filter, + dateField, + endDate, + endDatetime, + startDate, + startDatetime, + }: { + productFamilyId: number; + includeArchived?: boolean; + page?: number; + perPage?: number; + filter?: ListComponentsFilter; + dateField?: BasicDateField; + endDate?: string; + endDatetime?: string; + startDate?: string; + startDatetime?: string; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -1262,7 +1287,7 @@ async listComponentsForProductFamily( ## 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 [ComponentResponse[]](../../doc/models/component-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 [`ComponentResponse[]`](../../doc/models/component-response.md). ## Example Usage diff --git a/doc/controllers/coupons.md b/doc/controllers/coupons.md index 46de50d1..3bca43b5 100644 --- a/doc/controllers/coupons.md +++ b/doc/controllers/coupons.md @@ -61,7 +61,7 @@ async createCoupon( ## 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 [CouponResponse](../../doc/models/coupon-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 [`CouponResponse`](../../doc/models/coupon-response.md). ## Example Usage @@ -94,9 +94,9 @@ const body: CouponRequest = { try { const { result, ...httpResponse } = await couponsController.createCoupon( - productFamilyId, - body -); + productFamilyId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -122,11 +122,19 @@ If the coupon is set to `use_site_exchange_rate: true`, it will return pricing b ```ts async listCouponsForProductFamily( - productFamilyId: number, - page?: number, - perPage?: number, - filter?: ListCouponsFilter, - currencyPrices?: boolean, + { + productFamilyId, + page, + perPage, + filter, + currencyPrices, + }: { + productFamilyId: number; + page?: number; + perPage?: number; + filter?: ListCouponsFilter; + currencyPrices?: boolean; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -144,7 +152,7 @@ async listCouponsForProductFamily( ## 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 [CouponResponse[]](../../doc/models/coupon-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 [`CouponResponse[]`](../../doc/models/coupon-response.md). ## Example Usage @@ -301,7 +309,7 @@ async findCoupon( ## 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 [CouponResponse](../../doc/models/coupon-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 [`CouponResponse`](../../doc/models/coupon-response.md). ## Example Usage @@ -310,10 +318,10 @@ const currencyPrices = true; try { const { result, ...httpResponse } = await couponsController.findCoupon( - undefined, - undefined, - currencyPrices -); + undefined, + undefined, + currencyPrices + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -354,7 +362,7 @@ async readCoupon( ## 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 [CouponResponse](../../doc/models/coupon-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 [`CouponResponse`](../../doc/models/coupon-response.md). ## Example Usage @@ -367,10 +375,10 @@ const currencyPrices = true; try { const { result, ...httpResponse } = await couponsController.readCoupon( - productFamilyId, - couponId, - currencyPrices -); + productFamilyId, + couponId, + currencyPrices + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -440,7 +448,7 @@ async updateCoupon( ## 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 [CouponResponse](../../doc/models/coupon-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 [`CouponResponse`](../../doc/models/coupon-response.md). ## Example Usage @@ -473,10 +481,10 @@ const body: CouponRequest = { try { const { result, ...httpResponse } = await couponsController.updateCoupon( - productFamilyId, - couponId, - body -); + productFamilyId, + couponId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -547,7 +555,7 @@ async archiveCoupon( ## 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 [CouponResponse](../../doc/models/coupon-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 [`CouponResponse`](../../doc/models/coupon-response.md). ## Example Usage @@ -558,9 +566,9 @@ const couponId = 162; try { const { result, ...httpResponse } = await couponsController.archiveCoupon( - productFamilyId, - couponId -); + productFamilyId, + couponId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -609,10 +617,17 @@ If the coupon is set to `use_site_exchange_rate: true`, it will return pricing b ```ts async listCoupons( - page?: number, - perPage?: number, - filter?: ListCouponsFilter, - currencyPrices?: boolean, + { + page, + perPage, + filter, + currencyPrices, + }: { + page?: number; + perPage?: number; + filter?: ListCouponsFilter; + currencyPrices?: boolean; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -629,7 +644,7 @@ async listCoupons( ## 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 [CouponResponse[]](../../doc/models/coupon-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 [`CouponResponse[]`](../../doc/models/coupon-response.md). ## Example Usage @@ -738,7 +753,7 @@ async readCouponUsage( ## 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 [CouponUsage[]](../../doc/models/coupon-usage.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 [`CouponUsage[]`](../../doc/models/coupon-usage.md). ## Example Usage @@ -749,9 +764,9 @@ const couponId = 162; try { const { result, ...httpResponse } = await couponsController.readCouponUsage( - productFamilyId, - couponId -); + productFamilyId, + couponId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -839,7 +854,7 @@ async validateCoupon( ## 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 [CouponResponse](../../doc/models/coupon-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 [`CouponResponse`](../../doc/models/coupon-response.md). ## Example Usage @@ -918,7 +933,7 @@ async createOrUpdateCouponCurrencyPrices( ## 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 [CouponCurrencyResponse](../../doc/models/coupon-currency-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 [`CouponCurrencyResponse`](../../doc/models/coupon-currency-response.md). ## Example Usage @@ -940,9 +955,9 @@ const body: CouponCurrencyRequest = { try { const { result, ...httpResponse } = await couponsController.createOrUpdateCouponCurrencyPrices( - couponId, - body -); + couponId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1021,7 +1036,7 @@ async createCouponSubcodes( ## 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 [CouponSubcodesResponse](../../doc/models/coupon-subcodes-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 [`CouponSubcodesResponse`](../../doc/models/coupon-subcodes-response.md). ## Example Usage @@ -1038,9 +1053,9 @@ const body: CouponSubcodes = { try { const { result, ...httpResponse } = await couponsController.createCouponSubcodes( - couponId, - body -); + couponId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1070,9 +1085,15 @@ This request allows you to request the subcodes that are attached to a coupon. ```ts async listCouponSubcodes( - couponId: number, - page?: number, - perPage?: number, + { + couponId, + page, + perPage, + }: { + couponId: number; + page?: number; + perPage?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -1088,7 +1109,7 @@ async listCouponSubcodes( ## 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 [CouponSubcodes](../../doc/models/coupon-subcodes.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 [`CouponSubcodes`](../../doc/models/coupon-subcodes.md). ## Example Usage @@ -1173,7 +1194,7 @@ async updateCouponSubcodes( ## 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 [CouponSubcodesResponse](../../doc/models/coupon-subcodes-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 [`CouponSubcodesResponse`](../../doc/models/coupon-subcodes-response.md). ## Example Usage @@ -1190,9 +1211,9 @@ const body: CouponSubcodes = { try { const { result, ...httpResponse } = await couponsController.updateCouponSubcodes( - couponId, - body -); + couponId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1258,9 +1279,9 @@ const subcode = 'subcode4'; try { const { result, ...httpResponse } = await couponsController.deleteCouponSubcode( - couponId, - subcode -); + couponId, + subcode + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/custom-fields.md b/doc/controllers/custom-fields.md index 6a6c3ce4..6bccc7ba 100644 --- a/doc/controllers/custom-fields.md +++ b/doc/controllers/custom-fields.md @@ -66,7 +66,7 @@ async createMetafields( ## 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 [Metafield[]](../../doc/models/metafield.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 [`Metafield[]`](../../doc/models/metafield.md). ## Example Usage @@ -90,9 +90,9 @@ const body: CreateMetafieldsRequest = { try { const { result, ...httpResponse } = await customFieldsController.createMetafields( - resourceType, - body -); + resourceType, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -147,11 +147,19 @@ This endpoint lists metafields associated with a site. The metafield description ```ts async listMetafields( - resourceType: ResourceType, - name?: string, - page?: number, - perPage?: number, - direction?: SortingDirection, + { + resourceType, + name, + page, + perPage, + direction, + }: { + resourceType: ResourceType; + name?: string; + page?: number; + perPage?: number; + direction?: SortingDirection; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -169,7 +177,7 @@ async listMetafields( ## 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 [ListMetafieldsResponse](../../doc/models/list-metafields-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 [`ListMetafieldsResponse`](../../doc/models/list-metafields-response.md). ## Example Usage @@ -243,7 +251,7 @@ async updateMetafield( ## 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 [Metafield[]](../../doc/models/metafield.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 [`Metafield[]`](../../doc/models/metafield.md). ## Example Usage @@ -364,7 +372,7 @@ async createMetadata( ## 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 [Metadata[]](../../doc/models/metadata.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 [`Metadata[]`](../../doc/models/metadata.md). ## Example Usage @@ -388,10 +396,10 @@ const body: CreateMetadataRequest = { try { const { result, ...httpResponse } = await customFieldsController.createMetadata( - resourceType, - resourceId, - body -); + resourceType, + resourceId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -419,10 +427,17 @@ This endpoint will also display the current stats of your metadata to use as a t ```ts async listMetadata( - resourceType: ResourceType, - resourceId: number, - page?: number, - perPage?: number, + { + resourceType, + resourceId, + page, + perPage, + }: { + resourceType: ResourceType; + resourceId: number; + page?: number; + perPage?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -439,7 +454,7 @@ async listMetadata( ## 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 [PaginatedMetadata](../../doc/models/paginated-metadata.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 [`PaginatedMetadata`](../../doc/models/paginated-metadata.md). ## Example Usage @@ -488,7 +503,7 @@ async updateMetadata( ## 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 [Metadata[]](../../doc/models/metadata.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 [`Metadata[]`](../../doc/models/metadata.md). ## Example Usage @@ -499,9 +514,9 @@ const resourceId = 60; try { const { result, ...httpResponse } = await customFieldsController.updateMetadata( - resourceType, - resourceId -); + resourceType, + resourceId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -578,9 +593,9 @@ const resourceId = 60; try { const { result, ...httpResponse } = await customFieldsController.deleteMetadata( - resourceType, - resourceId -); + resourceType, + resourceId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -616,17 +631,31 @@ This endpoint will list the number of pages of metadata information that are con ```ts async listMetadataForResourceType( - resourceType: ResourceType, - page?: number, - perPage?: number, - dateField?: BasicDateField, - startDate?: string, - endDate?: string, - startDatetime?: string, - endDatetime?: string, - withDeleted?: boolean, - resourceIds?: number[], - direction?: SortingDirection, + { + resourceType, + page, + perPage, + dateField, + startDate, + endDate, + startDatetime, + endDatetime, + withDeleted, + resourceIds, + direction, + }: { + resourceType: ResourceType; + page?: number; + perPage?: number; + dateField?: BasicDateField; + startDate?: string; + endDate?: string; + startDatetime?: string; + endDatetime?: string; + withDeleted?: boolean; + resourceIds?: number[]; + direction?: SortingDirection; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -650,7 +679,7 @@ async listMetadataForResourceType( ## 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 [PaginatedMetadata](../../doc/models/paginated-metadata.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 [`PaginatedMetadata`](../../doc/models/paginated-metadata.md). ## Example Usage diff --git a/doc/controllers/customers.md b/doc/controllers/customers.md index ed131aea..c9f44fd8 100644 --- a/doc/controllers/customers.md +++ b/doc/controllers/customers.md @@ -62,7 +62,7 @@ async createCustomer( ## 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 @@ -160,15 +160,27 @@ To retrieve a single, exact match by reference, please use the [lookup endpoint] ```ts async listCustomers( - direction?: SortingDirection, - page?: number, - perPage?: number, - dateField?: BasicDateField, - startDate?: string, - endDate?: string, - startDatetime?: string, - endDatetime?: string, - q?: string, + { + direction, + page, + perPage, + dateField, + startDate, + endDate, + startDatetime, + endDatetime, + q, + }: { + direction?: SortingDirection; + page?: number; + perPage?: number; + dateField?: BasicDateField; + startDate?: string; + endDate?: string; + startDatetime?: string; + endDatetime?: string; + q?: string; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -190,7 +202,7 @@ async listCustomers( ## 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 @@ -318,7 +330,7 @@ async readCustomer( ## 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 @@ -360,7 +372,7 @@ async updateCustomer( ## 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 @@ -377,9 +389,9 @@ const body: UpdateCustomerRequest = { try { const { result, ...httpResponse } = await customersController.updateCustomer( - id, - body -); + id, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -489,7 +501,7 @@ async readCustomerByReference( ## 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 @@ -529,7 +541,7 @@ async listCustomerSubscriptions( ## 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 [SubscriptionResponse[]](../../doc/models/subscription-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 [`SubscriptionResponse[]`](../../doc/models/subscription-response.md). ## Example Usage diff --git a/doc/controllers/events-based-billing-segments.md b/doc/controllers/events-based-billing-segments.md index 5d4953f9..cb3cd878 100644 --- a/doc/controllers/events-based-billing-segments.md +++ b/doc/controllers/events-based-billing-segments.md @@ -44,7 +44,7 @@ async createSegment( ## 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 [SegmentResponse](../../doc/models/segment-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 [`SegmentResponse`](../../doc/models/segment-response.md). ## Example Usage @@ -74,10 +74,10 @@ const body: CreateSegmentRequest = { try { const { result, ...httpResponse } = await eventsBasedBillingSegmentsController.createSegment( - componentId, - pricePointId, - body -); + componentId, + pricePointId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -106,11 +106,19 @@ You may specify component and/or price point by using either the numeric ID or t ```ts async listSegmentsForPricePoint( - componentId: string, - pricePointId: string, - page?: number, - perPage?: number, - filter?: ListSegmentsFilter, + { + componentId, + pricePointId, + page, + perPage, + filter, + }: { + componentId: string; + pricePointId: string; + page?: number; + perPage?: number; + filter?: ListSegmentsFilter; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -128,7 +136,7 @@ async listSegmentsForPricePoint( ## 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 [ListSegmentsResponse](../../doc/models/list-segments-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 [`ListSegmentsResponse`](../../doc/models/list-segments-response.md). ## Example Usage @@ -191,7 +199,7 @@ async updateSegment( ## 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 [SegmentResponse](../../doc/models/segment-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 [`SegmentResponse`](../../doc/models/segment-response.md). ## Example Usage @@ -204,10 +212,10 @@ const id = 60; try { const { result, ...httpResponse } = await eventsBasedBillingSegmentsController.updateSegment( - componentId, - pricePointId, - id -); + componentId, + pricePointId, + id + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -265,10 +273,10 @@ const id = 60; try { const { result, ...httpResponse } = await eventsBasedBillingSegmentsController.deleteSegment( - componentId, - pricePointId, - id -); + componentId, + pricePointId, + id + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -315,7 +323,7 @@ async bulkCreateSegments( ## 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 [ListSegmentsResponse](../../doc/models/list-segments-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 [`ListSegmentsResponse`](../../doc/models/list-segments-response.md). ## Example Usage @@ -326,9 +334,9 @@ const pricePointId = 'price_point_id8'; try { const { result, ...httpResponse } = await eventsBasedBillingSegmentsController.bulkCreateSegments( - componentId, - pricePointId -); + componentId, + pricePointId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -375,7 +383,7 @@ async bulkUpdateSegments( ## 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 [ListSegmentsResponse](../../doc/models/list-segments-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 [`ListSegmentsResponse`](../../doc/models/list-segments-response.md). ## Example Usage @@ -386,9 +394,9 @@ const pricePointId = 'price_point_id8'; try { const { result, ...httpResponse } = await eventsBasedBillingSegmentsController.bulkUpdateSegments( - componentId, - pricePointId -); + componentId, + pricePointId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/events.md b/doc/controllers/events.md index 23bc0552..d0a2b11c 100644 --- a/doc/controllers/events.md +++ b/doc/controllers/events.md @@ -88,17 +88,31 @@ Here’s an example event for the `subscription_state_change` event: ```ts async listEvents( - page?: number, - perPage?: number, - sinceId?: bigint, - maxId?: bigint, - direction?: Direction, - filter?: EventKey[], - dateField?: ListEventsDateField, - startDate?: string, - endDate?: string, - startDatetime?: string, - endDatetime?: string, + { + page, + perPage, + sinceId, + maxId, + direction, + filter, + dateField, + startDate, + endDate, + startDatetime, + endDatetime, + }: { + page?: number; + perPage?: number; + sinceId?: bigint; + maxId?: bigint; + direction?: Direction; + filter?: EventKey[]; + dateField?: ListEventsDateField; + startDate?: string; + endDate?: string; + startDatetime?: string; + endDatetime?: string; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -122,7 +136,7 @@ async listEvents( ## 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 [EventResponse[]](../../doc/models/event-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 [`EventResponse[]`](../../doc/models/event-response.md). ## Example Usage @@ -229,13 +243,23 @@ For precise mappings from key to event_specific_data, refer to [Event](../../doc ```ts async listSubscriptionEvents( - subscriptionId: number, - page?: number, - perPage?: number, - sinceId?: bigint, - maxId?: bigint, - direction?: Direction, - filter?: EventKey[], + { + subscriptionId, + page, + perPage, + sinceId, + maxId, + direction, + filter, + }: { + subscriptionId: number; + page?: number; + perPage?: number; + sinceId?: bigint; + maxId?: bigint; + direction?: Direction; + filter?: EventKey[]; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -255,7 +279,7 @@ async listSubscriptionEvents( ## 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 [EventResponse[]](../../doc/models/event-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 [`EventResponse[]`](../../doc/models/event-response.md). ## Example Usage @@ -333,12 +357,21 @@ Get a count of all the events for a given site by using this method. ```ts async readEventsCount( - page?: number, - perPage?: number, - sinceId?: bigint, - maxId?: bigint, - direction?: Direction, - filter?: EventKey[], + { + page, + perPage, + sinceId, + maxId, + direction, + filter, + }: { + page?: number; + perPage?: number; + sinceId?: bigint; + maxId?: bigint; + direction?: Direction; + filter?: EventKey[]; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -357,7 +390,7 @@ async readEventsCount( ## 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 [CountResponse](../../doc/models/count-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 [`CountResponse`](../../doc/models/count-response.md). ## Example Usage diff --git a/doc/controllers/insights.md b/doc/controllers/insights.md index b165bb05..c514eb16 100644 --- a/doc/controllers/insights.md +++ b/doc/controllers/insights.md @@ -42,7 +42,7 @@ async readSiteStats( ## 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 [SiteSummary](../../doc/models/site-summary.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 [`SiteSummary`](../../doc/models/site-summary.md). ## Example Usage @@ -103,7 +103,7 @@ async readMrr( ## 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 [MRRResponse](../../doc/models/mrr-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 [`MRRResponse`](../../doc/models/mrr-response.md). ## Example Usage @@ -172,10 +172,17 @@ Usage includes revenue from: ```ts async listMrrMovements( - subscriptionId?: number, - page?: number, - perPage?: number, - direction?: SortingDirection, + { + subscriptionId, + page, + perPage, + direction, + }: { + subscriptionId?: number; + page?: number; + perPage?: number; + direction?: SortingDirection; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -192,7 +199,7 @@ async listMrrMovements( ## 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 [ListMRRResponse](../../doc/models/list-mrr-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 [`ListMRRResponse`](../../doc/models/list-mrr-response.md). ## Example Usage @@ -275,11 +282,19 @@ This endpoint returns your site's current MRR, including plan and usage breakout ```ts async listMrrPerSubscription( - filter?: ListMrrFilter, - atTime?: string, - page?: number, - perPage?: number, - direction?: Direction, + { + filter, + atTime, + page, + perPage, + direction, + }: { + filter?: ListMrrFilter; + atTime?: string; + page?: number; + perPage?: number; + direction?: Direction; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -297,7 +312,7 @@ async listMrrPerSubscription( ## 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 [SubscriptionMRRResponse](../../doc/models/subscription-mrr-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 [`SubscriptionMRRResponse`](../../doc/models/subscription-mrr-response.md). ## Example Usage diff --git a/doc/controllers/invoices.md b/doc/controllers/invoices.md index b473d3f7..41c6966e 100644 --- a/doc/controllers/invoices.md +++ b/doc/controllers/invoices.md @@ -57,7 +57,7 @@ async refundInvoice( ## 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 @@ -77,9 +77,9 @@ const body: RefundInvoiceRequest = { try { const { result, ...httpResponse } = await invoicesController.refundInvoice( - uid, - body -); + uid, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -103,29 +103,55 @@ By default, invoices returned on the index will only include totals, not detaile ```ts async listInvoices( - startDate?: string, - endDate?: string, - status?: InvoiceStatus, - subscriptionId?: number, - subscriptionGroupUid?: string, - consolidationLevel?: string, - page?: number, - perPage?: number, - direction?: Direction, - lineItems?: boolean, - discounts?: boolean, - taxes?: boolean, - credits?: boolean, - payments?: boolean, - customFields?: boolean, - refunds?: boolean, - dateField?: InvoiceDateField, - startDatetime?: string, - endDatetime?: string, - customerIds?: number[], - mNumber?: string[], - productIds?: number[], - sort?: InvoiceSortField, + { + startDate, + endDate, + status, + subscriptionId, + subscriptionGroupUid, + consolidationLevel, + page, + perPage, + direction, + lineItems, + discounts, + taxes, + credits, + payments, + customFields, + refunds, + dateField, + startDatetime, + endDatetime, + customerIds, + mNumber, + productIds, + sort, + }: { + startDate?: string; + endDate?: string; + status?: InvoiceStatus; + subscriptionId?: number; + subscriptionGroupUid?: string; + consolidationLevel?: string; + page?: number; + perPage?: number; + direction?: Direction; + lineItems?: boolean; + discounts?: boolean; + taxes?: boolean; + credits?: boolean; + payments?: boolean; + customFields?: boolean; + refunds?: boolean; + dateField?: InvoiceDateField; + startDatetime?: string; + endDatetime?: string; + customerIds?: number[]; + mNumber?: string[]; + productIds?: number[]; + sort?: InvoiceSortField; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -161,7 +187,7 @@ async listInvoices( ## 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 [ListInvoicesResponse](../../doc/models/list-invoices-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 [`ListInvoicesResponse`](../../doc/models/list-invoices-response.md). ## Example Usage @@ -513,7 +539,7 @@ async readInvoice( ## 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 @@ -671,13 +697,23 @@ Note - invoice events that occurred prior to 09/05/2018 __will not__ contain an ```ts async listInvoiceEvents( - sinceDate?: string, - sinceId?: bigint, - page?: number, - perPage?: number, - invoiceUid?: string, - withChangeInvoiceStatus?: string, - eventTypes?: InvoiceEventType[], + { + sinceDate, + sinceId, + page, + perPage, + invoiceUid, + withChangeInvoiceStatus, + eventTypes, + }: { + sinceDate?: string; + sinceId?: bigint; + page?: number; + perPage?: number; + invoiceUid?: string; + withChangeInvoiceStatus?: string; + eventTypes?: InvoiceEventType[]; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -697,7 +733,7 @@ async listInvoiceEvents( ## 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 [ListInvoiceEventsResponse](../../doc/models/list-invoice-events-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 [`ListInvoiceEventsResponse`](../../doc/models/list-invoice-events-response.md). ## Example Usage @@ -1125,7 +1161,7 @@ async recordPaymentForInvoice( ## 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 @@ -1143,9 +1179,9 @@ const body: CreateInvoicePaymentRequest = { try { const { result, ...httpResponse } = await invoicesController.recordPaymentForInvoice( - uid, - body -); + uid, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1208,7 +1244,7 @@ async recordPaymentForMultipleInvoices( ## 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 [MultiInvoicePaymentResponse](../../doc/models/multi-invoice-payment-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 [`MultiInvoicePaymentResponse`](../../doc/models/multi-invoice-payment-response.md). ## Example Usage @@ -1283,14 +1319,25 @@ By default, the credit notes returned by this endpoint will exclude the arrays o ```ts async listCreditNotes( - subscriptionId?: number, - page?: number, - perPage?: number, - lineItems?: boolean, - discounts?: boolean, - taxes?: boolean, - refunds?: boolean, - applications?: boolean, + { + subscriptionId, + page, + perPage, + lineItems, + discounts, + taxes, + refunds, + applications, + }: { + subscriptionId?: number; + page?: number; + perPage?: number; + lineItems?: boolean; + discounts?: boolean; + taxes?: boolean; + refunds?: boolean; + applications?: boolean; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -1311,7 +1358,7 @@ async listCreditNotes( ## 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 [ListCreditNotesResponse](../../doc/models/list-credit-notes-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 [`ListCreditNotesResponse`](../../doc/models/list-credit-notes-response.md). ## Example Usage @@ -1660,7 +1707,7 @@ async readCreditNote( ## 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 [CreditNote](../../doc/models/credit-note.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 [`CreditNote`](../../doc/models/credit-note.md). ## Example Usage @@ -2017,7 +2064,7 @@ async recordPaymentForSubscription( ## 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 [RecordPaymentResponse](../../doc/models/record-payment-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 [`RecordPaymentResponse`](../../doc/models/record-payment-response.md). ## Example Usage @@ -2035,9 +2082,9 @@ const body: RecordPaymentRequest = { try { const { result, ...httpResponse } = await invoicesController.recordPaymentForSubscription( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -2108,7 +2155,7 @@ async reopenInvoice( ## 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 @@ -2157,7 +2204,7 @@ async voidInvoice( ## 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 @@ -2172,9 +2219,9 @@ const body: VoidInvoiceRequest = { try { const { result, ...httpResponse } = await invoicesController.voidInvoice( - uid, - body -); + uid, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -2199,10 +2246,17 @@ Invoice segments returned on the index will only include totals, not detailed br ```ts async listConsolidatedInvoiceSegments( - invoiceUid: string, - page?: number, - perPage?: number, - direction?: Direction, + { + invoiceUid, + page, + perPage, + direction, + }: { + invoiceUid: string; + page?: number; + perPage?: number; + direction?: Direction; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -2219,7 +2273,7 @@ async listConsolidatedInvoiceSegments( ## 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 [ConsolidatedInvoice](../../doc/models/consolidated-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 [`ConsolidatedInvoice`](../../doc/models/consolidated-invoice.md). ## Example Usage @@ -2705,7 +2759,7 @@ async createInvoice( ## 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 [InvoiceResponse](../../doc/models/invoice-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 [`InvoiceResponse`](../../doc/models/invoice-response.md). ## Example Usage @@ -2726,9 +2780,9 @@ const body: CreateInvoiceRequest = { try { const { result, ...httpResponse } = await invoicesController.createInvoice( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -2890,9 +2944,9 @@ const body: SendInvoiceRequest = { try { const { result, ...httpResponse } = await invoicesController.sendInvoice( - uid, - body -); + uid, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -2932,7 +2986,7 @@ async previewCustomerInformationChanges( ## 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 [CustomerChangesPreviewResponse](../../doc/models/customer-changes-preview-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 [`CustomerChangesPreviewResponse`](../../doc/models/customer-changes-preview-response.md). ## Example Usage @@ -3034,7 +3088,7 @@ async updateCustomerInformation( ## 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 @@ -3281,7 +3335,7 @@ async issueInvoice( ## 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 @@ -3294,9 +3348,9 @@ const body: IssueInvoiceRequest = { try { const { result, ...httpResponse } = await invoicesController.issueInvoice( - uid, - body -); + uid, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/offers.md b/doc/controllers/offers.md index fada7676..d8f39f85 100644 --- a/doc/controllers/offers.md +++ b/doc/controllers/offers.md @@ -49,7 +49,7 @@ async createOffer( ## 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 [OfferResponse](../../doc/models/offer-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 [`OfferResponse`](../../doc/models/offer-response.md). ## Example Usage @@ -140,9 +140,15 @@ This endpoint will list offers for a site. ```ts async listOffers( - page?: number, - perPage?: number, - includeArchived?: boolean, + { + page, + perPage, + includeArchived, + }: { + page?: number; + perPage?: number; + includeArchived?: boolean; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -158,7 +164,7 @@ async listOffers( ## 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 [ListOffersResponse](../../doc/models/list-offers-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 [`ListOffersResponse`](../../doc/models/list-offers-response.md). ## Example Usage @@ -263,7 +269,7 @@ async readOffer( ## 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 [OfferResponse](../../doc/models/offer-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 [`OfferResponse`](../../doc/models/offer-response.md). ## Example Usage diff --git a/doc/controllers/payment-profiles.md b/doc/controllers/payment-profiles.md index 60dfcd69..a7b1dcc7 100644 --- a/doc/controllers/payment-profiles.md +++ b/doc/controllers/payment-profiles.md @@ -315,7 +315,7 @@ async createPaymentProfile( ## 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 [PaymentProfileResponse](../../doc/models/payment-profile-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 [`PaymentProfileResponse`](../../doc/models/payment-profile-response.md). ## Example Usage @@ -387,9 +387,15 @@ This method will return all of the active `payment_profiles` for a Site, or for ```ts async listPaymentProfiles( - page?: number, - perPage?: number, - customerId?: number, + { + page, + perPage, + customerId, + }: { + page?: number; + perPage?: number; + customerId?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -405,7 +411,7 @@ async listPaymentProfiles( ## 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 [PaymentProfileResponse[]](../../doc/models/payment-profile-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 [`PaymentProfileResponse[]`](../../doc/models/payment-profile-response.md). ## Example Usage @@ -547,7 +553,7 @@ async readPaymentProfile( ## 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 [PaymentProfileResponse](../../doc/models/payment-profile-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 [`PaymentProfileResponse`](../../doc/models/payment-profile-response.md). ## Example Usage @@ -659,7 +665,7 @@ async updatePaymentProfile( ## 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 [PaymentProfileResponse](../../doc/models/payment-profile-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 [`PaymentProfileResponse`](../../doc/models/payment-profile-response.md). ## Example Usage @@ -686,9 +692,9 @@ const body: UpdatePaymentProfileRequest = { try { const { result, ...httpResponse } = await paymentProfilesController.updatePaymentProfile( - paymentProfileId, - body -); + paymentProfileId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -822,9 +828,9 @@ const paymentProfileId = 198; try { const { result, ...httpResponse } = await paymentProfilesController.deleteSubscriptionsPaymentProfile( - subscriptionId, - paymentProfileId -); + subscriptionId, + paymentProfileId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -858,7 +864,7 @@ async verifyBankAccount( ## 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 [BankAccountResponse](../../doc/models/bank-account-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 [`BankAccountResponse`](../../doc/models/bank-account-response.md). ## Example Usage @@ -874,9 +880,9 @@ const body: BankAccountVerificationRequest = { try { const { result, ...httpResponse } = await paymentProfilesController.verifyBankAccount( - bankAccountId, - body -); + bankAccountId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -958,9 +964,9 @@ const paymentProfileId = 198; try { const { result, ...httpResponse } = await paymentProfilesController.deleteSubscriptionGroupPaymentProfile( - uid, - paymentProfileId -); + uid, + paymentProfileId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -996,7 +1002,7 @@ async changeSubscriptionDefaultPaymentProfile( ## 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 [PaymentProfileResponse](../../doc/models/payment-profile-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 [`PaymentProfileResponse`](../../doc/models/payment-profile-response.md). ## Example Usage @@ -1007,9 +1013,9 @@ const paymentProfileId = 198; try { const { result, ...httpResponse } = await paymentProfilesController.changeSubscriptionDefaultPaymentProfile( - subscriptionId, - paymentProfileId -); + subscriptionId, + paymentProfileId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1083,7 +1089,7 @@ async changeSubscriptionGroupDefaultPaymentProfile( ## 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 [PaymentProfileResponse](../../doc/models/payment-profile-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 [`PaymentProfileResponse`](../../doc/models/payment-profile-response.md). ## Example Usage @@ -1094,9 +1100,9 @@ const paymentProfileId = 198; try { const { result, ...httpResponse } = await paymentProfilesController.changeSubscriptionGroupDefaultPaymentProfile( - uid, - paymentProfileId -); + uid, + paymentProfileId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1167,7 +1173,7 @@ async readOneTimeToken( ## 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 [GetOneTimeTokenRequest](../../doc/models/get-one-time-token-request.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 [`GetOneTimeTokenRequest`](../../doc/models/get-one-time-token-request.md). ## Example Usage diff --git a/doc/controllers/product-families.md b/doc/controllers/product-families.md index 1c2885a2..5e4a81c0 100644 --- a/doc/controllers/product-families.md +++ b/doc/controllers/product-families.md @@ -22,17 +22,31 @@ This method allows to retrieve a list of Products belonging to a Product Family. ```ts async listProductsForProductFamily( - productFamilyId: string, - page?: number, - perPage?: number, - dateField?: BasicDateField, - filter?: ListProductsFilter, - startDate?: string, - endDate?: string, - startDatetime?: string, - endDatetime?: string, - includeArchived?: boolean, - include?: ListProductsInclude, + { + productFamilyId, + page, + perPage, + dateField, + filter, + startDate, + endDate, + startDatetime, + endDatetime, + includeArchived, + include, + }: { + productFamilyId: string; + page?: number; + perPage?: number; + dateField?: BasicDateField; + filter?: ListProductsFilter; + startDate?: string; + endDate?: string; + startDatetime?: string; + endDatetime?: string; + includeArchived?: boolean; + include?: ListProductsInclude; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -56,7 +70,7 @@ async listProductsForProductFamily( ## 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 [ProductResponse[]](../../doc/models/product-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 [`ProductResponse[]`](../../doc/models/product-response.md). ## Example Usage @@ -216,7 +230,7 @@ async createProductFamily( ## 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 [ProductFamilyResponse](../../doc/models/product-family-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 [`ProductFamilyResponse`](../../doc/models/product-family-response.md). ## Example Usage @@ -267,11 +281,19 @@ This method allows to retrieve a list of Product Families for a site. ```ts async listProductFamilies( - dateField?: BasicDateField, - startDate?: string, - endDate?: string, - startDatetime?: string, - endDatetime?: string, + { + dateField, + startDate, + endDate, + startDatetime, + endDatetime, + }: { + dateField?: BasicDateField; + startDate?: string; + endDate?: string; + startDatetime?: string; + endDatetime?: string; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -289,7 +311,7 @@ async listProductFamilies( ## 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 [ProductFamilyResponse[]](../../doc/models/product-family-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 [`ProductFamilyResponse[]`](../../doc/models/product-family-response.md). ## Example Usage @@ -362,7 +384,7 @@ async readProductFamily( ## 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 [ProductFamilyResponse](../../doc/models/product-family-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 [`ProductFamilyResponse`](../../doc/models/product-family-response.md). ## Example Usage diff --git a/doc/controllers/product-price-points.md b/doc/controllers/product-price-points.md index d7991465..3f0fc462 100644 --- a/doc/controllers/product-price-points.md +++ b/doc/controllers/product-price-points.md @@ -45,7 +45,7 @@ async createProductPricePoint( ## 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 [ProductPricePointResponse](../../doc/models/product-price-point-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 [`ProductPricePointResponse`](../../doc/models/product-price-point-response.md). ## Example Usage @@ -72,9 +72,9 @@ const body: CreateProductPricePointRequest = { try { const { result, ...httpResponse } = await productPricePointsController.createProductPricePoint( - productId, - body -); + productId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -125,12 +125,21 @@ Use this endpoint to retrieve a list of product price points. ```ts async listProductPricePoints( - productId: ListProductPricePointsInputProductId, - page?: number, - perPage?: number, - currencyPrices?: boolean, - filterType?: PricePointType[], - archived?: boolean, + { + productId, + page, + perPage, + currencyPrices, + filterType, + archived, + }: { + productId: ListProductPricePointsInputProductId; + page?: number; + perPage?: number; + currencyPrices?: boolean; + filterType?: PricePointType[]; + archived?: boolean; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -149,7 +158,7 @@ async listProductPricePoints( ## 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 [ListProductPricePointsResponse](../../doc/models/list-product-price-points-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 [`ListProductPricePointsResponse`](../../doc/models/list-product-price-points-response.md). ## Example Usage @@ -228,7 +237,7 @@ async updateProductPricePoint( ## 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 [ProductPricePointResponse](../../doc/models/product-price-point-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 [`ProductPricePointResponse`](../../doc/models/product-price-point-response.md). ## Example Usage @@ -246,10 +255,10 @@ const body: UpdateProductPricePointRequest = { try { const { result, ...httpResponse } = await productPricePointsController.updateProductPricePoint( - productId, - pricePointId, - body -); + productId, + pricePointId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -312,7 +321,7 @@ async readProductPricePoint( ## 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 [ProductPricePointResponse](../../doc/models/product-price-point-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 [`ProductPricePointResponse`](../../doc/models/product-price-point-response.md). ## Example Usage @@ -323,9 +332,9 @@ const pricePointId: ReadProductPricePointPricePointId = 188; try { const { result, ...httpResponse } = await productPricePointsController.readProductPricePoint( - productId, - pricePointId -); + productId, + pricePointId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -386,7 +395,7 @@ async archiveProductPricePoint( ## 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 [ProductPricePointResponse](../../doc/models/product-price-point-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 [`ProductPricePointResponse`](../../doc/models/product-price-point-response.md). ## Example Usage @@ -397,9 +406,9 @@ const pricePointId: ArchiveProductPricePointPricePointId = 188; try { const { result, ...httpResponse } = await productPricePointsController.archiveProductPricePoint( - productId, - pricePointId -); + productId, + pricePointId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -466,7 +475,7 @@ async unarchiveProductPricePoint( ## 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 [ProductPricePointResponse](../../doc/models/product-price-point-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 [`ProductPricePointResponse`](../../doc/models/product-price-point-response.md). ## Example Usage @@ -477,9 +486,9 @@ const pricePointId = 10; try { const { result, ...httpResponse } = await productPricePointsController.unarchiveProductPricePoint( - productId, - pricePointId -); + productId, + pricePointId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -542,7 +551,7 @@ async promoteProductPricePointToDefault( ## 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 [ProductResponse](../../doc/models/product-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 [`ProductResponse`](../../doc/models/product-response.md). ## Example Usage @@ -553,9 +562,9 @@ const pricePointId = 10; try { const { result, ...httpResponse } = await productPricePointsController.promoteProductPricePointToDefault( - productId, - pricePointId -); + productId, + pricePointId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -642,7 +651,7 @@ async bulkCreateProductPricePoints( ## 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 [BulkCreateProductPricePointsResponse](../../doc/models/bulk-create-product-price-points-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 [`BulkCreateProductPricePointsResponse`](../../doc/models/bulk-create-product-price-points-response.md). ## Example Usage @@ -686,9 +695,9 @@ const body: BulkCreateProductPricePointsRequest = { try { const { result, ...httpResponse } = await productPricePointsController.bulkCreateProductPricePoints( - productId, - body -); + productId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -761,7 +770,7 @@ async createProductCurrencyPrices( ## 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 [CurrencyPricesResponse](../../doc/models/currency-prices-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 [`CurrencyPricesResponse`](../../doc/models/currency-prices-response.md). ## Example Usage @@ -790,9 +799,9 @@ const body: CreateProductCurrencyPricesRequest = { try { const { result, ...httpResponse } = await productPricePointsController.createProductCurrencyPrices( - productPricePointId, - body -); + productPricePointId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -853,7 +862,7 @@ async updateProductCurrencyPrices( ## 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 [CurrencyPricesResponse](../../doc/models/currency-prices-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 [`CurrencyPricesResponse`](../../doc/models/currency-prices-response.md). ## Example Usage @@ -875,9 +884,9 @@ const body: UpdateCurrencyPricesRequest = { try { const { result, ...httpResponse } = await productPricePointsController.updateProductCurrencyPrices( - productPricePointId, - body -); + productPricePointId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -918,11 +927,19 @@ This method allows retrieval of a list of Products Price Points belonging to a S ```ts async listAllProductPricePoints( - direction?: SortingDirection, - filter?: ListPricePointsFilter, - include?: ListProductsPricePointsInclude, - page?: number, - perPage?: number, + { + direction, + filter, + include, + page, + perPage, + }: { + direction?: SortingDirection; + filter?: ListPricePointsFilter; + include?: ListProductsPricePointsInclude; + page?: number; + perPage?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -940,7 +957,7 @@ async listAllProductPricePoints( ## 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 [ListProductPricePointsResponse](../../doc/models/list-product-price-points-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 [`ListProductPricePointsResponse`](../../doc/models/list-product-price-points-response.md). ## Example Usage diff --git a/doc/controllers/products.md b/doc/controllers/products.md index 19846de9..822795fe 100644 --- a/doc/controllers/products.md +++ b/doc/controllers/products.md @@ -43,7 +43,7 @@ async createProduct( ## 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 [ProductResponse](../../doc/models/product-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 [`ProductResponse`](../../doc/models/product-response.md). ## Example Usage @@ -67,9 +67,9 @@ const body: CreateOrUpdateProductRequest = { try { const { result, ...httpResponse } = await productsController.createProduct( - productFamilyId, - body -); + productFamilyId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -156,7 +156,7 @@ async readProduct( ## 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 [ProductResponse](../../doc/models/product-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 [`ProductResponse`](../../doc/models/product-response.md). ## Example Usage @@ -249,7 +249,7 @@ async updateProduct( ## 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 [ProductResponse](../../doc/models/product-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 [`ProductResponse`](../../doc/models/product-response.md). ## Example Usage @@ -345,7 +345,7 @@ async archiveProduct( ## 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 [ProductResponse](../../doc/models/product-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 [`ProductResponse`](../../doc/models/product-response.md). ## Example Usage @@ -434,7 +434,7 @@ async readProductByHandle( ## 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 [ProductResponse](../../doc/models/product-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 [`ProductResponse`](../../doc/models/product-response.md). ## Example Usage @@ -528,16 +528,29 @@ This method allows to retrieve a list of Products belonging to a Site. ```ts async listProducts( - dateField?: BasicDateField, - filter?: ListProductsFilter, - endDate?: string, - endDatetime?: string, - startDate?: string, - startDatetime?: string, - page?: number, - perPage?: number, - includeArchived?: boolean, - include?: ListProductsInclude, + { + dateField, + filter, + endDate, + endDatetime, + startDate, + startDatetime, + page, + perPage, + includeArchived, + include, + }: { + dateField?: BasicDateField; + filter?: ListProductsFilter; + endDate?: string; + endDatetime?: string; + startDate?: string; + startDatetime?: string; + page?: number; + perPage?: number; + includeArchived?: boolean; + include?: ListProductsInclude; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -560,7 +573,7 @@ async listProducts( ## 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 [ProductResponse[]](../../doc/models/product-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 [`ProductResponse[]`](../../doc/models/product-response.md). ## Example Usage diff --git a/doc/controllers/proforma-invoices.md b/doc/controllers/proforma-invoices.md index cd2b635d..2ac72287 100644 --- a/doc/controllers/proforma-invoices.md +++ b/doc/controllers/proforma-invoices.md @@ -81,13 +81,23 @@ By default, proforma invoices returned on the index will only include totals, no ```ts async listSubscriptionGroupProformaInvoices( - uid: string, - lineItems?: boolean, - discounts?: boolean, - taxes?: boolean, - credits?: boolean, - payments?: boolean, - customFields?: boolean, + { + uid, + lineItems, + discounts, + taxes, + credits, + payments, + customFields, + }: { + uid: string; + lineItems?: boolean; + discounts?: boolean; + taxes?: boolean; + credits?: boolean; + payments?: boolean; + customFields?: boolean; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -107,7 +117,7 @@ async listSubscriptionGroupProformaInvoices( ## 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 [ListProformaInvoicesResponse](../../doc/models/list-proforma-invoices-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 [`ListProformaInvoicesResponse`](../../doc/models/list-proforma-invoices-response.md). ## Example Usage @@ -165,7 +175,7 @@ async readProformaInvoice( ## 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 @@ -217,7 +227,7 @@ async createProformaInvoice( ## 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 @@ -249,19 +259,35 @@ By default, proforma invoices returned on the index will only include totals, no ```ts async listProformaInvoices( - subscriptionId: number, - startDate?: string, - endDate?: string, - status?: ProformaInvoiceStatus, - page?: number, - perPage?: number, - direction?: Direction, - lineItems?: boolean, - discounts?: boolean, - taxes?: boolean, - credits?: boolean, - payments?: boolean, - customFields?: boolean, + { + subscriptionId, + startDate, + endDate, + status, + page, + perPage, + direction, + lineItems, + discounts, + taxes, + credits, + payments, + customFields, + }: { + subscriptionId: number; + startDate?: string; + endDate?: string; + status?: ProformaInvoiceStatus; + page?: number; + perPage?: number; + direction?: Direction; + lineItems?: boolean; + discounts?: boolean; + taxes?: boolean; + credits?: boolean; + payments?: boolean; + customFields?: boolean; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -287,7 +313,7 @@ async listProformaInvoices( ## 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 [ListProformaInvoicesResponse](../../doc/models/list-proforma-invoices-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 [`ListProformaInvoicesResponse`](../../doc/models/list-proforma-invoices-response.md). ## Example Usage @@ -348,7 +374,7 @@ async voidProformaInvoice( ## 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 @@ -401,7 +427,7 @@ async previewProformaInvoice( ## 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 @@ -454,7 +480,7 @@ async createSignupProformaInvoice( ## 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 @@ -518,7 +544,7 @@ async previewSignupProformaInvoice( ## 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 [SignupProformaPreviewResponse](../../doc/models/signup-proforma-preview-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 [`SignupProformaPreviewResponse`](../../doc/models/signup-proforma-preview-response.md). ## Example Usage @@ -536,9 +562,9 @@ const body: CreateSubscriptionRequest = { try { const { result, ...httpResponse } = await proformaInvoicesController.previewSignupProformaInvoice( - undefined, - body -); + undefined, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/reason-codes.md b/doc/controllers/reason-codes.md index b7bc8677..4eafbc4a 100644 --- a/doc/controllers/reason-codes.md +++ b/doc/controllers/reason-codes.md @@ -51,7 +51,7 @@ async createReasonCode( ## 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 [ReasonCodeResponse](../../doc/models/reason-code-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 [`ReasonCodeResponse`](../../doc/models/reason-code-response.md). ## Example Usage @@ -89,8 +89,13 @@ This method gives a merchant the option to retrieve a list of all of the current ```ts async listReasonCodes( - page?: number, - perPage?: number, + { + page, + perPage, + }: { + page?: number; + perPage?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -105,7 +110,7 @@ async listReasonCodes( ## 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 [ReasonCodeResponse[]](../../doc/models/reason-code-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 [`ReasonCodeResponse[]`](../../doc/models/reason-code-response.md). ## Example Usage @@ -194,7 +199,7 @@ async readReasonCode( ## 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 [ReasonCodeResponse](../../doc/models/reason-code-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 [`ReasonCodeResponse`](../../doc/models/reason-code-response.md). ## Example Usage @@ -242,7 +247,7 @@ async updateReasonCode( ## 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 [ReasonCodeResponse](../../doc/models/reason-code-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 [`ReasonCodeResponse`](../../doc/models/reason-code-response.md). ## Example Usage @@ -289,7 +294,7 @@ async deleteReasonCode( ## 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 [OkResponse](../../doc/models/ok-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 [`OkResponse`](../../doc/models/ok-response.md). ## Example Usage diff --git a/doc/controllers/referral-codes.md b/doc/controllers/referral-codes.md index f50a8f55..b7a00ac1 100644 --- a/doc/controllers/referral-codes.md +++ b/doc/controllers/referral-codes.md @@ -37,7 +37,7 @@ async validateReferralCode( ## 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 [ReferralValidationResponse](../../doc/models/referral-validation-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 [`ReferralValidationResponse`](../../doc/models/referral-validation-response.md). ## Example Usage diff --git a/doc/controllers/sales-commissions.md b/doc/controllers/sales-commissions.md index 3a961558..1dae68d6 100644 --- a/doc/controllers/sales-commissions.md +++ b/doc/controllers/sales-commissions.md @@ -29,11 +29,19 @@ Access to the Sales Commission API endpoints is available to users with financia ```ts async listSalesCommissionSettings( - sellerId: string, - authorization?: string, - liveMode?: boolean, - page?: number, - perPage?: number, + { + sellerId, + authorization, + liveMode, + page, + perPage, + }: { + sellerId: string; + authorization?: string; + liveMode?: boolean; + page?: number; + perPage?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -51,7 +59,7 @@ async listSalesCommissionSettings( ## 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 [SaleRepSettings[]](../../doc/models/sale-rep-settings.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 [`SaleRepSettings[]`](../../doc/models/sale-rep-settings.md). ## Example Usage @@ -124,11 +132,19 @@ Access to the Sales Commission API endpoints is available to users with financia ```ts async listSalesReps( - sellerId: string, - authorization?: string, - liveMode?: boolean, - page?: number, - perPage?: number, + { + sellerId, + authorization, + liveMode, + page, + perPage, + }: { + sellerId: string; + authorization?: string; + liveMode?: boolean; + page?: number; + perPage?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -146,7 +162,7 @@ async listSalesReps( ## 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 [ListSaleRepItem[]](../../doc/models/list-sale-rep-item.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 [`ListSaleRepItem[]`](../../doc/models/list-sale-rep-item.md). ## Example Usage @@ -292,7 +308,7 @@ async readSalesRep( ## 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 [SaleRep](../../doc/models/sale-rep.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 [`SaleRep`](../../doc/models/sale-rep.md). ## Example Usage @@ -309,13 +325,13 @@ const perPage = 100; try { const { result, ...httpResponse } = await salesCommissionsController.readSalesRep( - sellerId, - salesRepId, - authorization, - undefined, - page, - perPage -); + sellerId, + salesRepId, + authorization, + undefined, + page, + perPage + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/sites.md b/doc/controllers/sites.md index 0d33740c..58b09086 100644 --- a/doc/controllers/sites.md +++ b/doc/controllers/sites.md @@ -48,7 +48,7 @@ async readSite( ## 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 [SiteResponse](../../doc/models/site-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 [`SiteResponse`](../../doc/models/site-response.md). ## Example Usage @@ -165,8 +165,13 @@ This endpoint returns public keys used for Chargify.js. ```ts async listChargifyJsPublicKeys( - page?: number, - perPage?: number, + { + page, + perPage, + }: { + page?: number; + perPage?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -181,7 +186,7 @@ async listChargifyJsPublicKeys( ## 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 [ListPublicKeysResponse](../../doc/models/list-public-keys-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 [`ListPublicKeysResponse`](../../doc/models/list-public-keys-response.md). ## Example Usage diff --git a/doc/controllers/subscription-components.md b/doc/controllers/subscription-components.md index 67031450..764f03fe 100644 --- a/doc/controllers/subscription-components.md +++ b/doc/controllers/subscription-components.md @@ -51,7 +51,7 @@ async readSubscriptionComponent( ## 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 [SubscriptionComponentResponse](../../doc/models/subscription-component-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 [`SubscriptionComponentResponse`](../../doc/models/subscription-component-response.md). ## Example Usage @@ -62,9 +62,9 @@ const componentId = 222; try { const { result, ...httpResponse } = await subscriptionComponentsController.readSubscriptionComponent( - subscriptionId, - componentId -); + subscriptionId, + componentId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -111,19 +111,35 @@ When requesting to list components for a given subscription, if the subscription ```ts async listSubscriptionComponents( - subscriptionId: number, - dateField?: SubscriptionListDateField, - direction?: SortingDirection, - filter?: ListSubscriptionComponentsFilter, - endDate?: string, - endDatetime?: string, - pricePointIds?: IncludeNotNull, - productFamilyIds?: number[], - sort?: ListSubscriptionComponentsSort, - startDate?: string, - startDatetime?: string, - include?: ListSubscriptionComponentsInclude[], - inUse?: boolean, + { + subscriptionId, + dateField, + direction, + filter, + endDate, + endDatetime, + pricePointIds, + productFamilyIds, + sort, + startDate, + startDatetime, + include, + inUse, + }: { + subscriptionId: number; + dateField?: SubscriptionListDateField; + direction?: SortingDirection; + filter?: ListSubscriptionComponentsFilter; + endDate?: string; + endDatetime?: string; + pricePointIds?: IncludeNotNull; + productFamilyIds?: number[]; + sort?: ListSubscriptionComponentsSort; + startDate?: string; + startDatetime?: string; + include?: ListSubscriptionComponentsInclude[]; + inUse?: boolean; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -149,7 +165,7 @@ async listSubscriptionComponents( ## 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 [SubscriptionComponentResponse[]](../../doc/models/subscription-component-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 [`SubscriptionComponentResponse[]`](../../doc/models/subscription-component-response.md). ## Example Usage @@ -247,7 +263,7 @@ async bulkUpdateSubscriptionComponentsPricePoints( ## 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 [BulkComponentsPricePointAssignment](../../doc/models/bulk-components-price-point-assignment.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 [`BulkComponentsPricePointAssignment`](../../doc/models/bulk-components-price-point-assignment.md). ## Example Usage @@ -273,9 +289,9 @@ const body: BulkComponentsPricePointAssignment = { try { const { result, ...httpResponse } = await subscriptionComponentsController.bulkUpdateSubscriptionComponentsPricePoints( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -332,7 +348,7 @@ async bulkResetSubscriptionComponentsPricePoints( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -524,7 +540,7 @@ async allocateComponent( ## 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 [AllocationResponse](../../doc/models/allocation-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 [`AllocationResponse`](../../doc/models/allocation-response.md). ## Example Usage @@ -542,10 +558,10 @@ const body: CreateAllocationRequest = { try { const { result, ...httpResponse } = await subscriptionComponentsController.allocateComponent( - subscriptionId, - componentId, - body -); + subscriptionId, + componentId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -634,7 +650,7 @@ async listAllocations( ## 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 [AllocationResponse[]](../../doc/models/allocation-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 [`AllocationResponse[]`](../../doc/models/allocation-response.md). ## Example Usage @@ -647,10 +663,10 @@ const page = 2; try { const { result, ...httpResponse } = await subscriptionComponentsController.listAllocations( - subscriptionId, - componentId, - page -); + subscriptionId, + componentId, + page + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -740,7 +756,7 @@ async allocateComponents( ## 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 [AllocationResponse[]](../../doc/models/allocation-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 [`AllocationResponse[]`](../../doc/models/allocation-response.md). ## Example Usage @@ -766,9 +782,9 @@ const body: AllocateComponents = { try { const { result, ...httpResponse } = await subscriptionComponentsController.allocateComponents( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -858,7 +874,7 @@ async previewAllocations( ## 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 [AllocationPreviewResponse](../../doc/models/allocation-preview-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 [`AllocationPreviewResponse`](../../doc/models/allocation-preview-response.md). ## Example Usage @@ -881,9 +897,9 @@ const body: PreviewAllocationsRequest = { try { const { result, ...httpResponse } = await subscriptionComponentsController.previewAllocations( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1059,11 +1075,11 @@ const body: UpdateAllocationExpirationDate = { try { const { result, ...httpResponse } = await subscriptionComponentsController.updatePrepaidUsageAllocationExpirationDate( - subscriptionId, - componentId, - allocationId, - body -); + subscriptionId, + componentId, + allocationId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1133,11 +1149,11 @@ const body: CreditSchemeRequest = { try { const { result, ...httpResponse } = await subscriptionComponentsController.deletePrepaidUsageAllocation( - subscriptionId, - componentId, - allocationId, - body -); + subscriptionId, + componentId, + allocationId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1235,7 +1251,7 @@ async createUsage( ## 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 [UsageResponse](../../doc/models/usage-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 [`UsageResponse`](../../doc/models/usage-response.md). ## Example Usage @@ -1254,10 +1270,10 @@ const body: CreateUsageRequest = { try { const { result, ...httpResponse } = await subscriptionComponentsController.createUsage( - subscriptionId, - componentId, - body -); + subscriptionId, + componentId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1312,14 +1328,25 @@ Use this endpoint to read the previously recorded components for a subscription. ```ts async listUsages( - subscriptionId: number, - componentId: ListUsagesInputComponentId, - sinceId?: bigint, - maxId?: bigint, - sinceDate?: string, - untilDate?: string, - page?: number, - perPage?: number, + { + subscriptionId, + componentId, + sinceId, + maxId, + sinceDate, + untilDate, + page, + perPage, + }: { + subscriptionId: number; + componentId: ListUsagesInputComponentId; + sinceId?: bigint; + maxId?: bigint; + sinceDate?: string; + untilDate?: string; + page?: number; + perPage?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -1340,7 +1367,7 @@ async listUsages( ## 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 [UsageResponse[]](../../doc/models/usage-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 [`UsageResponse[]`](../../doc/models/usage-response.md). ## Example Usage @@ -1456,10 +1483,10 @@ const body: ActivateEventBasedComponent = { try { const { result, ...httpResponse } = await subscriptionComponentsController.activateEventBasedComponent( - subscriptionId, - componentId, - body -); + subscriptionId, + componentId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1504,9 +1531,9 @@ const componentId = 222; try { const { result, ...httpResponse } = await subscriptionComponentsController.deactivateEventBasedComponent( - subscriptionId, - componentId -); + subscriptionId, + componentId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1576,10 +1603,10 @@ const body: EBBEvent = { try { const { result, ...httpResponse } = await subscriptionComponentsController.recordEvent( - apiHandle, - undefined, - body -); + apiHandle, + undefined, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1637,10 +1664,10 @@ const body: EBBEvent[] = [ try { const { result, ...httpResponse } = await subscriptionComponentsController.bulkRecordEvents( - apiHandle, - undefined, - body -); + apiHandle, + undefined, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1658,20 +1685,37 @@ This request will list components applied to each subscription. ```ts async listSubscriptionComponentsForSite( - page?: number, - perPage?: number, - sort?: ListSubscriptionComponentsSort, - direction?: SortingDirection, - filter?: ListSubscriptionComponentsForSiteFilter, - dateField?: SubscriptionListDateField, - startDate?: string, - startDatetime?: string, - endDate?: string, - endDatetime?: string, - subscriptionIds?: number[], - pricePointIds?: IncludeNotNull, - productFamilyIds?: number[], - include?: ListSubscriptionComponentsInclude, + { + page, + perPage, + sort, + direction, + filter, + dateField, + startDate, + startDatetime, + endDate, + endDatetime, + subscriptionIds, + pricePointIds, + productFamilyIds, + include, + }: { + page?: number; + perPage?: number; + sort?: ListSubscriptionComponentsSort; + direction?: SortingDirection; + filter?: ListSubscriptionComponentsForSiteFilter; + dateField?: SubscriptionListDateField; + startDate?: string; + startDatetime?: string; + endDate?: string; + endDatetime?: string; + subscriptionIds?: number[]; + pricePointIds?: IncludeNotNull; + productFamilyIds?: number[]; + include?: ListSubscriptionComponentsInclude; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -1698,7 +1742,7 @@ async listSubscriptionComponentsForSite( ## 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 [ListSubscriptionComponentsResponse](../../doc/models/list-subscription-components-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 [`ListSubscriptionComponentsResponse`](../../doc/models/list-subscription-components-response.md). ## Example Usage diff --git a/doc/controllers/subscription-group-invoice-account.md b/doc/controllers/subscription-group-invoice-account.md index 1577a84c..10080d9e 100644 --- a/doc/controllers/subscription-group-invoice-account.md +++ b/doc/controllers/subscription-group-invoice-account.md @@ -38,7 +38,7 @@ async createSubscriptionGroupPrepayment( ## 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 [SubscriptionGroupPrepaymentResponse](../../doc/models/subscription-group-prepayment-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 [`SubscriptionGroupPrepaymentResponse`](../../doc/models/subscription-group-prepayment-response.md). ## Example Usage @@ -82,10 +82,17 @@ This request will list a subscription group's prepayments. ```ts async listPrepaymentsForSubscriptionGroup( - uid: string, - page?: number, - perPage?: number, - filter?: ListPrepaymentsFilter, + { + uid, + page, + perPage, + filter, + }: { + uid: string; + page?: number; + perPage?: number; + filter?: ListPrepaymentsFilter; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -102,7 +109,7 @@ async listPrepaymentsForSubscriptionGroup( ## 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 [ListSubscriptionGroupPrepaymentResponse](../../doc/models/list-subscription-group-prepayment-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 [`ListSubscriptionGroupPrepaymentResponse`](../../doc/models/list-subscription-group-prepayment-response.md). ## Example Usage @@ -181,7 +188,7 @@ async issueSubscriptionGroupServiceCredit( ## 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 [ServiceCreditResponse](../../doc/models/service-credit-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 [`ServiceCreditResponse`](../../doc/models/service-credit-response.md). ## Example Usage @@ -197,9 +204,9 @@ const body: IssueServiceCreditRequest = { try { const { result, ...httpResponse } = await subscriptionGroupInvoiceAccountController.issueSubscriptionGroupServiceCredit( - uid, - body -); + uid, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -253,7 +260,7 @@ async deductSubscriptionGroupServiceCredit( ## 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 [ServiceCredit](../../doc/models/service-credit.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 [`ServiceCredit`](../../doc/models/service-credit.md). ## Example Usage @@ -269,9 +276,9 @@ const body: DeductServiceCreditRequest = { try { const { result, ...httpResponse } = await subscriptionGroupInvoiceAccountController.deductSubscriptionGroupServiceCredit( - uid, - body -); + uid, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/subscription-group-status.md b/doc/controllers/subscription-group-status.md index 246f6040..bc6f5aea 100644 --- a/doc/controllers/subscription-group-status.md +++ b/doc/controllers/subscription-group-status.md @@ -53,9 +53,9 @@ const body: CancelGroupedSubscriptionsRequest = { try { const { result, ...httpResponse } = await subscriptionGroupStatusController.cancelSubscriptionsInGroup( - uid, - body -); + uid, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -207,7 +207,7 @@ async reactivateSubscriptionGroup( ## 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 [ReactivateSubscriptionGroupResponse](../../doc/models/reactivate-subscription-group-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 [`ReactivateSubscriptionGroupResponse`](../../doc/models/reactivate-subscription-group-response.md). ## Example Usage @@ -220,9 +220,9 @@ const body: ReactivateSubscriptionGroupRequest = { try { const { result, ...httpResponse } = await subscriptionGroupStatusController.reactivateSubscriptionGroup( - uid, - body -); + uid, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/subscription-groups.md b/doc/controllers/subscription-groups.md index 3e4c8d84..5af3c263 100644 --- a/doc/controllers/subscription-groups.md +++ b/doc/controllers/subscription-groups.md @@ -49,7 +49,7 @@ async signupWithSubscriptionGroup( ## 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 [SubscriptionGroupSignupResponse](../../doc/models/subscription-group-signup-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 [`SubscriptionGroupSignupResponse`](../../doc/models/subscription-group-signup-response.md). ## Example Usage @@ -112,7 +112,7 @@ async createSubscriptionGroup( ## 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 [SubscriptionGroupResponse](../../doc/models/subscription-group-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 [`SubscriptionGroupResponse`](../../doc/models/subscription-group-response.md). ## Example Usage @@ -179,9 +179,15 @@ Account balance information for the subscription groups is not returned by defau ```ts async listSubscriptionGroups( - page?: number, - perPage?: number, - include?: SubscriptionGroupsListInclude[], + { + page, + perPage, + include, + }: { + page?: number; + perPage?: number; + include?: SubscriptionGroupsListInclude[]; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -197,7 +203,7 @@ async listSubscriptionGroups( ## 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 [ListSubscriptionGroupsResponse](../../doc/models/list-subscription-groups-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 [`ListSubscriptionGroupsResponse`](../../doc/models/list-subscription-groups-response.md). ## Example Usage @@ -287,7 +293,7 @@ async readSubscriptionGroup( ## 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 [FullSubscriptionGroupResponse](../../doc/models/full-subscription-group-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 [`FullSubscriptionGroupResponse`](../../doc/models/full-subscription-group-response.md). ## Example Usage @@ -300,9 +306,9 @@ const include: SubscriptionGroupInclude[] = [ try { const { result, ...httpResponse } = await subscriptionGroupsController.readSubscriptionGroup( - uid, - include -); + uid, + include + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -379,7 +385,7 @@ async updateSubscriptionGroupMembers( ## 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 [SubscriptionGroupResponse](../../doc/models/subscription-group-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 [`SubscriptionGroupResponse`](../../doc/models/subscription-group-response.md). ## Example Usage @@ -398,9 +404,9 @@ const body: UpdateSubscriptionGroupRequest = { try { const { result, ...httpResponse } = await subscriptionGroupsController.updateSubscriptionGroupMembers( - uid, - body -); + uid, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -460,7 +466,7 @@ async deleteSubscriptionGroup( ## 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 [DeleteSubscriptionGroupResponse](../../doc/models/delete-subscription-group-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 [`DeleteSubscriptionGroupResponse`](../../doc/models/delete-subscription-group-response.md). ## Example Usage @@ -517,7 +523,7 @@ async findSubscriptionGroup( ## 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 [FullSubscriptionGroupResponse](../../doc/models/full-subscription-group-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 [`FullSubscriptionGroupResponse`](../../doc/models/full-subscription-group-response.md). ## Example Usage @@ -619,7 +625,7 @@ async addSubscriptionToGroup( ## 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 [SubscriptionGroupResponse](../../doc/models/subscription-group-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 [`SubscriptionGroupResponse`](../../doc/models/subscription-group-response.md). ## Example Usage @@ -642,9 +648,9 @@ const body: AddSubscriptionToAGroup = { try { const { result, ...httpResponse } = await subscriptionGroupsController.addSubscriptionToGroup( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/subscription-invoice-account.md b/doc/controllers/subscription-invoice-account.md index 4792e3e1..dbab9986 100644 --- a/doc/controllers/subscription-invoice-account.md +++ b/doc/controllers/subscription-invoice-account.md @@ -39,7 +39,7 @@ async readAccountBalances( ## 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 [AccountBalances](../../doc/models/account-balances.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 [`AccountBalances`](../../doc/models/account-balances.md). ## Example Usage @@ -87,7 +87,7 @@ async createPrepayment( ## 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 [CreatePrepaymentResponse](../../doc/models/create-prepayment-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 [`CreatePrepaymentResponse`](../../doc/models/create-prepayment-response.md). ## Example Usage @@ -105,9 +105,9 @@ const body: CreatePrepaymentRequest = { try { const { result, ...httpResponse } = await subscriptionInvoiceAccountController.createPrepayment( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -147,10 +147,17 @@ This request will list a subscription's prepayments. ```ts async listPrepayments( - subscriptionId: number, - page?: number, - perPage?: number, - filter?: ListPrepaymentsFilter, + { + subscriptionId, + page, + perPage, + filter, + }: { + subscriptionId: number; + page?: number; + perPage?: number; + filter?: ListPrepaymentsFilter; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -167,7 +174,7 @@ async listPrepayments( ## 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 [PrepaymentsResponse](../../doc/models/prepayments-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 [`PrepaymentsResponse`](../../doc/models/prepayments-response.md). ## Example Usage @@ -245,7 +252,7 @@ async issueServiceCredit( ## 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 [ServiceCredit](../../doc/models/service-credit.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 [`ServiceCredit`](../../doc/models/service-credit.md). ## Example Usage @@ -260,9 +267,9 @@ const body: IssueServiceCreditRequest = { try { const { result, ...httpResponse } = await subscriptionInvoiceAccountController.issueServiceCredit( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -330,9 +337,9 @@ const body: DeductServiceCreditRequest = { try { const { result, ...httpResponse } = await subscriptionInvoiceAccountController.deductServiceCredit( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -376,7 +383,7 @@ async listServiceCredits( ## 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 [ListServiceCreditsResponse](../../doc/models/list-service-credits-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 [`ListServiceCreditsResponse`](../../doc/models/list-service-credits-response.md). ## Example Usage @@ -389,10 +396,10 @@ const perPage = 50; try { const { result, ...httpResponse } = await subscriptionInvoiceAccountController.listServiceCredits( - subscriptionId, - page, - perPage -); + subscriptionId, + page, + perPage + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -466,7 +473,7 @@ async refundPrepayment( ## 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 [PrepaymentResponse](../../doc/models/prepayment-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 [`PrepaymentResponse`](../../doc/models/prepayment-response.md). ## Example Usage @@ -477,9 +484,9 @@ const prepaymentId = BigInt(228); try { const { result, ...httpResponse } = await subscriptionInvoiceAccountController.refundPrepayment( - subscriptionId, - prepaymentId -); + subscriptionId, + prepaymentId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/subscription-notes.md b/doc/controllers/subscription-notes.md index 93ae3a64..10571d9a 100644 --- a/doc/controllers/subscription-notes.md +++ b/doc/controllers/subscription-notes.md @@ -47,7 +47,7 @@ async createSubscriptionNote( ## 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 [SubscriptionNoteResponse](../../doc/models/subscription-note-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 [`SubscriptionNoteResponse`](../../doc/models/subscription-note-response.md). ## Example Usage @@ -63,9 +63,9 @@ const body: UpdateSubscriptionNoteRequest = { try { const { result, ...httpResponse } = await subscriptionNotesController.createSubscriptionNote( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -89,9 +89,15 @@ Use this method to retrieve a list of Notes associated with a Subscription. The ```ts async listSubscriptionNotes( - subscriptionId: number, - page?: number, - perPage?: number, + { + subscriptionId, + page, + perPage, + }: { + subscriptionId: number; + page?: number; + perPage?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -107,7 +113,7 @@ async listSubscriptionNotes( ## 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 [SubscriptionNoteResponse[]](../../doc/models/subscription-note-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 [`SubscriptionNoteResponse[]`](../../doc/models/subscription-note-response.md). ## Example Usage @@ -186,7 +192,7 @@ async readSubscriptionNote( ## 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 [SubscriptionNoteResponse](../../doc/models/subscription-note-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 [`SubscriptionNoteResponse`](../../doc/models/subscription-note-response.md). ## Example Usage @@ -197,9 +203,9 @@ const noteId = 66; try { const { result, ...httpResponse } = await subscriptionNotesController.readSubscriptionNote( - subscriptionId, - noteId -); + subscriptionId, + noteId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -250,7 +256,7 @@ async updateSubscriptionNote( ## 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 [SubscriptionNoteResponse](../../doc/models/subscription-note-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 [`SubscriptionNoteResponse`](../../doc/models/subscription-note-response.md). ## Example Usage @@ -268,10 +274,10 @@ const body: UpdateSubscriptionNoteRequest = { try { const { result, ...httpResponse } = await subscriptionNotesController.updateSubscriptionNote( - subscriptionId, - noteId, - body -); + subscriptionId, + noteId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -322,9 +328,9 @@ const noteId = 66; try { const { result, ...httpResponse } = await subscriptionNotesController.deleteSubscriptionNote( - subscriptionId, - noteId -); + subscriptionId, + noteId + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/subscription-products.md b/doc/controllers/subscription-products.md index 9a20fbee..c44fa822 100644 --- a/doc/controllers/subscription-products.md +++ b/doc/controllers/subscription-products.md @@ -91,7 +91,7 @@ async migrateSubscriptionProduct( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -110,9 +110,9 @@ const body: SubscriptionProductMigrationRequest = { try { const { result, ...httpResponse } = await subscriptionProductsController.migrateSubscriptionProduct( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -280,7 +280,7 @@ async previewSubscriptionProductMigration( ## 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 [SubscriptionMigrationPreviewResponse](../../doc/models/subscription-migration-preview-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 [`SubscriptionMigrationPreviewResponse`](../../doc/models/subscription-migration-preview-response.md). ## Example Usage @@ -298,9 +298,9 @@ const body: SubscriptionMigrationPreviewRequest = { try { const { result, ...httpResponse } = await subscriptionProductsController.previewSubscriptionProductMigration( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/subscription-status.md b/doc/controllers/subscription-status.md index 2d0067f3..145caf16 100644 --- a/doc/controllers/subscription-status.md +++ b/doc/controllers/subscription-status.md @@ -50,7 +50,7 @@ async retrySubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -234,7 +234,7 @@ async cancelSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -419,7 +419,7 @@ async resumeSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -427,7 +427,7 @@ This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The const subscriptionId = 222; Liquid error: Value cannot be null. (Parameter 'key')try { - const { result, ...httpResponse } = Liquid error: Value cannot be null. (Parameter 'key')await subscriptionStatusController.resumeSubscription(subscriptionId); + const { result, ...httpResponse } = await subscriptionStatusController.resumeSubscription(Liquid error: Value cannot be null. (Parameter 'key')subscriptionId); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -580,7 +580,7 @@ async pauseSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -595,9 +595,9 @@ const body: PauseRequest = { try { const { result, ...httpResponse } = await subscriptionStatusController.pauseSubscription( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -752,7 +752,7 @@ async updateAutomaticSubscriptionResumption( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -767,9 +767,9 @@ const body: PauseRequest = { try { const { result, ...httpResponse } = await subscriptionStatusController.updateAutomaticSubscriptionResumption( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1087,7 +1087,7 @@ async reactivateSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -1107,9 +1107,9 @@ const body: ReactivateSubscriptionRequest = { try { const { result, ...httpResponse } = await subscriptionStatusController.reactivateSubscription( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1263,7 +1263,7 @@ async initiateDelayedCancellation( ## 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 [DelayedCancellationResponse](../../doc/models/delayed-cancellation-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 [`DelayedCancellationResponse`](../../doc/models/delayed-cancellation-response.md). ## Example Usage @@ -1312,7 +1312,7 @@ async cancelDelayedCancellation( ## 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 [DelayedCancellationResponse](../../doc/models/delayed-cancellation-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 [`DelayedCancellationResponse`](../../doc/models/delayed-cancellation-response.md). ## Example Usage @@ -1366,7 +1366,7 @@ async cancelDunning( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -1435,7 +1435,7 @@ async previewRenewal( ## 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 [RenewalPreviewResponse](../../doc/models/renewal-preview-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 [`RenewalPreviewResponse`](../../doc/models/renewal-preview-response.md). ## Example Usage @@ -1463,9 +1463,9 @@ const body: RenewalPreviewRequest = { try { const { result, ...httpResponse } = await subscriptionStatusController.previewRenewal( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/controllers/subscriptions.md b/doc/controllers/subscriptions.md index dcd9e1d5..20df9378 100644 --- a/doc/controllers/subscriptions.md +++ b/doc/controllers/subscriptions.md @@ -661,7 +661,7 @@ async createSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -859,22 +859,41 @@ Self-Service Page token for the subscriptions is not returned by default. If thi ```ts async listSubscriptions( - page?: number, - perPage?: number, - state?: SubscriptionStateFilter, - product?: number, - productPricePointId?: number, - coupon?: number, - couponCode?: string, - dateField?: SubscriptionDateField, - startDate?: string, - endDate?: string, - startDatetime?: string, - endDatetime?: string, - metadata?: Record, - direction?: SortingDirection, - sort?: SubscriptionSort, - include?: SubscriptionListInclude[], + { + page, + perPage, + state, + product, + productPricePointId, + coupon, + couponCode, + dateField, + startDate, + endDate, + startDatetime, + endDatetime, + metadata, + direction, + sort, + include, + }: { + page?: number; + perPage?: number; + state?: SubscriptionStateFilter; + product?: number; + productPricePointId?: number; + coupon?: number; + couponCode?: string; + dateField?: SubscriptionDateField; + startDate?: string; + endDate?: string; + startDatetime?: string; + endDatetime?: string; + metadata?: Record; + direction?: SortingDirection; + sort?: SubscriptionSort; + include?: SubscriptionListInclude[]; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -903,7 +922,7 @@ async listSubscriptions( ## 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 [SubscriptionResponse[]](../../doc/models/subscription-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 [`SubscriptionResponse[]`](../../doc/models/subscription-response.md). ## Example Usage @@ -996,7 +1015,7 @@ async updateSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -1012,9 +1031,9 @@ const body: UpdateSubscriptionRequest = { try { const { result, ...httpResponse } = await subscriptionsController.updateSubscription( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1168,7 +1187,7 @@ async readSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -1182,9 +1201,9 @@ const include: SubscriptionInclude[] = [ try { const { result, ...httpResponse } = await subscriptionsController.readSubscription( - subscriptionId, - include -); + subscriptionId, + include + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1393,9 +1412,9 @@ const body: OverrideSubscriptionRequest = { try { const { result, ...httpResponse } = await subscriptionsController.overrideSubscription( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1433,7 +1452,7 @@ async findSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -1489,7 +1508,7 @@ async purgeSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -1505,10 +1524,10 @@ const cascade: SubscriptionPurgeType[] = [ try { const { result, ...httpResponse } = await subscriptionsController.purgeSubscription( - subscriptionId, - ack, - cascade -); + subscriptionId, + ack, + cascade + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1548,7 +1567,7 @@ async updatePrepaidSubscriptionConfiguration( ## 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 [PrepaidConfigurationResponse](../../doc/models/prepaid-configuration-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 [`PrepaidConfigurationResponse`](../../doc/models/prepaid-configuration-response.md). ## Example Usage @@ -1566,9 +1585,9 @@ const body: UpsertPrepaidConfigurationRequest = { try { const { result, ...httpResponse } = await subscriptionsController.updatePrepaidSubscriptionConfiguration( - subscriptionId, - body -); + subscriptionId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -1644,7 +1663,7 @@ async previewSubscription( ## 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 [SubscriptionPreviewResponse](../../doc/models/subscription-preview-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 [`SubscriptionPreviewResponse`](../../doc/models/subscription-preview-response.md). ## Example Usage @@ -1818,7 +1837,7 @@ async applyCouponsToSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage @@ -1834,10 +1853,10 @@ const body: AddCouponsRequest = { try { const { result, ...httpResponse } = await subscriptionsController.applyCouponsToSubscription( - subscriptionId, - undefined, - body -); + subscriptionId, + undefined, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { @@ -2029,7 +2048,7 @@ async removeCouponFromSubscription( ## 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 string. +This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type `string`. ## Example Usage @@ -2125,7 +2144,7 @@ async activateSubscription( ## 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 [SubscriptionResponse](../../doc/models/subscription-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 [`SubscriptionResponse`](../../doc/models/subscription-response.md). ## Example Usage diff --git a/doc/controllers/webhooks.md b/doc/controllers/webhooks.md index 77b46b5b..dcc32c37 100644 --- a/doc/controllers/webhooks.md +++ b/doc/controllers/webhooks.md @@ -37,13 +37,23 @@ This method allows you to fetch data about webhooks. You can pass query paramete ```ts async listWebhooks( - status?: WebhookStatus, - sinceDate?: string, - untilDate?: string, - page?: number, - perPage?: number, - order?: WebhookOrder, - subscription?: number, + { + status, + sinceDate, + untilDate, + page, + perPage, + order, + subscription, + }: { + status?: WebhookStatus; + sinceDate?: string; + untilDate?: string; + page?: number; + perPage?: number; + order?: WebhookOrder; + subscription?: number; + }, requestOptions?: RequestOptions ): Promise> ``` @@ -63,7 +73,7 @@ async listWebhooks( ## 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 [WebhookResponse[]](../../doc/models/webhook-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 [`WebhookResponse[]`](../../doc/models/webhook-response.md). ## Example Usage @@ -145,7 +155,7 @@ async enableWebhooks( ## 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 [EnableWebhooksResponse](../../doc/models/enable-webhooks-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 [`EnableWebhooksResponse`](../../doc/models/enable-webhooks-response.md). ## Example Usage @@ -197,7 +207,7 @@ async replayWebhooks( ## 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 [ReplayWebhooksResponse](../../doc/models/replay-webhooks-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 [`ReplayWebhooksResponse`](../../doc/models/replay-webhooks-response.md). ## Example Usage @@ -253,7 +263,7 @@ async createEndpoint( ## 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 [EndpointResponse](../../doc/models/endpoint-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 [`EndpointResponse`](../../doc/models/endpoint-response.md). ## Example Usage @@ -322,7 +332,7 @@ async listEndpoints( ## 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 [Endpoint[]](../../doc/models/endpoint.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 [`Endpoint[]`](../../doc/models/endpoint.md). ## Example Usage @@ -398,7 +408,7 @@ async updateEndpoint( ## 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 [EndpointResponse](../../doc/models/endpoint-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 [`EndpointResponse`](../../doc/models/endpoint-response.md). ## Example Usage @@ -418,9 +428,9 @@ const body: CreateOrUpdateEndpointRequest = { try { const { result, ...httpResponse } = await webhooksController.updateEndpoint( - endpointId, - body -); + endpointId, + body + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/e2e/src/customFieldsController.spec.ts b/e2e/src/customFieldsController.spec.ts index 36100849..d960dfc1 100644 --- a/e2e/src/customFieldsController.spec.ts +++ b/e2e/src/customFieldsController.spec.ts @@ -414,7 +414,6 @@ describe('Custom Fields Controller', () => { describe('invalid page or per page parameters', () => { test('should thrown an error when list meta fields with invalid page', async () => { - const errorMessage = 'invalid page: -1'; const data = { resourceType: ResourceType.Subscriptions, page: -1, @@ -423,7 +422,6 @@ describe('Custom Fields Controller', () => { expect(promise).rejects.toThrow(); await promise.catch((error) => { expect(error.statusCode).toBe(422); - expect(error.result.errors[0]).toEqual(errorMessage); }); }); diff --git a/package.json b/package.json index 3b0d7879..54f63e4e 100644 --- a/package.json +++ b/package.json @@ -44,10 +44,10 @@ "typescript": "^4.9.5" }, "dependencies": { - "@apimatic/authentication-adapters": "^0.5.4", - "@apimatic/axios-client-adapter": "^0.3.7", - "@apimatic/core": "^0.10.16", - "@apimatic/schema": "^0.7.14" + "@apimatic/authentication-adapters": "^0.5.10", + "@apimatic/axios-client-adapter": "^0.3.11", + "@apimatic/core": "^0.10.21", + "@apimatic/schema": "^0.7.17" }, "repository": { "type": "git", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 96272c3c..6181330f 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -9,17 +9,17 @@ importers: .: dependencies: '@apimatic/authentication-adapters': - specifier: ^0.5.4 - version: 0.5.6 + specifier: ^0.5.10 + version: 0.5.10 '@apimatic/axios-client-adapter': - specifier: ^0.3.7 - version: 0.3.8 + specifier: ^0.3.11 + version: 0.3.13 '@apimatic/core': - specifier: ^0.10.16 - version: 0.10.17 + specifier: ^0.10.21 + version: 0.10.21 '@apimatic/schema': - specifier: ^0.7.14 - version: 0.7.15 + specifier: ^0.7.17 + version: 0.7.17 devDependencies: '@types/jest': specifier: ^29.4.0 @@ -105,28 +105,28 @@ packages: '@jridgewell/trace-mapping': 0.3.25 dev: true - /@apimatic/authentication-adapters@0.5.6: - resolution: {integrity: sha512-7/m+KLIpsiO83uWtCBRZKmpDtCLBoW5yIM9sOsHslI6RKbGWXu/cTnIE07nlrePLQhfX0+dO/Jl9vfFKIoLYzw==} + /@apimatic/authentication-adapters@0.5.10: + resolution: {integrity: sha512-iXq0e8tRZYaCP9T3pxy56k18UUg3iUlXkf6E6j9XmWHDTOjV0Qjz8Sl5sXwEcb0Qv/WxJPYR4qDJ2Sc6Dvc9PQ==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: - '@apimatic/core-interfaces': 0.2.8 - '@apimatic/http-headers': 0.3.4 - '@apimatic/http-query': 0.3.4 + '@apimatic/core-interfaces': 0.2.11 + '@apimatic/http-headers': 0.3.6 + '@apimatic/http-query': 0.3.6 tslib: 2.8.1 dev: false - /@apimatic/axios-client-adapter@0.3.8: - resolution: {integrity: sha512-nwarzOH9f3O28zRC2HCiP9jLisKIFMDnSFjkFXio/P7X9SOPyTaeTN4K5jiHlpq5O3gChSk26LXiyDIvG1JqVw==} + /@apimatic/axios-client-adapter@0.3.13: + resolution: {integrity: sha512-opjhY2TciRIuhsWwL9WBF5Itv9cEIDXxcmroWM+GHD2ARPw6zDv5RQZsakY2G/Z/NKSkp8KAIWT8cxaszc8W4A==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: - '@apimatic/convert-to-stream': 0.1.4 - '@apimatic/core-interfaces': 0.2.8 - '@apimatic/file-wrapper': 0.3.4 - '@apimatic/http-headers': 0.3.4 - '@apimatic/http-query': 0.3.4 + '@apimatic/convert-to-stream': 0.1.6 + '@apimatic/core-interfaces': 0.2.11 + '@apimatic/file-wrapper': 0.3.6 + '@apimatic/http-headers': 0.3.6 + '@apimatic/http-query': 0.3.6 '@apimatic/json-bigint': 1.2.0 - '@apimatic/schema': 0.7.15 - axios: 1.7.9 + '@apimatic/schema': 0.7.17 + axios: 1.11.0 detect-browser: 5.3.0 detect-node: 2.1.0 form-data: 4.0.1 @@ -137,66 +137,60 @@ packages: - debug dev: false - /@apimatic/convert-to-stream@0.0.2: - resolution: {integrity: sha512-1DRg17ItExfMYsXwjt6WIjJSCgV5RGg3fHPLgYD44/YmiU+7suWj7YfPKKUqmNcnJ/AvMh4lG1+tHrfOT01zXw==} - engines: {node: '>=10.4.0'} - dev: false - - /@apimatic/convert-to-stream@0.1.4: - resolution: {integrity: sha512-QlAUUN/NT4IbajpnFw+w+4GAPwuTtPAEUMBGGKX4M2XLuv8QA4Asag6V19gLsnWFdzcu7mwpjGn+O4tsOlArMQ==} + /@apimatic/convert-to-stream@0.1.6: + resolution: {integrity: sha512-muEyS6Fx6srIa7oyJZUViP4a/OO4oh4hB329pUk5pmWT8PjNULNU5XZymN87GgsxSxfUfVkGxBMNfl2KIKE1QQ==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: tslib: 2.8.1 dev: false - /@apimatic/core-interfaces@0.2.8: - resolution: {integrity: sha512-3o9CkUMeRrg8uE1dDqcvh3MOFIOPqdNRmpFEzhJa5oc0IqHHVhCSU21V9jBe0jB1+Zxc9uHWsq55QXFpliFq8Q==} + /@apimatic/core-interfaces@0.2.11: + resolution: {integrity: sha512-wRrFOkzgKpueXD7ampZYASMJpEMXBg3KxAz2twgeQOTvB/QV7UnY2W8Mim2JJ2glML9R0fGnbrHm8voGPVquLQ==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: - '@apimatic/file-wrapper': 0.3.4 + '@apimatic/file-wrapper': 0.3.6 tslib: 2.8.1 dev: false - /@apimatic/core@0.10.17: - resolution: {integrity: sha512-8AHBm0Y0cjDDtJBgx+TkGXWLWadG+zltMiew7vmrADT8GGhKX/JfMV0R9ae+E1kmnF+C2g/IH/muNx6+HH15pA==} + /@apimatic/core@0.10.21: + resolution: {integrity: sha512-TxudOMiNSkOWK+1G7mLlArM30Xytbb0EALCjQEIyZoceFvkGg8+Vq0Wm2YyBGvNjJHzRviBTRxMirCSbGS6yaQ==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: - '@apimatic/convert-to-stream': 0.0.2 - '@apimatic/core-interfaces': 0.2.8 - '@apimatic/file-wrapper': 0.3.4 - '@apimatic/http-headers': 0.3.4 - '@apimatic/http-query': 0.3.4 + '@apimatic/convert-to-stream': 0.1.6 + '@apimatic/core-interfaces': 0.2.11 + '@apimatic/file-wrapper': 0.3.6 + '@apimatic/http-headers': 0.3.6 + '@apimatic/http-query': 0.3.6 '@apimatic/json-bigint': 1.2.0 - '@apimatic/schema': 0.7.15 + '@apimatic/schema': 0.7.17 detect-browser: 5.3.0 detect-node: 2.1.0 form-data: 4.0.1 - json-ptr: 3.1.1 lodash.defaultsdeep: 4.6.1 lodash.flatmap: 4.5.0 tiny-warning: 1.0.3 tslib: 2.8.1 dev: false - /@apimatic/file-wrapper@0.3.4: - resolution: {integrity: sha512-XMY2Zh1pMOY1mGoz9axxR5Q5MDhdyArh2BxSfdJkRe76t2CiXdmw/+kPgBiX9QvXJXc0rcsDClqg4WMxamDepw==} + /@apimatic/file-wrapper@0.3.6: + resolution: {integrity: sha512-ai/sQwxPyQCssWE5Erg10Ox71VshU8g8rThkrxAbDqku3OYCp8oaWO8WmziiEE6s+vBBnsDI3p0ltMHNWsdVlg==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: tslib: 2.8.1 dev: false - /@apimatic/http-headers@0.3.4: - resolution: {integrity: sha512-ECKyQt9QaRu8nwFJS50HMKKhs+lO191URDUQ5CRzgtGPudmrrmB35I1lz3oVjXelyoJANog2IEGhx3nqoSYD7Q==} + /@apimatic/http-headers@0.3.6: + resolution: {integrity: sha512-hBq/b2inQFhM/Tn/jO6ToRbF6+2Fnm6MpPULt4FlF3Oq/CEFayxpf3Tzza4cYOD9I4i8PPaublEA27hl8Mf0Hw==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: tslib: 2.8.1 dev: false - /@apimatic/http-query@0.3.4: - resolution: {integrity: sha512-6s5DS7dMq1lEJ+9AsTIiMyTXGX9xX5vOnduNSw8csSaQJ5lwMP4O4QzHFT3IFrvctKp/pfS75P0HYGV+9ciltg==} + /@apimatic/http-query@0.3.6: + resolution: {integrity: sha512-HAVZuN633kcrIN5uQHXASV0c2xUwSRo9xjn83I89D/qJLJsvWdVLXqucjPJWcR6UAZRpwr9iGKH64dhvp+v+JA==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: - '@apimatic/file-wrapper': 0.3.4 + '@apimatic/file-wrapper': 0.3.6 tslib: 2.8.1 dev: false @@ -204,8 +198,8 @@ packages: resolution: {integrity: sha512-+bmVzYMdZu0Ya5L+my4FXFUih54OvQA/qlZsFOYdOoostyUuB27UDrVWQs/WVCmS0ADdo5vTU0eeTrrBkHoySw==} dev: false - /@apimatic/schema@0.7.15: - resolution: {integrity: sha512-wJVQPYYJwG9TuMJLvddH7VJ7x5tRK3ycZvcsheeEL9xD2BmTIV5w5ni14gjvmLIbivRsHmMcUkCVhIEssjg+Zg==} + /@apimatic/schema@0.7.17: + resolution: {integrity: sha512-ygBWJa0uCNCAKnmyZ0pIjdDlaixHqhTfqNtZfb52jMs8xl5isjdELfQV8y0FEiRvIHXmI9hL1JTpNj6lv2/Z4g==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: tslib: 2.8.1 @@ -1370,11 +1364,11 @@ packages: resolution: {integrity: sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==} dev: false - /axios@1.7.9: - resolution: {integrity: sha512-LhLcE7Hbiryz8oMDdDptSrWowmB4Bl6RCt6sIJKpRB4XtVf0iEgewX3au/pJqm+Py1kCASkb/FFKjxQaLtxJvw==} + /axios@1.11.0: + resolution: {integrity: sha512-1Lx3WLFQWm3ooKDYZD1eXmoGO9fxYQjrycfHFC8P0sCfQVXyROp0p9PFWBehewBOdCwHc+f/b8I0fMto5eSfwA==} dependencies: follow-redirects: 1.15.9 - form-data: 4.0.1 + form-data: 4.0.4 proxy-from-env: 1.1.0 transitivePeerDependencies: - debug @@ -1504,6 +1498,14 @@ packages: resolution: {integrity: sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==} dev: true + /call-bind-apply-helpers@1.0.2: + resolution: {integrity: sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==} + engines: {node: '>= 0.4'} + dependencies: + es-errors: 1.3.0 + function-bind: 1.1.2 + dev: false + /callsites@3.1.0: resolution: {integrity: sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==} engines: {node: '>=6'} @@ -1753,6 +1755,15 @@ packages: esutils: 2.0.3 dev: true + /dunder-proto@1.0.1: + resolution: {integrity: sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==} + engines: {node: '>= 0.4'} + dependencies: + call-bind-apply-helpers: 1.0.2 + es-errors: 1.3.0 + gopd: 1.2.0 + dev: false + /ejs@3.1.10: resolution: {integrity: sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==} engines: {node: '>=0.10.0'} @@ -1784,6 +1795,33 @@ packages: is-arrayish: 0.2.1 dev: true + /es-define-property@1.0.1: + resolution: {integrity: sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==} + engines: {node: '>= 0.4'} + dev: false + + /es-errors@1.3.0: + resolution: {integrity: sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==} + engines: {node: '>= 0.4'} + dev: false + + /es-object-atoms@1.1.1: + resolution: {integrity: sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==} + engines: {node: '>= 0.4'} + dependencies: + es-errors: 1.3.0 + dev: false + + /es-set-tostringtag@2.1.0: + resolution: {integrity: sha512-j6vWzfrGVfyXxge+O0x5sh6cvxAog0a/4Rdd2K36zCMV5eJ+/+tOAngRO8cODMNWbVRdVlmGZQL2YS3yR8bIUA==} + engines: {node: '>= 0.4'} + dependencies: + es-errors: 1.3.0 + get-intrinsic: 1.3.0 + has-tostringtag: 1.0.2 + hasown: 2.0.2 + dev: false + /escalade@3.1.2: resolution: {integrity: sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==} engines: {node: '>=6'} @@ -2124,6 +2162,17 @@ packages: mime-types: 2.1.35 dev: false + /form-data@4.0.4: + resolution: {integrity: sha512-KrGhL9Q4zjj0kiUt5OO4Mr/A/jlI2jDYs5eHBpYHPcBEVSiipAvn2Ko2HnPe20rmcuuvMHNdZFp+4IlGTMF0Ow==} + engines: {node: '>= 6'} + dependencies: + asynckit: 0.4.0 + combined-stream: 1.0.8 + es-set-tostringtag: 2.1.0 + hasown: 2.0.2 + mime-types: 2.1.35 + dev: false + /fs.realpath@1.0.0: resolution: {integrity: sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==} dev: true @@ -2138,7 +2187,6 @@ packages: /function-bind@1.1.2: resolution: {integrity: sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==} - dev: true /gensync@1.0.0-beta.2: resolution: {integrity: sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==} @@ -2155,11 +2203,35 @@ packages: engines: {node: '>=18'} dev: true + /get-intrinsic@1.3.0: + resolution: {integrity: sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==} + engines: {node: '>= 0.4'} + dependencies: + call-bind-apply-helpers: 1.0.2 + es-define-property: 1.0.1 + es-errors: 1.3.0 + es-object-atoms: 1.1.1 + function-bind: 1.1.2 + get-proto: 1.0.1 + gopd: 1.2.0 + has-symbols: 1.1.0 + hasown: 2.0.2 + math-intrinsics: 1.1.0 + dev: false + /get-package-type@0.1.0: resolution: {integrity: sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==} engines: {node: '>=8.0.0'} dev: true + /get-proto@1.0.1: + resolution: {integrity: sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==} + engines: {node: '>= 0.4'} + dependencies: + dunder-proto: 1.0.1 + es-object-atoms: 1.1.1 + dev: false + /get-stream@6.0.1: resolution: {integrity: sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==} engines: {node: '>=10'} @@ -2220,6 +2292,11 @@ packages: slash: 3.0.0 dev: true + /gopd@1.2.0: + resolution: {integrity: sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==} + engines: {node: '>= 0.4'} + dev: false + /graceful-fs@4.2.11: resolution: {integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==} dev: true @@ -2238,12 +2315,23 @@ packages: engines: {node: '>=8'} dev: true + /has-symbols@1.1.0: + resolution: {integrity: sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==} + engines: {node: '>= 0.4'} + dev: false + + /has-tostringtag@1.0.2: + resolution: {integrity: sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==} + engines: {node: '>= 0.4'} + dependencies: + has-symbols: 1.1.0 + dev: false + /hasown@2.0.2: resolution: {integrity: sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==} engines: {node: '>= 0.4'} dependencies: function-bind: 1.1.2 - dev: true /html-escaper@2.0.2: resolution: {integrity: sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==} @@ -2949,10 +3037,6 @@ packages: resolution: {integrity: sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==} dev: true - /json-ptr@3.1.1: - resolution: {integrity: sha512-SiSJQ805W1sDUCD1+/t1/1BIrveq2Fe9HJqENxZmMCILmrPI7WhS/pePpIOx85v6/H2z1Vy7AI08GV2TzfXocg==} - dev: false - /json-schema-traverse@0.4.1: resolution: {integrity: sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==} dev: true @@ -3095,6 +3179,11 @@ packages: tmpl: 1.0.5 dev: true + /math-intrinsics@1.1.0: + resolution: {integrity: sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==} + engines: {node: '>= 0.4'} + dev: false + /merge-stream@2.0.0: resolution: {integrity: sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==} dev: true