@solvimon/[email protected]

[!CAUTION] ⚠️ This SDK is highly experimental and subject to change

A TypeScript SDK client for the Solvimon API.

Usage

First, install the SDK from npm.

npm install @solvimon/solvimon-typescript-sdk --save

Next, try it out.

import {
  Configuration,
  AlertRulesApi,
} from '@solvimon/solvimon-typescript-sdk';
import type { DeleteAlertRulesByResourceIdRequest } from '@solvimon/solvimon-typescript-sdk';

async function example() {
  console.log("🚀 Testing @solvimon/solvimon-typescript-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: JWT-Authentication
    accessToken: "YOUR BEARER TOKEN",
    // To configure API key authorization: API-Key
    apiKey: "YOUR API KEY",
  });
  const api = new AlertRulesApi(config);

  const body = {
    // string | version
    version: version_example,
    // string | The ID of the resource to be requested.
    resourceId: resourceId_example,
    // string | Platform ID. (optional)
    xPlatformId: xPlatformId_example,
  } satisfies DeleteAlertRulesByResourceIdRequest;

  try {
    const data = await api.deleteAlertRulesByResourceId(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://test.api.solvimon.com

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AlertRulesApi | deleteAlertRulesByResourceId | DELETE /v{version}/alert-rules/{resourceId} | Delete an alert rule AlertRulesApi | getAlertRules | GET /v{version}/alert-rules | Get a list of alert rules AlertRulesApi | getAlertRulesByResourceId | GET /v{version}/alert-rules/{resourceId} | Get an alert rule by its ID AlertRulesApi | postAlertRules | POST /v{version}/alert-rules | Create an alert rule AlertRulesApi | updateAlertRulesByResourceId | PATCH /v{version}/alert-rules/{resourceId} | Update an alert rule AlertsApi | getAlerts | GET /v{version}/alerts | Get a list of alerts AlertsApi | getAlertsByResourceId | GET /v{version}/alerts/{resourceId} | Get an alert by its ID AlertsApi | postAlerts | POST /v{version}/alerts | Create an alert ApiKeysApi | getApiKeys | GET /v{version}/api-keys | Get a list of all API Keys ApiKeysApi | getApiKeysByResourceId | GET /v{version}/api-keys/{resourceId} | Get an API key by id ApiKeysApi | getApiKeysDecryptByResourceId | GET /v{version}/api-keys/{resourceId}/decrypt | Get a decrypted API key by id ApiKeysApi | postApiKeys | POST /v{version}/api-keys | Create an API Key ApiKeysApi | postApiKeysSearch | POST /v{version}/api-keys/search | Search for api keys using a filter ApiKeysApi | updateApiKeysByResourceId | PATCH /v{version}/api-keys/{resourceId} | Patch an API key by id ApprovalPolicyApi | deleteApprovalPoliciesByResourceId | DELETE /v{version}/approval-policies/{resourceId} | Delete an approval policy by resource ID ApprovalPolicyApi | getApprovalPolicies | GET /v{version}/approval-policies | Get all the approval policies. ApprovalPolicyApi | getApprovalPoliciesByResourceId | GET /v{version}/approval-policies/{resourceId} | Get approval policy. ApprovalPolicyApi | postApprovalPolicies | POST /v{version}/approval-policies | Create a new Approval Policy ApprovalPolicyApi | postApprovalPoliciesActivate | POST /v{version}/approval-policies/{resourceId}/activate | Activate approval policy ApprovalPolicyApi | postApprovalPoliciesArchive | POST /v{version}/approval-policies/{resourceId}/archive | Archive approval policy ApprovalPolicyApi | postApprovalPoliciesDeprecate | POST /v{version}/approval-policies/{resourceId}/deprecate | Deprecate approval policy ApprovalPolicyApi | updateApprovalPoliciesByResourceId | PATCH /v{version}/approval-policies/{resourceId} | Update an approval policy ApprovalRequestApi | getApprovalRequests | GET /v{version}/approval-requests | Get all the approval requests. ApprovalRequestApi | getApprovalRequestsByResourceId | GET /v{version}/approval-requests/{resourceId} | Get approval request. ApprovalRequestApi | postApprovalRequestsApprove | POST /v{version}/approval-requests/{resourceId}/approve | Approve an Approval Request ApprovalRequestApi | postApprovalRequestsCancel | POST /v{version}/approval-requests/{resourceId}/cancel | Cancel an Approval Request ApprovalRequestApi | postApprovalRequestsDecline | POST /v{version}/approval-requests/{resourceId}/decline | Decline an Approval Request AttachmentsApi | deleteAttachmentsByResourceId | DELETE /v{version}/attachments/{resourceId} | Delete an attachment AttachmentsApi | getAttachments | GET /v{version}/attachments | Get attachments AttachmentsApi | getAttachmentsByResourceId | GET /v{version}/attachments/{resourceId} | Get an attachment by ID AttachmentsApi | postAttachments | POST /v{version}/attachments | Create an attachment AuditRecordsApi | getAuditRecords | GET /v{version}/audit-records | Get a list of audit records AuditRecordsApi | getAuditRecordsByResourceId | GET /v{version}/audit-records/{resourceId} | Get an invoice by resource ID AuthenticationApi | postOauthActivateUser | POST /v{version}/oauth/activate-user | Activate User AuthenticationApi | postOauthCallback | POST /v{version}/oauth/callback | SSO authentication callback AuthenticationApi | postOauthDemoToken | POST /v{version}/oauth/demo-token | Obtain token for read-only demo access AuthenticationApi | postOauthLogout | POST /v{version}/oauth/logout | Log user out AuthenticationApi | postOauthRefreshToken | POST /v{version}/oauth/refresh-token | Obtain new token with refresh-token AuthenticationApi | postOauthRequestPasswordReset | POST /v{version}/oauth/request-password-reset | Request user password reset AuthenticationApi | postOauthResetPassword | POST /v{version}/oauth/reset-password | Reset password AuthenticationApi | postOauthToken | POST /v{version}/oauth/token | Obtain token for provided credentials AuthenticationProvidersApi | getAuthenticationProviders | GET /v{version}/authentication-providers | Retrieve a list of configured authentication providers AuthenticationProvidersApi | getAuthenticationProvidersByResourceId | GET /v{version}/authentication-providers/{resourceId} | Get authentication provider by ID AuthenticationProvidersApi | postAuthenticationProviders | POST /v{version}/authentication-providers | Create a authentication provider configuration AuthenticationProvidersApi | postAuthenticationProvidersEnabled | POST /v{version}/authentication-providers/enabled | Retrieve a list of enabled authentication providers that can be used to activate an invited user. AuthenticationProvidersApi | updateAuthenticationProvidersByResourceId | PATCH /v{version}/authentication-providers/{resourceId} | Get authentication provider by ID BillingEntitiesApi | getBillingEntities | GET /v{version}/billing-entities | Get a list of all billing entities BillingEntitiesApi | getBillingEntitiesByResourceIdOrReference | GET /v{version}/billing-entities/{resourceIdOrReference} | Get a billing entity BillingEntitiesApi | postBillingEntities | POST /v{version}/billing-entities | Create a billing entity BillingEntitiesApi | updateBillingEntities | PUT /v{version}/billing-entities | Update or create a billing entity (upsert) BillingEntitiesApi | updateBillingEntitiesByResourceIdOrReference | PATCH /v{version}/billing-entities/{resourceIdOrReference} | Update a billing entity BulkActionsApi | getBulkActions | GET /v{version}/bulk-actions | Get all bulk actions BulkActionsApi | getBulkActionsByResourceId | GET /v{version}/bulk-actions/{resourceId} | Get bulk action BulkActionsApi | getBulkActionsItemsByResourceId | GET /v{version}/bulk-actions/{resourceId}/items | Get bulk action items BulkActionsApi | postBulkActions | POST /v{version}/bulk-actions | Create bulk action BulkActionsApi | postBulkActionsCheck | POST /v{version}/bulk-actions/check | Check work BulkActionsApi | postBulkActionsSearch | POST /v{version}/bulk-actions/search | Search bulk actions ContactsApi | deleteContactsByResourceId | DELETE /v{version}/contacts/{resourceId} | Delete a contact by ID ContactsApi | getContacts | GET /v{version}/contacts | Get a list of contacts ContactsApi | getContactsByResourceId | GET /v{version}/contacts/{resourceId} | Get a contact by ID ContactsApi | postContacts | POST /v{version}/contacts | Create a contact ContactsApi | updateContacts | PUT /v{version}/contacts | Update or create a contact (upsert) ContactsApi | updateContactsByResourceId | PATCH /v{version}/contacts/{resourceId} | Update a contact CouponsApi | getCoupons | GET /v{version}/coupons | Get a list of coupons CouponsApi | getCouponsByResourceIdOrReference | GET /v{version}/coupons/{resourceIdOrReference} | Get a coupon CouponsApi | getCouponsRedemptionsByResourceIdOrReference | GET /v{version}/coupons/{resourceIdOrReference}/redemptions | Get a list of coupon redemptions CouponsApi | postCoupons | POST /v{version}/coupons | Create a coupon CouponsApi | postCouponsActivate | POST /v{version}/coupons/{resourceIdOrReference}/activate | Activate a coupon CouponsApi | postCouponsArchive | POST /v{version}/coupons/{resourceIdOrReference}/archive | Archive a coupon CouponsApi | postCouponsDeactivate | POST /v{version}/coupons/{resourceIdOrReference}/deactivate | Deactivate a coupon CouponsApi | postCouponsDeprecate | POST /v{version}/coupons/{resourceIdOrReference}/deprecate | Deprecate a coupon CouponsApi | updateCouponsByResourceIdOrReference | PATCH /v{version}/coupons/{resourceIdOrReference} | Update a coupon CreditTypesApi | getCreditTypes | GET /v{version}/credit-types | Get a list of all credit types CreditTypesApi | getCreditTypesByResourceIdOrReference | GET /v{version}/credit-types/{resourceIdOrReference} | Get a credit type CreditTypesApi | postCreditTypes | POST /v{version}/credit-types | Create a credit type CreditTypesApi | postCreditTypesActivate | POST /v{version}/credit-types/{resourceIdOrReference}/activate | Activate a credit type CreditTypesApi | postCreditTypesArchive | POST /v{version}/credit-types/{resourceIdOrReference}/archive | Archive a credit type CreditTypesApi | postCreditTypesDeactivate | POST /v{version}/credit-types/{resourceIdOrReference}/deactivate | Deactivate a credit type CreditTypesApi | postCreditTypesDeprecate | POST /v{version}/credit-types/{resourceIdOrReference}/deprecate | Deprecate a credit type CreditTypesApi | updateCreditTypesByResourceIdOrReference | PATCH /v{version}/credit-types/{resourceIdOrReference} | Update a credit type CustomFieldsApi | deleteCustomFieldsByResourceId | DELETE /v{version}/custom-fields/{resourceId} | Delete a custom field CustomFieldsApi | getCustomFields | GET /v{version}/custom-fields | Get all custom fields CustomFieldsApi | getCustomFieldsByResourceId | GET /v{version}/custom-fields/{resourceId} | Get a custom field by ID CustomFieldsApi | postCustomFields | POST /v{version}/custom-fields | Create a custom field for a customer CustomFieldsApi | updateCustomFieldsByResourceId | PATCH /v{version}/custom-fields/{resourceId} | Update the custom field CustomersApi | deleteCustomersByResourceIdOrReference | DELETE /v{version}/customers/{resourceIdOrReference} | Delete a customer by ID or reference CustomersApi | getCustomers | GET /v{version}/customers | Get a list of all customers CustomersApi | getCustomersByResourceIdOrReference | GET /v{version}/customers/{resourceIdOrReference} | Get a customer by ID or reference CustomersApi | getCustomersEntitlementsByResourceIdOrReference | GET /v{version}/customers/{resourceIdOrReference}/entitlements | Get a customer its entitlements CustomersApi | postCustomers | POST /v{version}/customers | Create a customer CustomersApi | postCustomersActivate | POST /v{version}/customers/{resourceIdOrReference}/activate | Activate a customer CustomersApi | postCustomersArchive | POST /v{version}/customers/{resourceIdOrReference}/archive | Archive a customer CustomersApi | postCustomersDeprecate | POST /v{version}/customers/{resourceIdOrReference}/deprecate | Deprecate a customer CustomersApi | postCustomersForget | POST /v{version}/customers/{resourceIdOrReference}/forget | Forget a customer CustomersApi | postCustomersSearch | POST /v{version}/customers/search | Search customers CustomersApi | postCustomersValidateTaxId | POST /v{version}/customers/validate-tax-id | Validate tax id values CustomersApi | postCustomersWalletsBalance | POST /v{version}/customers/{resourceIdOrReference}/wallets/balance | Get the balance of all wallets of a customer CustomersApi | updateCustomers | PUT /v{version}/customers | Update or create a customer (upsert) CustomersApi | updateCustomersByResourceIdOrReference | PATCH /v{version}/customers/{resourceIdOrReference} | Update a customer by ID or reference DocumentsApi | deleteDocumentsByResourceId | DELETE /v{version}/documents/{resourceId} | Delete a document DocumentsApi | getDocumentsByResourceId | GET /v{version}/documents/{resourceId} | Get a document by ID DocumentsApi | postDocuments | POST /v{version}/documents | Upload a document DocumentsApi | postDocumentsDownload | POST /v{version}/documents/{resourceId}/download | Download a document FeaturesApi | deleteFeaturesByResourceId | DELETE /v{version}/features/{resourceId} | Delete a feature by resource ID FeaturesApi | getFeatures | GET /v{version}/features | Get a list of all features FeaturesApi | getFeaturesByResourceId | GET /v{version}/features/{resourceId} | Get a feature by resource ID FeaturesApi | postFeatures | POST /v{version}/features | Create a feature FeaturesApi | updateFeatures | PUT /v{version}/features | Update or create a feature (upsert) FeaturesApi | updateFeaturesByResourceId | PATCH /v{version}/features/{resourceId} | Update a feature FileProcessingSettingsApi | getFileProcessingSettingsByResourceId | GET /v{version}/file-processing-settings/{resourceId} | Get the file processing settings by resource ID FileProcessingSettingsApi | postFileProcessingSettings | POST /v{version}/file-processing-settings | Create file processing settings FileProcessingSettingsApi | updateFileProcessingSettingsByResourceId | PATCH /v{version}/file-processing-settings/{resourceId} | Update file processing settings FilesApi | getFiles | GET /v{version}/files | Get a list of files FilesApi | getFilesByResourceId | GET /v{version}/files/{resourceId} | Get a file by its ID FilesApi | getFilesLinesByResourceId | GET /v{version}/files/{resourceId}/lines | Get the file lines of a file by the files ID FilesApi | postFiles | POST /v{version}/files | Create a file FilesApi | updateFilesByResourceId | PATCH /v{version}/files/{resourceId} | Update a file IngestApi | getEvents | GET /v{version}/events | Get a list of events for provided filters IngestApi | getEventsByResourceId | GET /v{version}/events/{resourceId} | Get an event by ID IngestApi | getEventsEventTraceByResourceId | GET /v{version}/events/{resourceId}/event_trace | Get the event trace history of the event. IngestApi | getIngestMeterData | GET /v{version}/ingest/meter-data | Get a list of events for provided filters IngestApi | getIngestMeterDataByResourceId | GET /v{version}/ingest/meter-data/{resourceId} | Get an event by ID IngestApi | getIngestMeterDataEventTraceByResourceId | GET /v{version}/ingest/meter-data/{resourceId}/event_trace | Get the event trace history of the event. IngestApi | postEventsCalculate | POST /v{version}/events/calculate | Calculate the costs for an event IngestApi | postEventsDelete | POST /v{version}/events/delete | Mark an event as deleted IngestApi | postEventsDeletePost | POST /v{version}/events/{resourceId}/delete | Mark an event as deleted IngestApi | postEventsIngest | POST /v{version}/events/ingest | Ingest an event IngestApi | postEventsIngestList | POST /v{version}/events/ingest-list | Ingest a list of meter events IngestApi | postIngestAdjustmentData | POST /v{version}/ingest/adjustment-data | Ingest adjustment events IngestApi | postIngestChargeData | POST /v{version}/ingest/charge-data | Ingest charge events IngestApi | postIngestMeterData | POST /v{version}/ingest/meter-data | Ingest an event IngestApi | postIngestMeterDataDelete | POST /v{version}/ingest/meter-data/delete | Mark an event as deleted IngestApi | postIngestMeterDataDeletePost | POST /v{version}/ingest/meter-data/{resourceId}/delete | Mark an event as deleted IngestApi | postIngestMeterDatas | POST /v{version}/ingest/meter-datas | Ingest a list of meter events IngestApi | postIngestPersistData | POST /v{version}/ingest/persist-data | Ingest persist events IntegrationsApi | deleteIntegrationsByResourceId | DELETE /v{version}/integrations/{resourceId} | Deleting an integration by its ID IntegrationsApi | getIntegrations | GET /v{version}/integrations | Get a list of integrations IntegrationsApi | getIntegrationsByResourceId | GET /v{version}/integrations/{resourceId} | Get an integration by its ID IntegrationsApi | getIntegrationsEInvoicingDefaultMandates | GET /v{version}/integrations/e-invoicing/default-mandates | Get a list of mandates IntegrationsApi | postIntegrations | POST /v{version}/integrations | Create an integration IntegrationsApi | postIntegrationsActivate | POST /v{version}/integrations/{resourceId}/activate | Activate an integration IntegrationsApi | postIntegrationsArchive | POST /v{version}/integrations/{resourceId}/archive | Archive an integration IntegrationsApi | postIntegrationsDeprecate | POST /v{version}/integrations/{resourceId}/deprecate | Deprecate an integration IntegrationsApi | postIntegrationsTestConnection | POST /v{version}/integrations/test-connection | Test whether the integration connection is successful IntegrationsApi | updateIntegrationsByResourceId | PATCH /v{version}/integrations/{resourceId} | Update an integration by its ID InvoicesApi | deleteInvoicesLinesByResourceId | DELETE /v{version}/invoices/{resourceId}/lines/{invoiceLineResourceId} | Delete an invoice line by ID InvoicesApi | getInvoices | GET /v{version}/invoices | Get a list of invoices InvoicesApi | getInvoicesByResourceId | GET /v{version}/invoices/{resourceId} | Get an invoice by ID InvoicesApi | getInvoicesDownloadEInvoiceByResourceId | GET /v{version}/invoices/{resourceId}/download-e-invoice | Get the eInvoice that was submitted to the Tax Authority InvoicesApi | getInvoicesPaymentAttemptsByResourceId | GET /v{version}/invoices/{resourceId}/payment-attempts | Deprecated. Instead use /payments to get the payments for the invoice InvoicesApi | getInvoicesPaymentsByResourceId | GET /v{version}/invoices/{resourceId}/payments | Get the payments made for the invoice InvoicesApi | getInvoicesPdfByResourceId | GET /v{version}/invoices/{resourceId}/pdf | Get the invoice as a PDF InvoicesApi | getInvoicesUbl21ByResourceId | GET /v{version}/invoices/{resourceId}/ubl21 | Get the invoice as a UBL 2.1 InvoicesApi | postInvoices | POST /v{version}/invoices | Create a one-off invoice or credit invoice InvoicesApi | postInvoicesAddLine | POST /v{version}/invoices/{resourceId}/add-line | Add a line to an invoice InvoicesApi | postInvoicesArchive | POST /v{version}/invoices/{resourceId}/archive | Archive an invoice InvoicesApi | postInvoicesCancelDunningActions | POST /v{version}/invoices/{resourceId}/cancel-dunning-actions | Cancel invoice dunning actions InvoicesApi | postInvoicesCredit | POST /v{version}/invoices/{resourceId}/credit | Create a credit invoice for the provided invoice resource ID InvoicesApi | postInvoicesDeleteLine | POST /v{version}/invoices/{resourceId}/delete-line | Delete a line from an invoice InvoicesApi | postInvoicesExportToErp | POST /v{version}/invoices/{resourceId}/export_to_erp | Export an invoice to an ERP. InvoicesApi | postInvoicesLines | POST /v{version}/invoices/{resourceId}/lines | Add a line to an invoice InvoicesApi | postInvoicesPay | POST /v{version}/invoices/{resourceId}/pay | Pay the invoice using customer stored payment method InvoicesApi | postInvoicesPreview | POST /v{version}/invoices/preview | Create a preview invoice InvoicesApi | postInvoicesRefresh | POST /v{version}/invoices/{resourceId}/refresh | Refresh the invoice and get it InvoicesApi | postInvoicesRefreshEInvoices | POST /v{version}/invoices/{resourceId}/refresh-e-invoices | Refresh the eInvoices that belong to this invoice and get the invoice itself InvoicesApi | postInvoicesRefund | POST /v{version}/invoices/{resourceId}/refund | Refund a credit invoice via the original payment InvoicesApi | postInvoicesResubmitEInvoice | POST /v{version}/invoices/{resourceId}/resubmit-e-invoice | Refresh the eInvoices that belong to this invoice and get the invoice itself InvoicesApi | postInvoicesSearch | POST /v{version}/invoices/search | Search invoices InvoicesApi | postInvoicesSendByEmail | POST /v{version}/invoices/{resourceId}/send_by_email | Send an invoice via email. InvoicesApi | updateInvoicesByResourceId | PATCH /v{version}/invoices/{resourceId} | Update an invoice InvoicesApi | updateInvoicesLinesByResourceId | PUT /v{version}/invoices/{resourceId}/lines/{invoiceLineResourceId} | Replaces an one-off invoice line in an invoice based on the invoice line id InvoicesApi | updateInvoicesUpdateEInvoiceStatusByResourceId | PATCH /v{version}/invoices/{resourceId}/update-e-invoice-status | Patch the eInvoice that was submitted to the Tax Authority MeterPropertiesApi | deleteMeterPropertiesByResourceIdOrReference | DELETE /v{version}/meter-properties/{resourceIdOrReference} | Delete a meter property MeterPropertiesApi | getMeterProperties | GET /v{version}/meter-properties | Get a list of all meter properties MeterPropertiesApi | getMeterPropertiesByResourceIdOrReference | GET /v{version}/meter-properties/{resourceIdOrReference} | Get a meter property MeterPropertiesApi | postMeterProperties | POST /v{version}/meter-properties | Create a meter property MeterPropertiesApi | updateMeterPropertiesByResourceIdOrReference | PATCH /v{version}/meter-properties/{resourceIdOrReference} | Update a meter property MeterValueCalculationsApi | deleteMeterValueCalculationsByResourceId | DELETE /v{version}/meter-value-calculations/{resourceId} | Delete a meter value calculation by resource ID MeterValueCalculationsApi | getMeterValueCalculations | GET /v{version}/meter-value-calculations | Get a list of all meter value calculations MeterValueCalculationsApi | getMeterValueCalculationsByResourceId | GET /v{version}/meter-value-calculations/{resourceId} | Get a meter value calculation by resource ID MeterValueCalculationsApi | postMeterValueCalculations | POST /v{version}/meter-value-calculations | Create a meter value calculation MeterValueCalculationsApi | updateMeterValueCalculationsByResourceId | PATCH /v{version}/meter-value-calculations/{resourceId} | Update a meter value calculation MeterValuesApi | deleteMeterValuesByResourceIdOrReference | DELETE /v{version}/meter-values/{resourceIdOrReference} | Delete a meter value MeterValuesApi | getMeterValues | GET /v{version}/meter-values | Get a list of all meter values MeterValuesApi | getMeterValuesByResourceIdOrReference | GET /v{version}/meter-values/{resourceIdOrReference} | Get a meter value MeterValuesApi | postMeterValues | POST /v{version}/meter-values | Create a meter value MeterValuesApi | updateMeterValuesByResourceIdOrReference | PATCH /v{version}/meter-values/{resourceIdOrReference} | Update a meter value MetersApi | deleteMetersByResourceIdOrReference | DELETE /v{version}/meters/{resourceIdOrReference} | Delete a meter MetersApi | getMeters | GET /v{version}/meters | Get a list of meters MetersApi | getMetersByResourceIdOrReference | GET /v{version}/meters/{resourceIdOrReference} | Get a meter MetersApi | getMetersMeterDataFileByResourceIdOrReference | GET /v{version}/meters/{resourceIdOrReference}/meter-data-file | Get a file with the headers for ingesting meter events for a meter MetersApi | postMeters | POST /v{version}/meters | Create a meter MetersApi | updateMetersByResourceIdOrReference | PATCH /v{version}/meters/{resourceIdOrReference} | Update a meter PaymentAcceptorsApi | deletePaymentAcceptorsByResourceId | DELETE /v{version}/payment-acceptors/{resourceId} | Delete a payment acceptor PaymentAcceptorsApi | getPaymentAcceptors | GET /v{version}/payment-acceptors | Get a list of payment acceptors for provided filters PaymentAcceptorsApi | getPaymentAcceptorsByResourceId | GET /v{version}/payment-acceptors/{resourceId} | Get a payment acceptor by resource ID PaymentAcceptorsApi | postPaymentAcceptors | POST /v{version}/payment-acceptors | Create a payment acceptor PaymentAcceptorsApi | postPaymentAcceptorsPaymentMethodOptions | POST /v{version}/payment-acceptors/payment-method-options | Retrieve payment method options for payment acceptors PaymentAcceptorsApi | updatePaymentAcceptorsByResourceId | PATCH /v{version}/payment-acceptors/{resourceId} | Update the payment acceptor PaymentMethodsApi | getPaymentMethods | GET /v{version}/payment-methods | Get a list of payment methods PaymentMethodsApi | getPaymentMethodsByResourceIdOrReference | GET /v{version}/payment-methods/{resourceIdOrReference} | Get a payment method PaymentMethodsApi | postPaymentMethods | POST /v{version}/payment-methods | Create a payment method PaymentMethodsApi | postPaymentMethodsRefresh | POST /v{version}/payment-methods/refresh | Refresh the payment methods of a customer PaymentMethodsApi | postPaymentMethodsTokenize | POST /v{version}/payment-methods/tokenize | Tokenize a payment method PaymentMethodsApi | updatePaymentMethods | PUT /v{version}/payment-methods | Update or create a payment method (upsert) PaymentMethodsApi | updatePaymentMethodsByResourceIdOrReference | PATCH /v{version}/payment-methods/{resourceIdOrReference} | Update a payment method PaymentSchedulesApi | getPaymentSchedules | GET /v{version}/payment-schedules | Get a list of payment schedules PaymentSchedulesApi | getPaymentSchedulesByResourceIdOrReference | GET /v{version}/payment-schedules/{resourceIdOrReference} | Get a payment schedule by ID or reference PaymentSchedulesApi | postPaymentSchedules | POST /v{version}/payment-schedules | Create a payment schedule PaymentSchedulesApi | postPaymentSchedulesActivate | POST /v{version}/payment-schedules/{resourceIdOrReference}/activate | Activate a payment schedule PaymentSchedulesApi | postPaymentSchedulesCancel | POST /v{version}/payment-schedules/{resourceIdOrReference}/cancel | Cancel a payment schedule PaymentSchedulesApi | postPaymentSchedulesInit | POST /v{version}/payment-schedules/init | Initialize resources for a payment schedule PaymentSchedulesApi | postPaymentSchedulesPause | POST /v{version}/payment-schedules/{resourceIdOrReference}/pause | Pause a payment schedule PaymentSchedulesApi | updatePaymentSchedulesByResourceIdOrReference | PATCH /v{version}/payment-schedules/{resourceIdOrReference} | Patch a payment schedule. PaymentsApi | getPaymentRequests | GET /v{version}/payment-requests | Get Payment Requests PaymentsApi | getPaymentRequestsByResourceId | GET /v{version}/payment-requests/{resourceId} | Get a Payment Request by ID PaymentsApi | getPayments | GET /v{version}/payments | Get a list of payments PaymentsApi | getPaymentsByResourceId | GET /v{version}/payments/{resourceId} | Get a payment by ID PaymentsApi | postPaymentsAuthorize | POST /v{version}/payments/authorize | Authorize a payment PaymentsApi | postPaymentsRefund | POST /v{version}/payments/{resourceId}/refund | Refund a payment PaymentsApi | postPaymentsVerifyDetails | POST /v{version}/payments/verify-details | Verify payment details PlatformsApi | getPlatformsByResourceId | GET /v{version}/platforms/{resourceId} | Get your platform details PlatformsApi | getPlatformsCurrenciesByResourceId | GET /v{version}/platforms/{resourceId}/currencies | Get currencies for platform PlatformsApi | getPlatformsEntitlementsByResourceId | GET /v{version}/platforms/{resourceId}/entitlements | Get your platform entitlements PlatformsApi | getPlatformsUpToDateByResourceId | GET /v{version}/platforms/{resourceId}/up-to-date | Get up-to-date for platform PlatformsApi | updatePlatformsByResourceId | PATCH /v{version}/platforms/{resourceId} | Update your platform PortalUrlsApi | getPortalUrls | GET /v{version}/portal-urls | Get a list of portal urls PortalUrlsApi | getPortalUrlsByResourceId | GET /v{version}/portal-urls/{resourceId} | Get a portal url by resource ID PortalUrlsApi | postPortalUrls | POST /v{version}/portal-urls | Create a portal url PortalUrlsApi | postPortalUrlsRevoke | POST /v{version}/portal-urls/{resourceId}/revoke | Revoke a portal url PortalUrlsApi | updatePortalUrlsByResourceId | PATCH /v{version}/portal-urls/{resourceId} | Patch portal url PricingGroupsApi | deletePricingGroupsByResourceId | DELETE /v{version}/pricing-groups/{resourceId} | Delete a pricing group by resource ID PricingGroupsApi | getPricingGroupsByResourceId | GET /v{version}/pricing-groups/{resourceId} | Get a pricing group by resource ID PricingGroupsApi | postPricingGroups | POST /v{version}/pricing-groups | Create a pricingGroup PricingGroupsApi | updatePricingGroupsByResourceId | PATCH /v{version}/pricing-groups/{resourceId} | Update a pricing PricingPlanSchedulesApi | deletePricingPlanSchedulesByResourceId | DELETE /v{version}/pricing-plan-schedules/{resourceId} | Delete a pricingPlanSchedule by resource ID PricingPlanSchedulesApi | getPricingPlanSchedules | GET /v{version}/pricing-plan-schedules | Get a list of PricingPlanSchedules for provided filters PricingPlanSchedulesApi | getPricingPlanSchedulesByResourceId | GET /v{version}/pricing-plan-schedules/{resourceId} | Get a pricingPlanSchedule by resourceID PricingPlanSchedulesApi | postPricingPlanSchedules | POST /v{version}/pricing-plan-schedules | Create a pricing plan schedule PricingPlanSchedulesApi | postPricingPlanSchedulesCopy | POST /v{version}/pricing-plan-schedules/{resourceId}/copy | Copy a pricing plan schedule PricingPlanSchedulesApi | postPricingPlanSchedulesMigrate | POST /v{version}/pricing-plan-schedules/{resourceId}/migrate | Migrate a pricing plan schedule to a new pricing plan version PricingPlanSchedulesApi | updatePricingPlanSchedulesByResourceId | PATCH /v{version}/pricing-plan-schedules/{resourceId} | Update a pricingPlanSchedule PricingPlanSubscriptionGroupsApi | deletePricingPlanSubscriptionGroupsByResourceId | DELETE /v{version}/pricing-plan-subscription-groups/{resourceId} | Delete a pricing plan subscription group by its ID PricingPlanSubscriptionGroupsApi | getPricingPlanSubscriptionGroups | GET /v{version}/pricing-plan-subscription-groups | Get a list of pricing plan subscription groups PricingPlanSubscriptionGroupsApi | getPricingPlanSubscriptionGroupsByResourceId | GET /v{version}/pricing-plan-subscription-groups/{resourceId} | Get a pricing plan subscription group by its ID PricingPlanSubscriptionGroupsApi | postPricingPlanSubscriptionGroups | POST /v{version}/pricing-plan-subscription-groups | Create a pricing plan subscription group PricingPlanSubscriptionGroupsApi | updatePricingPlanSubscriptionGroupsByResourceId | PATCH /v{version}/pricing-plan-subscription-groups/{resourceId} | Update a pricing plan subscription group by its ID PricingPlanSubscriptionsApi | deletePricingPlanSubscriptionsByResourceId | DELETE /v{version}/pricing-plan-subscriptions/{resourceId} | Delete a pricing plan subscription by resource ID PricingPlanSubscriptionsApi | getPricingPlanSubscriptions | GET /v{version}/pricing-plan-subscriptions | Get a list of pricing plan subscriptions PricingPlanSubscriptionsApi | getPricingPlanSubscriptionsByResourceId | GET /v{version}/pricing-plan-subscriptions/{resourceId} | Get a pricing plan subscription by its ID PricingPlanSubscriptionsApi | postPricingPlanSubscriptions | POST /v{version}/pricing-plan-subscriptions | Create a pricing plan subscription PricingPlanSubscriptionsApi | postPricingPlanSubscriptionsArchive | POST /v{version}/pricing-plan-subscriptions/{resourceId}/archive | Archive a pricing plan subscription by resource ID PricingPlanSubscriptionsApi | postPricingPlanSubscriptionsCancel | POST /v{version}/pricing-plan-subscriptions/{resourceId}/cancel | Cancel a pricing plan subscription by resource ID PricingPlanSubscriptionsApi | postPricingPlanSubscriptionsCopy | POST /v{version}/pricing-plan-subscriptions/{resourceId}/copy | Copy a pricing plan subscription by resource ID PricingPlanSubscriptionsApi | postPricingPlanSubscriptionsInit | POST /v{version}/pricing-plan-subscriptions/init | Create a pricing plan subscription and schedule. This will also result in a first invoice being created for the provided pricing plan schedule and subscription. PricingPlanSubscriptionsApi | postPricingPlanSubscriptionsSearch | POST /v{version}/pricing-plan-subscriptions/search | Search a pricing plan subscription PricingPlanSubscriptionsApi | postPricingPlanSubscriptionsUpdatePaymentMethod | POST /v{version}/pricing-plan-subscriptions/{resourceId}/update-payment-method | Change the payment method of a pricing plan subscription PricingPlanSubscriptionsApi | postPricingPlanSubscriptionsVoid | POST /v{version}/pricing-plan-subscriptions/{resourceId}/void | Void a pricing plan subscription by resource ID PricingPlanSubscriptionsApi | updatePricingPlanSubscriptions | PUT /v{version}/pricing-plan-subscriptions | Update or create a pricing plan subscription (upsert) PricingPlanSubscriptionsApi | updatePricingPlanSubscriptionsByResourceId | PATCH /v{version}/pricing-plan-subscriptions/{resourceId} | Update a pricing plan subscription by resource ID PricingPlanVersionsApi | deletePricingPlanVersionsByResourceId | DELETE /v{version}/pricing-plan-versions/{resourceId} | Delete a pricing plan version by resource ID PricingPlanVersionsApi | getPricingPlanVersionsByResourceId | GET /v{version}/pricing-plan-versions/{resourceId} | Get a pricing plan version by ID PricingPlanVersionsApi | postPricingPlanVersions | POST /v{version}/pricing-plan-versions | Create a pricing plan version PricingPlanVersionsApi | updatePricingPlanVersions | PUT /v{version}/pricing-plan-versions | Update or create a pricing plan version (upsert) PricingPlanVersionsApi | updatePricingPlanVersionsByResourceId | PATCH /v{version}/pricing-plan-versions/{resourceId} | Update a pricing plan version PricingPlansApi | deletePricingPlansByResourceIdOrReference | DELETE /v{version}/pricing-plans/{resourceIdOrReference} | Delete a pricing plan PricingPlansApi | getPricingPlans | GET /v{version}/pricing-plans | Get a list of all pricing plans PricingPlansApi | getPricingPlansByResourceIdOrReference | GET /v{version}/pricing-plans/{resourceIdOrReference} | Get a pricing plan PricingPlansApi | postPricingPlans | POST /v{version}/pricing-plans | Create a pricing plan PricingPlansApi | postPricingPlansSearch | POST /v{version}/pricing-plans/search | search a pricing plan PricingPlansApi | updatePricingPlans | PUT /v{version}/pricing-plans | Update or create a pricing plan (upsert) PricingPlansApi | updatePricingPlansByResourceIdOrReference | PATCH /v{version}/pricing-plans/{resourceIdOrReference} | Update a pricing plan PricingsApi | deletePricingsByResourceId | DELETE /v{version}/pricings/{resourceId} | Delete a pricing by resource ID PricingsApi | postPricings | POST /v{version}/pricings | Create a pricing PricingsApi | updatePricingsByResourceId | PATCH /v{version}/pricings/{resourceId} | Update a pricing ProductCategoriesApi | deleteProductCategoriesByResourceIdOrReference | DELETE /v{version}/product-categories/{resourceIdOrReference} | Delete a product category ProductCategoriesApi | getProductCategories | GET /v{version}/product-categories | Get a list of all product categories ProductCategoriesApi | getProductCategoriesByResourceIdOrReference | GET /v{version}/product-categories/{resourceIdOrReference} | Get a product category ProductCategoriesApi | postProductCategories | POST /v{version}/product-categories | Create a product category ProductCategoriesApi | postProductCategoriesSearch | POST /v{version}/product-categories/search | Search product categories. ProductCategoriesApi | updateProductCategories | PUT /v{version}/product-categories | Update or create a product category (upsert) ProductCategoriesApi | updateProductCategoriesByResourceIdOrReference | PATCH /v{version}/product-categories/{resourceIdOrReference} | Update a product category ProductItemsApi | deleteProductItemsByResourceIdOrReference | DELETE /v{version}/product-items/{resourceIdOrReference} | Delete a product item ProductItemsApi | getProductItems | GET /v{version}/product-items | Get a list of all product items ProductItemsApi | getProductItemsByResourceIdOrReference | GET /v{version}/product-items/{resourceIdOrReference} | Get a product item ProductItemsApi | postProductItems | POST /v{version}/product-items | Create a product item ProductItemsApi | postProductItemsActivate | POST /v{version}/product-items/{resourceIdOrReference}/activate | Activate a product item ProductItemsApi | postProductItemsArchive | POST /v{version}/product-items/{resourceIdOrReference}/archive | Archive a product item ProductItemsApi | postProductItemsDeprecate | POST /v{version}/product-items/{resourceIdOrReference}/deprecate | Deprecate a product item ProductItemsApi | postProductItemsSearch | POST /v{version}/product-items/search | Search product items. ProductItemsApi | updateProductItems | PUT /v{version}/product-items | Update or create a product item (upsert) ProductItemsApi | updateProductItemsByResourceIdOrReference | PATCH /v{version}/product-items/{resourceIdOrReference} | Update a product item ProductsApi | deleteProductsByResourceIdOrReference | DELETE /v{version}/products/{resourceIdOrReference} | Delete a product ProductsApi | getProducts | GET /v{version}/products | Get a list of all products ProductsApi | getProductsByResourceIdOrReference | GET /v{version}/products/{resourceIdOrReference} | Get a product ProductsApi | postProducts | POST /v{version}/products | Create a product ProductsApi | postProductsActivate | POST /v{version}/products/{resourceIdOrReference}/activate | Activate a product ProductsApi | postProductsArchive | POST /v{version}/products/{resourceIdOrReference}/archive | Archive a product ProductsApi | postProductsDeprecate | POST /v{version}/products/{resourceIdOrReference}/deprecate | Deprecate a product ProductsApi | postProductsSearch | POST /v{version}/products/search | Search products. ProductsApi | updateProducts | PUT /v{version}/products | Update or create a product (upsert) ProductsApi | updateProductsByResourceIdOrReference | PATCH /v{version}/products/{resourceIdOrReference} | Update a product PromotionCodesApi | getPromotionCodes | GET /v{version}/promotion-codes | Get promotion codes PromotionCodesApi | getPromotionCodesByResourceIdOrReference | GET /v{version}/promotion-codes/{resourceIdOrReference} | Get a promotion code PromotionCodesApi | getPromotionCodesRedemptionsByResourceIdOrReference | GET /v{version}/promotion-codes/{resourceIdOrReference}/redemptions | Get a list of promotion code redemptions PromotionCodesApi | postPromotionCodes | POST /v{version}/promotion-codes | Create a promotion code PromotionCodesApi | postPromotionCodesActivate | POST /v{version}/promotion-codes/{resourceIdOrReference}/activate | Activate a promotion code PromotionCodesApi | postPromotionCodesArchive | POST /v{version}/promotion-codes/{resourceIdOrReference}/archive | Archive a promotion code PromotionCodesApi | postPromotionCodesDeactivate | POST /v{version}/promotion-codes/{resourceIdOrReference}/deactivate | Deactivate a promotion code PromotionCodesApi | postPromotionCodesDeprecate | POST /v{version}/promotion-codes/{resourceIdOrReference}/deprecate | Deprecate a promotion code QuoteVersionsApi | deleteQuoteVersionsByResourceId | DELETE /v{version}/quote-versions/{resourceId} | Delete a quote version QuoteVersionsApi | getQuoteVersions | GET /v{version}/quote-versions | Get a list of all quote versions QuoteVersionsApi | getQuoteVersionsByResourceId | GET /v{version}/quote-versions/{resourceId} | Get a quote version by resource ID QuoteVersionsApi | getQuoteVersionsPdfByResourceId | GET /v{version}/quote-versions/{resourceId}/pdf | Get the quote version as PDF QuoteVersionsApi | postQuoteVersions | POST /v{version}/quote-versions | Create a quote version QuoteVersionsApi | postQuoteVersionsAccept | POST /v{version}/quote-versions/{resourceId}/accept | Accept the quote version QuoteVersionsApi | postQuoteVersionsCreateSubscription | POST /v{version}/quote-versions/{resourceId}/create-subscription | Create the subscription based on a approved quote version QuoteVersionsApi | postQuoteVersionsFinalize | POST /v{version}/quote-versions/{resourceId}/finalize | Finalize the quote version QuoteVersionsApi | postQuoteVersionsReject | POST /v{version}/quote-versions/{resourceId}/reject | Reject the quote version QuoteVersionsApi | postQuoteVersionsRequestSignature | POST /v{version}/quote-versions/{resourceId}/request-signature | Request signature for the quote version QuoteVersionsApi | postQuoteVersionsSend | POST /v{version}/quote-versions/{resourceId}/send | Send the quote version QuoteVersionsApi | updateQuoteVersionsByResourceId | PATCH /v{version}/quote-versions/{resourceId} | Update a quote version QuotesApi | deleteQuotesByResourceId | DELETE /v{version}/quotes/{resourceId} | Delete a quote QuotesApi | getQuotes | GET /v{version}/quotes | Get a list of all quotes QuotesApi | getQuotesApprovalRequests | GET /v{version}/quotes/approval-requests | Get quotes that require approval review by the logged in user QuotesApi | getQuotesByResourceId | GET /v{version}/quotes/{resourceId} | Get a quote by resource ID QuotesApi | postQuotes | POST /v{version}/quotes | Create a quote QuotesApi | postQuotesInit | POST /v{version}/quotes/init | Create a quote pricing plan subscription together with a pricing plan schedule QuotesApi | postQuotesUpgrade | POST /v{version}/quotes/upgrade | Create a quote based on an existing subscription together with a pricing plan schedule QuotesApi | updateQuotesByResourceId | PATCH /v{version}/quotes/{resourceId} | Update a quote ReportConfigurationsApi | getReportConfigurations | GET /v{version}/report-configurations | Get all ReportConfigurations ReportConfigurationsApi | getReportConfigurationsByResourceId | GET /v{version}/report-configurations/{resourceId} | Get ReportConfiguration ReportConfigurationsApi | postReportConfigurations | POST /v{version}/report-configurations | Create a report configuration ReportConfigurationsApi | updateReportConfigurationsByResourceId | PATCH /v{version}/report-configurations/{resourceId} | Update a report configuration ReportDefinitionsApi | getReportDefinitions | GET /v{version}/report-definitions | Get all ReportDefinitions ReportSubscriptionsApi | deleteReportSubscriptionsByResourceId | DELETE /v{version}/report-subscriptions/{resourceId} | Delete ReportSubscription ReportSubscriptionsApi | getReportSubscriptions | GET /v{version}/report-subscriptions | Get all ReportSubscriptions ReportSubscriptionsApi | getReportSubscriptionsByResourceId | GET /v{version}/report-subscriptions/{resourceId} | Get ReportSubscription ReportSubscriptionsApi | postReportSubscriptions | POST /v{version}/report-subscriptions | Create a report subscription ReportSubscriptionsApi | postReportSubscriptionsTrigger | POST /v{version}/report-subscriptions/{resourceId}/trigger | Trigger ReportSubscription by resourceId ReportSubscriptionsApi | updateReportSubscriptionsByResourceId | PATCH /v{version}/report-subscriptions/{reso