From 56907917112b453de790f214aaa601254e1684d9 Mon Sep 17 00:00:00 2001 From: maciej-nedza <76946708+maciej-nedza@users.noreply.github.com> Date: Wed, 21 Aug 2024 11:53:43 +0200 Subject: [PATCH] [DE-932] Release 5.0.0 (#84) * DE-921 DE-922 Fix problem with interval units - interval units now can be nullable in various contexts, ExtendedIntervalUnit was renamed to ExpirationIntervalUnit, now ExpirationIntervalUnit is used in SubscriptionCustomPrice, CreatePrepaidComponentPricePoint, CreateProductPricePoint, CreateOrUpdateProduct, PrepaidComponent, ProductPricePoint and Product for expirationIntervalUnit property. This enum has additional value of never (this has not changed) * DE-921 DE-924 Reworked vaults - CurrentVault enum was renamed to AllVaults and filled with previously missing values. BankAccountVault was filled with missing values. ApplePayVault was added with the vault supporting this payment method. CreditCardVault was added with vaults supporting this payment method. PayPalVault was added with vaults supporting this payment method. Models for respective payment profiles types now use respective enums. * DE-910 Distinguish response payment profiles based on the paymentType. PaymentProfileResponsePaymentProfile was renamed to PaymentProfile.ApplePayPaymentProfile, and PayPalPaymentProfile were added as possible PaymentProfile in PaymentProfileResponse. Fixed a bug, when response payment profile couldn't be deserialized due to missing fields. * Added publicUrlExpires_on to the Invoice * Added achLateReject to the InvoiceRefund * Added tax-related properties to InvoiceTaxComponentBreakout and InvoiceTax * SUB-4037 Add taxIncluded to ComponentCustomPrice. Added request model for Activate Event-Based Component endpoint, SubscriptionComponentActivateEventBasedComponent productFamilyId in endpoint paths parameters is now string, to enable searching by both handle and id * [ON-128] Add salesforceId to Customer models --- .eslintignore | 3 +- README.md | 88 ++++---- doc/client.md | 6 +- doc/controllers/advance-invoice.md | 2 +- doc/controllers/api-exports.md | 3 + doc/controllers/billing-portal.md | 6 +- doc/controllers/component-price-points.md | 22 +- doc/controllers/components.md | 58 ++--- doc/controllers/coupons.md | 47 ++-- doc/controllers/custom-fields.md | 19 +- doc/controllers/customers.md | 23 +- .../events-based-billing-segments.md | 1 + doc/controllers/events.md | 7 +- doc/controllers/insights.md | 6 +- doc/controllers/invoices.md | 74 ++++++- doc/controllers/offers.md | 5 +- doc/controllers/payment-profiles.md | 37 ++-- doc/controllers/product-families.md | 8 +- doc/controllers/product-price-points.md | 24 ++- doc/controllers/products.md | 15 +- doc/controllers/proforma-invoices.md | 2 + doc/controllers/reason-codes.md | 13 +- doc/controllers/referral-codes.md | 2 +- doc/controllers/sales-commissions.md | 10 +- doc/controllers/sites.md | 7 +- doc/controllers/subscription-components.md | 95 +++++--- .../subscription-group-invoice-account.md | 1 + doc/controllers/subscription-groups.md | 7 +- .../subscription-invoice-account.md | 1 + doc/controllers/subscription-notes.md | 9 +- doc/controllers/subscription-products.md | 4 +- doc/controllers/subscription-status.md | 14 +- doc/controllers/subscriptions.md | 79 +++---- doc/controllers/webhooks.md | 19 +- doc/models/activate-event-based-component.md | 44 ++++ doc/models/all-vaults.md | 48 +++++ doc/models/allocation-preview-direction.md | 4 +- doc/models/allocation-preview-item.md | 2 +- .../allocation-preview-line-item-kind.md | 8 +- doc/models/allocation.md | 2 +- doc/models/apple-pay-payment-profile.md | 41 ++++ doc/models/apple-pay-vault.md | 15 ++ doc/models/apply-credit-note-event.md | 1 + doc/models/apply-debit-note-event.md | 1 + doc/models/apply-payment-event.md | 1 + doc/models/auto-invite.md | 4 +- doc/models/backport-invoice-event.md | 2 + doc/models/bank-account-attributes.md | 2 +- doc/models/bank-account-holder-type.md | 4 +- doc/models/bank-account-payment-profile.md | 8 +- doc/models/bank-account-response.md | 4 +- doc/models/bank-account-type.md | 4 +- doc/models/bank-account-vault.md | 15 +- doc/models/basic-date-field.md | 4 +- doc/models/billing-manifest-line-item-kind.md | 12 +- doc/models/cancellation-method.md | 10 +- doc/models/card-type.md | 72 +++---- doc/models/change-chargeback-status-event.md | 1 + .../change-invoice-collection-method-event.md | 1 + .../change-invoice-status-event-data.md | 4 +- doc/models/change-invoice-status-event.md | 1 + doc/models/chargeback-status.md | 8 +- doc/models/cleanup-scope.md | 4 +- doc/models/collection-method.md | 8 +- doc/models/component-custom-price.md | 14 +- doc/models/component-kind.md | 10 +- doc/models/component-price-point-item.md | 2 +- doc/models/component.md | 2 +- doc/models/compounding-strategy.md | 4 +- ...-payment-profile.md => payment-profile.md} | 6 +- doc/models/create-component-price-point.md | 2 +- doc/models/create-credit-note-event.md | 1 + doc/models/create-customer.md | 1 + doc/models/create-debit-note-event.md | 1 + doc/models/create-invoice-status.md | 4 +- doc/models/create-metafield.md | 2 +- doc/models/create-or-update-product.md | 4 +- doc/models/create-payment-profile-request.md | 2 +- doc/models/create-payment-profile.md | 4 +- ...ate-prepaid-usage-component-price-point.md | 2 +- doc/models/create-prepayment-method.md | 16 +- doc/models/create-product-price-point.md | 2 +- .../create-signup-proforma-preview-include.md | 2 +- doc/models/create-subscription.md | 8 +- doc/models/credit-card-payment-profile.md | 6 +- doc/models/credit-card-vault.md | 47 ++++ doc/models/credit-note-status.md | 4 +- doc/models/credit-note.md | 2 +- doc/models/credit-scheme.md | 6 +- doc/models/credit-type.md | 6 +- doc/models/currency-price-role.md | 6 +- doc/models/current-vault.md | 41 ---- doc/models/custom-field-owner.md | 4 +- doc/models/customer-attributes.md | 1 + doc/models/customer.md | 1 + doc/models/debit-note-role.md | 4 +- doc/models/debit-note-status.md | 8 +- doc/models/direction.md | 4 +- doc/models/discount-type.md | 4 +- doc/models/ebb-component.md | 2 +- doc/models/event-type.md | 68 +++--- doc/models/expiration-interval-unit.md | 15 ++ doc/models/extended-interval-unit.md | 15 -- doc/models/failed-payment-action.md | 6 +- doc/models/failed-payment-event.md | 1 + doc/models/first-charge-type.md | 6 +- .../full-subscription-group-response.md | 2 +- .../get-one-time-token-payment-profile.md | 4 +- doc/models/get-one-time-token-request.md | 2 +- doc/models/group-target-type.md | 10 +- doc/models/group-type.md | 4 +- doc/models/include-not-null.md | 2 +- doc/models/include-null-or-not-null.md | 4 +- doc/models/include-option.md | 4 +- doc/models/interval-unit.md | 4 +- doc/models/invoice-consolidation-level.md | 8 +- doc/models/invoice-date-field.md | 10 +- doc/models/invoice-discount-source-type.md | 6 +- doc/models/invoice-discount-type.md | 6 +- doc/models/invoice-event-payment-method.md | 10 +- doc/models/invoice-event-type.md | 30 +-- doc/models/invoice-payment-method-type.md | 12 +- doc/models/invoice-payment-type.md | 8 +- doc/models/invoice-refund.md | 1 + doc/models/invoice-response.md | 1 + doc/models/invoice-role.md | 20 +- doc/models/invoice-sort-field.md | 16 +- doc/models/invoice-status.md | 14 +- doc/models/invoice-tax-component-breakout.md | 13 +- doc/models/invoice-tax.md | 3 + doc/models/invoice.md | 6 +- doc/models/issue-invoice-event-data.md | 6 +- doc/models/issue-invoice-event.md | 1 + doc/models/item-category.md | 10 +- doc/models/line-item-kind.md | 20 +- doc/models/line-item-transaction-type.md | 14 +- .../list-components-price-points-include.md | 2 +- doc/models/list-events-date-field.md | 2 +- doc/models/list-invoices-response.md | 1 + doc/models/list-prepayment-date-field.md | 4 +- doc/models/list-products-include.md | 2 +- .../list-products-price-points-include.md | 2 +- .../list-subscription-components-include.md | 4 +- .../list-subscription-components-sort.md | 4 +- doc/models/metafield-input.md | 8 +- doc/models/metered-component.md | 4 +- doc/models/offer-item.md | 2 +- doc/models/on-off-component.md | 4 +- doc/models/paid-invoice.md | 2 +- doc/models/pay-pal-vault.md | 18 ++ doc/models/payment-profile-attributes.md | 8 +- doc/models/payment-profile-response.md | 16 +- doc/models/payment-type.md | 7 +- doc/models/paypal-payment-profile.md | 42 ++++ doc/models/prepaid-usage-component.md | 4 +- doc/models/prepayment-method.md | 14 +- doc/models/price-point-type.md | 6 +- doc/models/pricing-scheme.md | 8 +- doc/models/product-price-point.md | 2 +- doc/models/product.md | 2 +- .../proforma-invoice-discount-source-type.md | 4 +- doc/models/proforma-invoice-role.md | 8 +- doc/models/proforma-invoice-status.md | 6 +- .../proforma-invoice-tax-source-type.md | 4 +- doc/models/proforma-invoice.md | 2 +- doc/models/quantity-based-component.md | 4 +- doc/models/reactivation-charge.md | 6 +- doc/models/recurring-scheme.md | 6 +- doc/models/refund-invoice-event-data.md | 2 +- doc/models/refund-invoice-event.md | 1 + doc/models/remove-payment-event.md | 1 + doc/models/resent-invitation.md | 4 + doc/models/resource-type.md | 4 +- doc/models/restriction-type.md | 4 +- doc/models/resumption-charge.md | 6 +- doc/models/service-credit-type.md | 4 +- doc/models/snap-day.md | 2 +- doc/models/sorting-direction.md | 4 +- .../subscription-component-subscription.md | 2 +- doc/models/subscription-component.md | 2 +- doc/models/subscription-custom-price.md | 4 +- doc/models/subscription-date-field.md | 18 +- doc/models/subscription-group-bank-account.md | 2 +- ...bscription-group-component-custom-price.md | 1 + doc/models/subscription-group-credit-card.md | 2 +- doc/models/subscription-group-include.md | 2 +- .../subscription-group-prepayment-method.md | 12 +- .../subscription-group-signup-component.md | 3 + .../subscription-group-signup-response.md | 2 +- .../subscription-groups-list-include.md | 2 +- doc/models/subscription-include.md | 4 +- doc/models/subscription-list-date-field.md | 2 +- doc/models/subscription-list-include.md | 2 +- doc/models/subscription-purge-type.md | 4 +- doc/models/subscription-sort.md | 12 +- doc/models/subscription-state-filter.md | 24 +-- doc/models/subscription-state.md | 38 ++-- doc/models/subscription.md | 2 +- doc/models/tax-configuration-kind.md | 8 +- doc/models/tax-configuration.md | 2 +- doc/models/tax-destination-address.md | 8 +- doc/models/update-component-price-point.md | 2 +- doc/models/update-customer.md | 1 + doc/models/update-payment-profile.md | 2 +- doc/models/update-subscription-component.md | 1 + doc/models/void-invoice-event.md | 1 + doc/models/void-remainder-event.md | 1 + doc/models/webhook-order.md | 4 +- doc/models/webhook-status.md | 8 +- doc/models/webhook-subscription.md | 70 +++--- e2e/src/componentsController.spec.ts | 2 +- e2e/src/couponsController.spec.ts | 2 +- e2e/src/utils/components.ts | 2 +- jest.config.js | 6 +- package.json | 16 +- pnpm-lock.yaml | 46 ++-- src/authProvider.ts | 2 +- src/authentication.ts | 2 +- src/client.ts | 10 +- src/clientAdapter.ts | 2 +- src/clientInterface.ts | 2 +- src/configuration.ts | 2 +- src/controllers/aPIExportsController.ts | 2 +- src/controllers/advanceInvoiceController.ts | 9 +- src/controllers/baseController.ts | 2 +- src/controllers/billingPortalController.ts | 10 +- .../componentPricePointsController.ts | 27 +-- src/controllers/componentsController.ts | 84 ++++---- src/controllers/couponsController.ts | 66 +++--- src/controllers/customFieldsController.ts | 55 ++--- src/controllers/customersController.ts | 34 +-- .../eventsBasedBillingSegmentsController.ts | 2 +- src/controllers/eventsController.ts | 10 +- src/controllers/insightsController.ts | 12 +- src/controllers/invoicesController.ts | 12 +- src/controllers/offersController.ts | 8 +- src/controllers/paymentProfilesController.ts | 65 +++--- src/controllers/productFamiliesController.ts | 12 +- .../productPricePointsController.ts | 24 ++- src/controllers/productsController.ts | 20 +- src/controllers/proformaInvoicesController.ts | 2 +- src/controllers/reasonCodesController.ts | 17 +- src/controllers/referralCodesController.ts | 6 +- src/controllers/salesCommissionsController.ts | 10 +- src/controllers/sitesController.ts | 13 +- .../subscriptionComponentsController.ts | 140 ++++++------ ...bscriptionGroupInvoiceAccountController.ts | 2 +- .../subscriptionGroupStatusController.ts | 2 +- .../subscriptionGroupsController.ts | 21 +- .../subscriptionInvoiceAccountController.ts | 2 +- .../subscriptionNotesController.ts | 12 +- .../subscriptionProductsController.ts | 15 +- .../subscriptionStatusController.ts | 28 +-- src/controllers/subscriptionsController.ts | 203 +++++++++--------- src/controllers/webhooksController.ts | 37 ++-- src/core.ts | 2 +- src/defaultConfiguration.ts | 2 +- src/errors/componentAllocationError.ts | 2 +- src/errors/componentPricePointError.ts | 2 +- src/errors/customerErrorResponseError.ts | 2 +- src/errors/errorArrayMapResponseError.ts | 2 +- src/errors/errorListResponseError.ts | 2 +- src/errors/errorStringMapResponseError.ts | 2 +- ...ventBasedBillingListSegmentsErrorsError.ts | 2 +- src/errors/eventBasedBillingSegmentError.ts | 2 +- .../eventBasedBillingSegmentErrorsError.ts | 2 +- .../productPricePointErrorResponseError.ts | 2 +- .../proformaBadRequestErrorResponseError.ts | 2 +- ...refundPrepaymentBaseErrorsResponseError.ts | 2 +- src/errors/singleErrorResponseError.ts | 2 +- src/errors/singleStringErrorResponseError.ts | 2 +- src/errors/subscriptionAddCouponError.ts | 2 +- .../subscriptionComponentAllocationError.ts | 2 +- ...bscriptionGroupCreateErrorResponseError.ts | 2 +- ...bscriptionGroupSignupErrorResponseError.ts | 2 +- ...bscriptionGroupUpdateErrorResponseError.ts | 2 +- .../subscriptionRemoveCouponErrorsError.ts | 2 +- .../subscriptionsMrrErrorResponseError.ts | 2 +- .../tooManyManagementLinkRequestsError.ts | 2 +- src/index.ts | 14 +- src/models/aCHAgreement.ts | 2 +- src/models/accountBalance.ts | 2 +- src/models/accountBalances.ts | 2 +- src/models/activateEventBasedComponent.ts | 36 ++++ src/models/activateSubscriptionRequest.ts | 2 +- src/models/addCouponsRequest.ts | 2 +- src/models/addSubscriptionToAGroup.ts | 2 +- src/models/addressChange.ts | 2 +- src/models/agreementAcceptance.ts | 2 +- src/models/{currentVault.ts => allVaults.ts} | 21 +- src/models/allocateComponents.ts | 2 +- src/models/allocation.ts | 6 +- src/models/allocationExpirationDate.ts | 2 +- src/models/allocationPreview.ts | 2 +- src/models/allocationPreviewDirection.ts | 2 +- src/models/allocationPreviewItem.ts | 6 +- src/models/allocationPreviewLineItem.ts | 2 +- src/models/allocationPreviewLineItemKind.ts | 2 +- src/models/allocationPreviewResponse.ts | 2 +- src/models/allocationResponse.ts | 2 +- src/models/allocationSettings.ts | 2 +- src/models/applePayPaymentProfile.ts | 72 +++++++ src/models/applePayVault.ts | 21 ++ src/models/appliedCreditNoteData.ts | 2 +- src/models/applyCreditNoteEvent.ts | 2 +- src/models/applyCreditNoteEventData.ts | 2 +- src/models/applyDebitNoteEvent.ts | 2 +- src/models/applyDebitNoteEventData.ts | 2 +- src/models/applyPaymentEvent.ts | 2 +- src/models/applyPaymentEventData.ts | 2 +- src/models/attributeError.ts | 2 +- src/models/autoInvite.ts | 2 +- src/models/autoResume.ts | 2 +- src/models/backportInvoiceEvent.ts | 2 +- src/models/bankAccountAttributes.ts | 4 +- src/models/bankAccountHolderType.ts | 2 +- src/models/bankAccountPaymentProfile.ts | 12 +- src/models/bankAccountResponse.ts | 2 +- src/models/bankAccountType.ts | 2 +- src/models/bankAccountVault.ts | 11 +- src/models/bankAccountVerification.ts | 2 +- src/models/bankAccountVerificationRequest.ts | 2 +- src/models/baseRefundError.ts | 2 +- src/models/baseStringError.ts | 2 +- src/models/basicDateField.ts | 2 +- src/models/batchJob.ts | 2 +- src/models/batchJobResponse.ts | 2 +- src/models/billingManifest.ts | 2 +- src/models/billingManifestItem.ts | 2 +- src/models/billingManifestLineItemKind.ts | 2 +- src/models/billingSchedule.ts | 2 +- src/models/breakouts.ts | 2 +- .../bulkComponentsPricePointAssignment.ts | 2 +- .../bulkCreateProductPricePointsRequest.ts | 2 +- .../bulkCreateProductPricePointsResponse.ts | 2 +- src/models/bulkCreateSegments.ts | 2 +- src/models/bulkUpdateSegments.ts | 2 +- src/models/bulkUpdateSegmentsItem.ts | 2 +- src/models/calendarBilling.ts | 2 +- .../cancelGroupedSubscriptionsRequest.ts | 2 +- src/models/cancellationMethod.ts | 2 +- src/models/cancellationOptions.ts | 2 +- src/models/cancellationRequest.ts | 2 +- src/models/cardType.ts | 2 +- src/models/changeChargebackStatusEvent.ts | 2 +- src/models/changeChargebackStatusEventData.ts | 2 +- .../changeInvoiceCollectionMethodEvent.ts | 2 +- .../changeInvoiceCollectionMethodEventData.ts | 2 +- src/models/changeInvoiceStatusEvent.ts | 2 +- src/models/changeInvoiceStatusEventData.ts | 6 +- src/models/chargebackStatus.ts | 2 +- src/models/chargifyEBB.ts | 2 +- src/models/cleanupScope.ts | 2 +- src/models/collectionMethod.ts | 2 +- src/models/component.ts | 6 +- src/models/componentAllocationChange.ts | 2 +- src/models/componentAllocationErrorItem.ts | 2 +- src/models/componentCostData.ts | 2 +- src/models/componentCostDataRateTier.ts | 2 +- src/models/componentCurrencyPrice.ts | 2 +- src/models/componentCurrencyPricesResponse.ts | 2 +- src/models/componentCustomPrice.ts | 15 +- src/models/componentKind.ts | 2 +- src/models/componentPrice.ts | 2 +- src/models/componentPricePoint.ts | 2 +- src/models/componentPricePointAssignment.ts | 2 +- src/models/componentPricePointErrorItem.ts | 2 +- src/models/componentPricePointItem.ts | 7 +- src/models/componentPricePointResponse.ts | 2 +- src/models/componentPricePointsResponse.ts | 2 +- src/models/componentResponse.ts | 2 +- src/models/compoundingStrategy.ts | 2 +- src/models/consolidatedInvoice.ts | 2 +- .../addSubscriptionToAGroupGroup.ts | 2 +- .../allocationPreviewItemPreviousQuantity.ts | 2 +- .../allocationPreviewItemQuantity.ts | 2 +- .../containers/allocationPreviousQuantity.ts | 2 +- src/models/containers/allocationQuantity.ts | 2 +- .../archiveComponentPricePointComponentId.ts | 2 +- .../archiveComponentPricePointPricePointId.ts | 2 +- .../archiveProductPricePointPricePointId.ts | 2 +- .../archiveProductPricePointProductId.ts | 2 +- .../containers/calendarBillingSnapDay.ts | 2 +- ...ponentAllocationChangeAllocatedQuantity.ts | 2 +- ...componentPricePointAssignmentPricePoint.ts | 2 +- .../createAllocationPricePointId.ts | 2 +- ...ateComponentPricePointRequestPricePoint.ts | 2 +- ...eComponentPricePointsRequestPricePoints.ts | 2 +- .../containers/createInvoiceCouponAmount.ts | 2 +- .../createInvoiceCouponPercentage.ts | 2 +- .../createInvoiceCouponProductFamilyId.ts | 2 +- .../createInvoiceItemComponentId.ts | 2 +- .../createInvoiceItemPricePointId.ts | 2 +- .../containers/createInvoiceItemProductId.ts | 2 +- .../createInvoiceItemProductPricePointId.ts | 2 +- .../containers/createInvoiceItemQuantity.ts | 2 +- .../containers/createInvoiceItemUnitPrice.ts | 2 +- .../containers/createInvoicePaymentAmount.ts | 2 +- .../createMetafieldsRequestMetafields.ts | 2 +- .../createMultiInvoicePaymentAmount.ts | 2 +- .../containers/createOrUpdateCouponCoupon.ts | 2 +- ...reateOrUpdatePercentageCouponPercentage.ts | 2 +- .../createOrUpdateSegmentPriceUnitPrice.ts | 2 +- .../createPaymentProfileExpirationMonth.ts | 2 +- .../createPaymentProfileExpirationYear.ts | 2 +- .../createProductPricePointProductId.ts | 2 +- .../createSegmentSegmentProperty1Value.ts | 2 +- .../createSegmentSegmentProperty2Value.ts | 2 +- .../createSegmentSegmentProperty3Value.ts | 2 +- .../createSegmentSegmentProperty4Value.ts | 2 +- ...eSubscriptionComponentAllocatedQuantity.ts | 2 +- .../createSubscriptionComponentComponentId.ts | 2 +- ...createSubscriptionComponentPricePointId.ts | 2 +- .../containers/createSubscriptionOfferId.ts | 2 +- .../containers/createUsageComponentId.ts | 2 +- .../containers/customerErrorResponseErrors.ts | 2 +- .../containers/deductServiceCreditAmount.ts | 2 +- .../containers/eBBComponentUnitPrice.ts | 2 +- .../containers/eventEventSpecificData.ts | 2 +- src/models/containers/invoiceEvent.ts | 2 +- src/models/containers/invoiceEventPayment.ts | 2 +- .../containers/issueServiceCreditAmount.ts | 2 +- .../listProductPricePointsInputProductId.ts | 2 +- .../containers/listUsagesInputComponentId.ts | 2 +- src/models/containers/metafieldEnum.ts | 2 +- .../containers/meteredComponentUnitPrice.ts | 2 +- .../containers/onOffComponentUnitPrice.ts | 2 +- src/models/containers/paymentProfile.ts | 107 +++++++++ ...paymentProfileAttributesExpirationMonth.ts | 2 +- .../paymentProfileAttributesExpirationYear.ts | 2 +- .../paymentProfileResponsePaymentProfile.ts | 56 ----- .../prepaidUsageComponentUnitPrice.ts | 2 +- src/models/containers/priceEndingQuantity.ts | 2 +- .../containers/priceStartingQuantity.ts | 2 +- src/models/containers/priceUnitPrice.ts | 2 +- .../quantityBasedComponentUnitPrice.ts | 2 +- .../reactivateSubscriptionRequestResume.ts | 2 +- .../readComponentPricePointComponentId.ts | 2 +- .../readComponentPricePointPricePointId.ts | 2 +- .../readProductPricePointPricePointId.ts | 2 +- .../readProductPricePointProductId.ts | 2 +- .../refundConsolidatedInvoiceSegmentUids.ts | 2 +- .../containers/refundInvoiceRequestRefund.ts | 2 +- .../containers/refundPrepaymentAmount.ts | 2 +- .../renewalPreviewComponentComponentId.ts | 2 +- .../renewalPreviewComponentPricePointId.ts | 2 +- .../segmentSegmentProperty1Value.ts | 2 +- .../segmentSegmentProperty2Value.ts | 2 +- .../segmentSegmentProperty3Value.ts | 2 +- .../segmentSegmentProperty4Value.ts | 2 +- .../subscriptionComponentAllocatedQuantity.ts | 2 +- ...bscriptionCustomPriceExpirationInterval.ts | 2 +- ...criptionCustomPriceInitialChargeInCents.ts | 2 +- .../subscriptionCustomPriceInterval.ts | 2 +- .../subscriptionCustomPricePriceInCents.ts | 2 +- .../subscriptionCustomPriceTrialInterval.ts | 2 +- ...ubscriptionCustomPriceTrialPriceInCents.ts | 2 +- ...scriptionGroupCreateErrorResponseErrors.ts | 2 +- ...scriptionGroupCreditCardExpirationMonth.ts | 2 +- ...bscriptionGroupCreditCardExpirationYear.ts | 2 +- .../subscriptionGroupCreditCardFullNumber.ts | 2 +- ...onGroupSignupComponentAllocatedQuantity.ts | 2 +- ...criptionGroupSignupComponentComponentId.ts | 2 +- ...riptionGroupSignupComponentPricePointId.ts | 2 +- ...criptionGroupSignupComponentUnitBalance.ts | 2 +- .../updateComponentPricePointComponentId.ts | 2 +- .../updateComponentPricePointPricePointId.ts | 2 +- .../updateMetafieldsRequestMetafields.ts | 2 +- .../containers/updatePriceEndingQuantity.ts | 2 +- .../containers/updatePriceStartingQuantity.ts | 2 +- src/models/containers/updatePriceUnitPrice.ts | 2 +- .../updateProductPricePointPricePointId.ts | 2 +- .../updateProductPricePointProductId.ts | 2 +- .../containers/updateSubscriptionNetTerms.ts | 2 +- .../containers/updateSubscriptionSnapDay.ts | 2 +- src/models/containers/usageQuantity.ts | 2 +- src/models/countResponse.ts | 2 +- src/models/coupon.ts | 2 +- src/models/couponCurrency.ts | 2 +- src/models/couponCurrencyRequest.ts | 2 +- src/models/couponCurrencyResponse.ts | 2 +- src/models/couponResponse.ts | 2 +- src/models/couponRestriction.ts | 2 +- src/models/couponSubcodes.ts | 2 +- src/models/couponSubcodesResponse.ts | 2 +- src/models/couponUsage.ts | 2 +- src/models/createAllocation.ts | 2 +- src/models/createAllocationRequest.ts | 2 +- src/models/createComponentPricePoint.ts | 7 +- .../createComponentPricePointRequest.ts | 2 +- .../createComponentPricePointsRequest.ts | 2 +- src/models/createCreditNoteEvent.ts | 2 +- src/models/createCurrencyPrice.ts | 2 +- src/models/createCurrencyPricesRequest.ts | 2 +- src/models/createCustomer.ts | 5 +- src/models/createCustomerRequest.ts | 2 +- src/models/createDebitNoteEvent.ts | 2 +- src/models/createEBBComponent.ts | 2 +- src/models/createInvoice.ts | 2 +- src/models/createInvoiceAddress.ts | 2 +- src/models/createInvoiceCoupon.ts | 2 +- src/models/createInvoiceItem.ts | 2 +- src/models/createInvoicePayment.ts | 2 +- src/models/createInvoicePaymentApplication.ts | 2 +- src/models/createInvoicePaymentRequest.ts | 2 +- src/models/createInvoiceRequest.ts | 2 +- src/models/createInvoiceStatus.ts | 2 +- src/models/createMetadata.ts | 2 +- src/models/createMetadataRequest.ts | 2 +- src/models/createMetafield.ts | 4 +- src/models/createMetafieldsRequest.ts | 2 +- src/models/createMeteredComponent.ts | 2 +- src/models/createMultiInvoicePayment.ts | 2 +- .../createMultiInvoicePaymentRequest.ts | 2 +- src/models/createOffer.ts | 2 +- src/models/createOfferComponent.ts | 2 +- src/models/createOfferRequest.ts | 2 +- src/models/createOnOffComponent.ts | 2 +- src/models/createOrUpdateCoupon.ts | 2 +- src/models/createOrUpdateEndpoint.ts | 2 +- src/models/createOrUpdateEndpointRequest.ts | 2 +- src/models/createOrUpdateFlatAmountCoupon.ts | 2 +- src/models/createOrUpdatePercentageCoupon.ts | 2 +- src/models/createOrUpdateProduct.ts | 20 +- src/models/createOrUpdateProductRequest.ts | 2 +- src/models/createOrUpdateSegmentPrice.ts | 2 +- src/models/createPayment.ts | 2 +- src/models/createPaymentProfile.ts | 8 +- src/models/createPaymentProfileRequest.ts | 2 +- src/models/createPrepaidComponent.ts | 2 +- .../createPrepaidUsageComponentPricePoint.ts | 13 +- src/models/createPrepayment.ts | 2 +- src/models/createPrepaymentMethod.ts | 2 +- src/models/createPrepaymentRequest.ts | 2 +- src/models/createPrepaymentResponse.ts | 2 +- src/models/createProductCurrencyPrice.ts | 2 +- .../createProductCurrencyPricesRequest.ts | 2 +- src/models/createProductFamily.ts | 2 +- src/models/createProductFamilyRequest.ts | 2 +- src/models/createProductPricePoint.ts | 13 +- src/models/createProductPricePointRequest.ts | 2 +- src/models/createQuantityBasedComponent.ts | 2 +- src/models/createReasonCode.ts | 2 +- src/models/createReasonCodeRequest.ts | 2 +- src/models/createSegment.ts | 2 +- src/models/createSegmentRequest.ts | 2 +- .../createSignupProformaPreviewInclude.ts | 2 +- src/models/createSubscription.ts | 10 +- src/models/createSubscriptionComponent.ts | 2 +- src/models/createSubscriptionGroup.ts | 2 +- src/models/createSubscriptionGroupRequest.ts | 2 +- src/models/createSubscriptionRequest.ts | 2 +- src/models/createUsage.ts | 2 +- src/models/createUsageRequest.ts | 2 +- src/models/createdPrepayment.ts | 2 +- src/models/creditAccountBalanceChanged.ts | 2 +- src/models/creditCardAttributes.ts | 2 +- src/models/creditCardPaymentProfile.ts | 16 +- src/models/creditCardVault.ts | 53 +++++ src/models/creditNote.ts | 4 +- src/models/creditNoteApplication.ts | 2 +- src/models/creditNoteLineItem.ts | 2 +- src/models/creditNoteStatus.ts | 2 +- src/models/creditScheme.ts | 2 +- src/models/creditSchemeRequest.ts | 2 +- src/models/creditType.ts | 2 +- src/models/currencyPrice.ts | 2 +- src/models/currencyPriceRole.ts | 2 +- src/models/currencyPricesResponse.ts | 2 +- src/models/customFieldOwner.ts | 2 +- src/models/customFieldValueChange.ts | 2 +- src/models/customer.ts | 5 +- src/models/customerAttributes.ts | 5 +- src/models/customerChange.ts | 2 +- src/models/customerChangesPreviewResponse.ts | 2 +- src/models/customerCustomFieldsChange.ts | 2 +- src/models/customerError.ts | 2 +- src/models/customerPayerChange.ts | 2 +- src/models/customerResponse.ts | 2 +- src/models/debitNote.ts | 2 +- src/models/debitNoteRole.ts | 2 +- src/models/debitNoteStatus.ts | 2 +- src/models/deductServiceCredit.ts | 2 +- src/models/deductServiceCreditRequest.ts | 2 +- src/models/delayedCancellationResponse.ts | 2 +- src/models/deleteSubscriptionGroupResponse.ts | 2 +- src/models/direction.ts | 2 +- src/models/discountType.ts | 2 +- src/models/dunnerData.ts | 2 +- src/models/dunningStepData.ts | 2 +- src/models/dunningStepReached.ts | 2 +- src/models/eBBComponent.ts | 6 +- src/models/eBBEvent.ts | 2 +- src/models/enableWebhooksRequest.ts | 2 +- src/models/enableWebhooksResponse.ts | 2 +- src/models/endpoint.ts | 2 +- src/models/endpointResponse.ts | 2 +- src/models/errors.ts | 2 +- src/models/event.ts | 2 +- src/models/eventBasedBillingSegmentError.ts | 2 +- src/models/eventResponse.ts | 2 +- src/models/eventType.ts | 2 +- src/models/expirationIntervalUnit.ts | 23 ++ src/models/extendedIntervalUnit.ts | 23 -- src/models/failedPaymentAction.ts | 2 +- src/models/failedPaymentEvent.ts | 2 +- src/models/failedPaymentEventData.ts | 2 +- src/models/firstChargeType.ts | 2 +- src/models/fullSubscriptionGroupResponse.ts | 10 +- src/models/getOneTimeTokenPaymentProfile.ts | 8 +- src/models/getOneTimeTokenRequest.ts | 2 +- src/models/groupBilling.ts | 2 +- src/models/groupSettings.ts | 2 +- src/models/groupTarget.ts | 2 +- src/models/groupTargetType.ts | 2 +- src/models/groupType.ts | 2 +- src/models/historicUsage.ts | 2 +- src/models/includeNotNull.ts | 2 +- src/models/includeNullOrNotNull.ts | 2 +- src/models/includeOption.ts | 2 +- src/models/intervalUnit.ts | 2 +- src/models/invoice.ts | 9 +- src/models/invoiceAddress.ts | 2 +- src/models/invoiceBalanceItem.ts | 2 +- src/models/invoiceConsolidationLevel.ts | 2 +- src/models/invoiceCredit.ts | 2 +- src/models/invoiceCustomField.ts | 2 +- src/models/invoiceCustomer.ts | 2 +- src/models/invoiceDateField.ts | 2 +- src/models/invoiceDiscount.ts | 2 +- src/models/invoiceDiscountBreakout.ts | 2 +- src/models/invoiceDiscountSourceType.ts | 2 +- src/models/invoiceDiscountType.ts | 2 +- src/models/invoiceDisplaySettings.ts | 2 +- src/models/invoiceEventPaymentMethod.ts | 2 +- src/models/invoiceEventType.ts | 2 +- src/models/invoiceIssued.ts | 2 +- src/models/invoiceLineItem.ts | 2 +- .../invoiceLineItemComponentCostData.ts | 2 +- src/models/invoiceLineItemEventData.ts | 2 +- src/models/invoiceLineItemPricingDetail.ts | 2 +- src/models/invoicePayer.ts | 2 +- src/models/invoicePayerChange.ts | 2 +- src/models/invoicePayment.ts | 2 +- src/models/invoicePaymentApplication.ts | 2 +- src/models/invoicePaymentMethod.ts | 2 +- src/models/invoicePaymentMethodType.ts | 2 +- src/models/invoicePaymentType.ts | 2 +- src/models/invoicePrePayment.ts | 2 +- src/models/invoicePreviousBalance.ts | 2 +- src/models/invoiceRefund.ts | 5 +- src/models/invoiceResponse.ts | 2 +- src/models/invoiceRole.ts | 2 +- src/models/invoiceSeller.ts | 2 +- src/models/invoiceSortField.ts | 2 +- src/models/invoiceStatus.ts | 2 +- src/models/invoiceTax.ts | 9 +- src/models/invoiceTaxBreakout.ts | 2 +- src/models/invoiceTaxComponentBreakout.ts | 22 +- src/models/issueAdvanceInvoiceRequest.ts | 2 +- src/models/issueInvoiceEvent.ts | 2 +- src/models/issueInvoiceEventData.ts | 8 +- src/models/issueInvoiceRequest.ts | 2 +- src/models/issueServiceCredit.ts | 2 +- src/models/issueServiceCreditRequest.ts | 2 +- src/models/itemCategory.ts | 2 +- src/models/itemPricePointChanged.ts | 2 +- src/models/itemPricePointData.ts | 2 +- src/models/lineItemKind.ts | 2 +- src/models/lineItemTransactionType.ts | 2 +- src/models/listComponentsFilter.ts | 2 +- .../listComponentsPricePointsInclude.ts | 2 +- .../listComponentsPricePointsResponse.ts | 2 +- src/models/listCouponsFilter.ts | 2 +- src/models/listCreditNotesResponse.ts | 2 +- src/models/listEventsDateField.ts | 2 +- src/models/listInvoiceEventsResponse.ts | 2 +- src/models/listInvoicesResponse.ts | 2 +- src/models/listMRRResponse.ts | 2 +- src/models/listMRRResponseResult.ts | 2 +- src/models/listMetafieldsResponse.ts | 2 +- src/models/listMrrFilter.ts | 2 +- src/models/listOffersResponse.ts | 2 +- src/models/listPrepaymentDateField.ts | 2 +- src/models/listPrepaymentsFilter.ts | 2 +- src/models/listPricePointsFilter.ts | 2 +- src/models/listProductPricePointsResponse.ts | 2 +- src/models/listProductsFilter.ts | 2 +- src/models/listProductsInclude.ts | 2 +- src/models/listProductsPricePointsInclude.ts | 2 +- src/models/listProformaInvoicesMeta.ts | 2 +- src/models/listProformaInvoicesResponse.ts | 2 +- src/models/listPublicKeysMeta.ts | 2 +- src/models/listPublicKeysResponse.ts | 2 +- src/models/listSaleRepItem.ts | 2 +- src/models/listSegmentsFilter.ts | 2 +- src/models/listSegmentsResponse.ts | 2 +- .../listSubcriptionGroupPrepaymentItem.ts | 2 +- .../listSubscriptionComponentsFilter.ts | 2 +- ...listSubscriptionComponentsForSiteFilter.ts | 2 +- .../listSubscriptionComponentsInclude.ts | 2 +- .../listSubscriptionComponentsResponse.ts | 2 +- src/models/listSubscriptionComponentsSort.ts | 2 +- src/models/listSubscriptionGroupPrepayment.ts | 2 +- ...listSubscriptionGroupPrepaymentResponse.ts | 2 +- src/models/listSubscriptionGroupsItem.ts | 2 +- src/models/listSubscriptionGroupsMeta.ts | 2 +- src/models/listSubscriptionGroupsResponse.ts | 2 +- src/models/mRR.ts | 2 +- src/models/mRRMovement.ts | 2 +- src/models/mRRResponse.ts | 2 +- src/models/metadata.ts | 2 +- src/models/metafield.ts | 2 +- src/models/metafieldInput.ts | 2 +- src/models/metafieldScope.ts | 2 +- src/models/meteredComponent.ts | 8 +- src/models/meteredUsage.ts | 2 +- src/models/movement.ts | 2 +- src/models/movementLineItem.ts | 2 +- src/models/multiInvoicePayment.ts | 2 +- src/models/multiInvoicePaymentResponse.ts | 2 +- src/models/nestedSubscriptionGroup.ts | 2 +- src/models/netTerms.ts | 2 +- src/models/offer.ts | 2 +- src/models/offerDiscount.ts | 2 +- src/models/offerItem.ts | 7 +- src/models/offerResponse.ts | 2 +- src/models/offerSignupPage.ts | 2 +- src/models/onOffComponent.ts | 8 +- src/models/organizationAddress.ts | 2 +- src/models/originInvoice.ts | 2 +- src/models/overagePricing.ts | 2 +- src/models/overrideSubscription.ts | 2 +- src/models/overrideSubscriptionRequest.ts | 2 +- src/models/paginatedMetadata.ts | 2 +- src/models/paidInvoice.ts | 4 +- src/models/pauseRequest.ts | 2 +- src/models/payPalVault.ts | 22 ++ src/models/payerAttributes.ts | 2 +- src/models/payerError.ts | 2 +- src/models/paymentCollectionMethodChanged.ts | 2 +- src/models/paymentForAllocation.ts | 2 +- src/models/paymentMethodApplePay.ts | 2 +- src/models/paymentMethodBankAccount.ts | 2 +- src/models/paymentMethodCreditCard.ts | 2 +- src/models/paymentMethodExternal.ts | 2 +- src/models/paymentMethodPaypal.ts | 2 +- src/models/paymentProfileAttributes.ts | 15 +- src/models/paymentProfileResponse.ts | 17 +- src/models/paymentRelatedEvents.ts | 2 +- src/models/paymentType.ts | 3 +- src/models/paypalPaymentProfile.ts | 74 +++++++ src/models/pendingCancellationChange.ts | 2 +- src/models/portalManagementLink.ts | 2 +- src/models/prepaidComponentPricePoint.ts | 2 +- src/models/prepaidConfiguration.ts | 2 +- src/models/prepaidConfigurationResponse.ts | 2 +- src/models/prepaidProductPricePointFilter.ts | 2 +- .../prepaidSubscriptionBalanceChanged.ts | 2 +- src/models/prepaidUsage.ts | 2 +- src/models/prepaidUsageAllocationDetail.ts | 2 +- src/models/prepaidUsageComponent.ts | 13 +- src/models/prepayment.ts | 2 +- src/models/prepaymentAccountBalanceChanged.ts | 2 +- src/models/prepaymentMethod.ts | 2 +- src/models/prepaymentResponse.ts | 2 +- src/models/prepaymentsResponse.ts | 2 +- src/models/previewAllocationsRequest.ts | 2 +- src/models/price.ts | 2 +- src/models/pricePointType.ts | 2 +- src/models/pricingScheme.ts | 2 +- src/models/product.ts | 14 +- src/models/productFamily.ts | 2 +- src/models/productFamilyResponse.ts | 2 +- src/models/productPricePoint.ts | 12 +- src/models/productPricePointErrors.ts | 2 +- src/models/productPricePointResponse.ts | 2 +- src/models/productResponse.ts | 2 +- src/models/proformaError.ts | 2 +- src/models/proformaInvoice.ts | 4 +- src/models/proformaInvoiceCredit.ts | 2 +- src/models/proformaInvoiceDiscount.ts | 2 +- .../proformaInvoiceDiscountSourceType.ts | 2 +- src/models/proformaInvoiceIssued.ts | 2 +- src/models/proformaInvoicePayment.ts | 2 +- src/models/proformaInvoiceRole.ts | 2 +- src/models/proformaInvoiceStatus.ts | 2 +- src/models/proformaInvoiceTax.ts | 2 +- src/models/proformaInvoiceTaxSourceType.ts | 2 +- src/models/proration.ts | 2 +- src/models/publicKey.ts | 2 +- src/models/publicSignupPage.ts | 2 +- src/models/quantityBasedComponent.ts | 8 +- .../reactivateSubscriptionGroupRequest.ts | 2 +- .../reactivateSubscriptionGroupResponse.ts | 2 +- src/models/reactivateSubscriptionRequest.ts | 2 +- src/models/reactivationBilling.ts | 2 +- src/models/reactivationCharge.ts | 2 +- src/models/reasonCode.ts | 2 +- src/models/reasonCodeResponse.ts | 2 +- src/models/reasonCodesJsonResponse.ts | 2 +- src/models/recordPaymentRequest.ts | 2 +- src/models/recordPaymentResponse.ts | 2 +- src/models/recurringScheme.ts | 2 +- src/models/referralCode.ts | 2 +- src/models/referralValidationResponse.ts | 2 +- src/models/refundConsolidatedInvoice.ts | 2 +- src/models/refundInvoice.ts | 2 +- src/models/refundInvoiceEvent.ts | 2 +- src/models/refundInvoiceEventData.ts | 4 +- src/models/refundInvoiceRequest.ts | 2 +- src/models/refundPrepayment.ts | 2 +- src/models/refundPrepaymentBaseRefundError.ts | 2 +- src/models/refundPrepaymentRequest.ts | 2 +- src/models/refundSuccess.ts | 2 +- src/models/removePaymentEvent.ts | 2 +- src/models/removePaymentEventData.ts | 2 +- src/models/renewalPreview.ts | 2 +- src/models/renewalPreviewComponent.ts | 2 +- src/models/renewalPreviewLineItem.ts | 2 +- src/models/renewalPreviewRequest.ts | 2 +- src/models/renewalPreviewResponse.ts | 2 +- src/models/replayWebhooksRequest.ts | 2 +- src/models/replayWebhooksResponse.ts | 2 +- src/models/resentInvitation.ts | 6 +- src/models/resourceType.ts | 2 +- src/models/restrictionType.ts | 2 +- src/models/resumeOptions.ts | 2 +- src/models/resumptionCharge.ts | 2 +- src/models/revokedInvitation.ts | 2 +- src/models/saleRep.ts | 2 +- src/models/saleRepItemMrr.ts | 2 +- src/models/saleRepSettings.ts | 2 +- src/models/saleRepSubscription.ts | 2 +- src/models/segment.ts | 2 +- src/models/segmentPrice.ts | 2 +- src/models/segmentResponse.ts | 2 +- src/models/sendInvoiceRequest.ts | 2 +- src/models/serviceCredit.ts | 2 +- src/models/serviceCreditResponse.ts | 2 +- src/models/serviceCreditType.ts | 2 +- src/models/signupProformaPreview.ts | 2 +- src/models/signupProformaPreviewResponse.ts | 2 +- src/models/site.ts | 2 +- src/models/siteResponse.ts | 2 +- src/models/siteStatistics.ts | 2 +- src/models/siteSummary.ts | 2 +- src/models/snapDay.ts | 2 +- src/models/sortingDirection.ts | 2 +- src/models/subscription.ts | 10 +- src/models/subscriptionComponent.ts | 6 +- ...ubscriptionComponentAllocationErrorItem.ts | 2 +- src/models/subscriptionComponentResponse.ts | 2 +- .../subscriptionComponentSubscription.ts | 10 +- src/models/subscriptionCustomPrice.ts | 23 +- src/models/subscriptionDateField.ts | 2 +- src/models/subscriptionFilter.ts | 2 +- src/models/subscriptionGroup.ts | 2 +- src/models/subscriptionGroupBalances.ts | 2 +- src/models/subscriptionGroupBankAccount.ts | 4 +- .../subscriptionGroupComponentCustomPrice.ts | 2 +- src/models/subscriptionGroupCreditCard.ts | 8 +- src/models/subscriptionGroupCustomer.ts | 2 +- src/models/subscriptionGroupInclude.ts | 2 +- src/models/subscriptionGroupItem.ts | 2 +- src/models/subscriptionGroupMemberError.ts | 2 +- .../subscriptionGroupMembersArrayError.ts | 2 +- src/models/subscriptionGroupPaymentProfile.ts | 2 +- src/models/subscriptionGroupPrepayment.ts | 2 +- .../subscriptionGroupPrepaymentMethod.ts | 2 +- .../subscriptionGroupPrepaymentRequest.ts | 2 +- .../subscriptionGroupPrepaymentResponse.ts | 2 +- src/models/subscriptionGroupResponse.ts | 2 +- src/models/subscriptionGroupSignup.ts | 2 +- .../subscriptionGroupSignupComponent.ts | 2 +- src/models/subscriptionGroupSignupError.ts | 2 +- src/models/subscriptionGroupSignupFailure.ts | 2 +- .../subscriptionGroupSignupFailureData.ts | 2 +- src/models/subscriptionGroupSignupItem.ts | 2 +- src/models/subscriptionGroupSignupRequest.ts | 2 +- src/models/subscriptionGroupSignupResponse.ts | 10 +- src/models/subscriptionGroupSignupSuccess.ts | 2 +- .../subscriptionGroupSignupSuccessData.ts | 2 +- src/models/subscriptionGroupSingleError.ts | 2 +- .../subscriptionGroupSubscriptionError.ts | 2 +- src/models/subscriptionGroupUpdateError.ts | 2 +- src/models/subscriptionGroupsListInclude.ts | 2 +- src/models/subscriptionInclude.ts | 2 +- src/models/subscriptionIncludedCoupon.ts | 2 +- src/models/subscriptionListDateField.ts | 2 +- src/models/subscriptionListInclude.ts | 2 +- src/models/subscriptionMRR.ts | 2 +- src/models/subscriptionMRRBreakout.ts | 2 +- src/models/subscriptionMRRResponse.ts | 2 +- src/models/subscriptionMigrationPreview.ts | 2 +- .../subscriptionMigrationPreviewOptions.ts | 2 +- .../subscriptionMigrationPreviewRequest.ts | 2 +- .../subscriptionMigrationPreviewResponse.ts | 2 +- src/models/subscriptionNote.ts | 2 +- src/models/subscriptionNoteResponse.ts | 2 +- src/models/subscriptionPreview.ts | 2 +- src/models/subscriptionPreviewResponse.ts | 2 +- src/models/subscriptionProductChange.ts | 2 +- src/models/subscriptionProductMigration.ts | 2 +- .../subscriptionProductMigrationRequest.ts | 2 +- src/models/subscriptionPurgeType.ts | 2 +- src/models/subscriptionResponse.ts | 2 +- src/models/subscriptionSort.ts | 2 +- src/models/subscriptionState.ts | 2 +- src/models/subscriptionStateChange.ts | 2 +- src/models/subscriptionStateFilter.ts | 2 +- src/models/taxConfiguration.ts | 4 +- src/models/taxConfigurationKind.ts | 2 +- src/models/taxDestinationAddress.ts | 2 +- src/models/tooManyManagementLinkRequests.ts | 2 +- src/models/updateAllocationExpirationDate.ts | 2 +- src/models/updateComponent.ts | 2 +- src/models/updateComponentPricePoint.ts | 7 +- .../updateComponentPricePointRequest.ts | 2 +- src/models/updateComponentRequest.ts | 2 +- src/models/updateCouponCurrency.ts | 2 +- src/models/updateCurrencyPrice.ts | 2 +- src/models/updateCurrencyPricesRequest.ts | 2 +- src/models/updateCustomer.ts | 5 +- src/models/updateCustomerRequest.ts | 2 +- src/models/updateMetadata.ts | 2 +- src/models/updateMetadataRequest.ts | 2 +- src/models/updateMetafield.ts | 2 +- src/models/updateMetafieldsRequest.ts | 2 +- src/models/updatePaymentProfile.ts | 8 +- src/models/updatePaymentProfileRequest.ts | 2 +- src/models/updatePrice.ts | 2 +- src/models/updateProductPricePoint.ts | 2 +- src/models/updateProductPricePointRequest.ts | 2 +- src/models/updateReasonCode.ts | 2 +- src/models/updateReasonCodeRequest.ts | 2 +- src/models/updateSegment.ts | 2 +- src/models/updateSegmentRequest.ts | 2 +- src/models/updateSubscription.ts | 2 +- src/models/updateSubscriptionComponent.ts | 2 +- src/models/updateSubscriptionGroup.ts | 2 +- src/models/updateSubscriptionGroupRequest.ts | 2 +- src/models/updateSubscriptionNote.ts | 2 +- src/models/updateSubscriptionNoteRequest.ts | 2 +- src/models/updateSubscriptionRequest.ts | 2 +- src/models/upsertPrepaidConfiguration.ts | 2 +- .../upsertPrepaidConfigurationRequest.ts | 2 +- src/models/usage.ts | 2 +- src/models/usageResponse.ts | 2 +- src/models/voidInvoice.ts | 2 +- src/models/voidInvoiceEvent.ts | 2 +- src/models/voidInvoiceEventData.ts | 2 +- src/models/voidInvoiceRequest.ts | 2 +- src/models/voidRemainderEvent.ts | 2 +- src/models/voidRemainderEventData.ts | 2 +- src/models/webhook.ts | 2 +- src/models/webhookOrder.ts | 2 +- src/models/webhookResponse.ts | 2 +- src/models/webhookStatus.ts | 2 +- src/models/webhookSubscription.ts | 2 +- src/schema.ts | 2 +- 961 files changed, 3159 insertions(+), 2316 deletions(-) create mode 100644 doc/models/activate-event-based-component.md create mode 100644 doc/models/all-vaults.md create mode 100644 doc/models/apple-pay-payment-profile.md create mode 100644 doc/models/apple-pay-vault.md rename doc/models/containers/{payment-profile-response-payment-profile.md => payment-profile.md} (53%) create mode 100644 doc/models/credit-card-vault.md delete mode 100644 doc/models/current-vault.md create mode 100644 doc/models/expiration-interval-unit.md delete mode 100644 doc/models/extended-interval-unit.md create mode 100644 doc/models/pay-pal-vault.md create mode 100644 doc/models/paypal-payment-profile.md create mode 100644 src/models/activateEventBasedComponent.ts rename src/models/{currentVault.ts => allVaults.ts} (70%) create mode 100644 src/models/applePayPaymentProfile.ts create mode 100644 src/models/applePayVault.ts create mode 100644 src/models/containers/paymentProfile.ts delete mode 100644 src/models/containers/paymentProfileResponsePaymentProfile.ts create mode 100644 src/models/creditCardVault.ts create mode 100644 src/models/expirationIntervalUnit.ts delete mode 100644 src/models/extendedIntervalUnit.ts create mode 100644 src/models/payPalVault.ts create mode 100644 src/models/paypalPaymentProfile.ts diff --git a/.eslintignore b/.eslintignore index b021906f..9f9eafe6 100644 --- a/.eslintignore +++ b/.eslintignore @@ -2,5 +2,4 @@ .DS_Store node_modules dist -coverage -test \ No newline at end of file +coverage \ No newline at end of file diff --git a/README.md b/README.md index 122b52f8..383bbc35 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,10 @@ Maxio Advanced Billing (formerly Chargify) provides an HTTP-based API that confo One of the many reasons to use Advanced Billing is the immense feature set and surrounding community [client libraries](page:development-tools/client-libraries). The Maxio API returns JSON responses as the primary and recommended format, but XML is also provided as a backwards compatible option for Merchants who require it. -### Steps to make your first Maxio Advanced Billing API call +### Steps to make your first Maxio Chargify API call -1. [Sign-up](https://app.chargify.com/signup/maxio-billing-sandbox) or [log-in](https://app.chargify.com/login.html) to your [test site](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405553861773-Testing-Intro) account. -2. [Setup and configure authentication](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405281550477-API-Keys#api) credentials. +1. [Sign-up](https://app.chargify.com/signup/maxio-billing-sandbox) or [log-in](https://app.chargify.com/login.html) to your [test site](https://maxio.zendesk.com/hc/en-us/articles/24250712113165-Testing-Overview) account. +2. [Setup and configure authentication](https://maxio.zendesk.com/hc/en-us/articles/24294819360525-API-Keys) credentials. 3. Submit your API request and try it out. 4. Verify results through response. 5. Test our integrations. @@ -30,26 +30,26 @@ curl -u :x -H Accept:application/json -H Content-Type:application/json Run the following command from your project directory to install the package from npm: ```ts -npm install @maxio-com/advanced-billing-sdk@4.0.0 +npm install @maxio-com/advanced-billing-sdk@5.0.0 ``` -For additional package details, see the [Npm page for the @maxio-com/advanced-billing-sdk@4.0.0 npm](https://www.npmjs.com/package/@maxio-com/advanced-billing-sdk/v/4.0.0). +For additional package details, see the [Npm page for the @maxio-com/advanced-billing-sdk@5.0.0 npm](https://www.npmjs.com/package/@maxio-com/advanced-billing-sdk/v/5.0.0). ## Initialize the API Client -**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/client.md) +**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/client.md) The following parameters are configurable for the API Client: | Parameter | Type | Description | | --- | --- | --- | -| `subdomain` | `string` | The subdomain for your Chargify site.
*Default*: `'subdomain'` | -| `domain` | `string` | The Chargify server domain.
*Default*: `'chargify.com'` | +| `subdomain` | `string` | The subdomain for your Advanced Billing site.
*Default*: `'subdomain'` | +| `domain` | `string` | The Advanced Billing server domain.
*Default*: `'chargify.com'` | | `environment` | `Environment` | The API environment.
**Default: `Environment.Production`** | | `timeout` | `number` | Timeout for API calls.
*Default*: `120000` | | `httpClientOptions` | `Partial` | Stable configurable http client options. | | `unstableHttpClientOptions` | `any` | Unstable configurable http client options. | -| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/$a/https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/basic-authentication.md) | The credential object for basicAuth | +| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/auth/basic-authentication.md) | The credential object for basicAuth | ### HttpClientOptions @@ -102,45 +102,45 @@ The SDK can be configured to use a different environment for making API calls. A This API uses the following authentication schemes. -* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/$a/https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/basic-authentication.md) +* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/auth/basic-authentication.md) ## List of APIs -* [API Exports](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/api-exports.md) -* [Advance Invoice](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/advance-invoice.md) -* [Billing Portal](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/billing-portal.md) -* [Component Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/component-price-points.md) -* [Custom Fields](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/custom-fields.md) -* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/events-based-billing-segments.md) -* [Payment Profiles](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/payment-profiles.md) -* [Product Families](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/product-families.md) -* [Product Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/product-price-points.md) -* [Proforma Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/proforma-invoices.md) -* [Reason Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/reason-codes.md) -* [Referral Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/referral-codes.md) -* [Sales Commissions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/sales-commissions.md) -* [Subscription Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-components.md) -* [Subscription Groups](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-groups.md) -* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-group-invoice-account.md) -* [Subscription Group Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-group-status.md) -* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-invoice-account.md) -* [Subscription Notes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-notes.md) -* [Subscription Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-products.md) -* [Subscription Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-status.md) -* [Coupons](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/coupons.md) -* [Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/components.md) -* [Customers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/customers.md) -* [Events](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/events.md) -* [Insights](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/insights.md) -* [Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/invoices.md) -* [Offers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/offers.md) -* [Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/products.md) -* [Sites](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/sites.md) -* [Subscriptions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscriptions.md) -* [Webhooks](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/webhooks.md) +* [API Exports](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/api-exports.md) +* [Advance Invoice](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/advance-invoice.md) +* [Billing Portal](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/billing-portal.md) +* [Component Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/component-price-points.md) +* [Custom Fields](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/custom-fields.md) +* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/events-based-billing-segments.md) +* [Payment Profiles](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/payment-profiles.md) +* [Product Families](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/product-families.md) +* [Product Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/product-price-points.md) +* [Proforma Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/proforma-invoices.md) +* [Reason Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/reason-codes.md) +* [Referral Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/referral-codes.md) +* [Sales Commissions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/sales-commissions.md) +* [Subscription Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-components.md) +* [Subscription Groups](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-groups.md) +* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-group-invoice-account.md) +* [Subscription Group Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-group-status.md) +* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-invoice-account.md) +* [Subscription Notes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-notes.md) +* [Subscription Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-products.md) +* [Subscription Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-status.md) +* [Coupons](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/coupons.md) +* [Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/components.md) +* [Customers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/customers.md) +* [Events](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/events.md) +* [Insights](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/insights.md) +* [Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/invoices.md) +* [Offers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/offers.md) +* [Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/products.md) +* [Sites](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/sites.md) +* [Subscriptions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscriptions.md) +* [Webhooks](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/webhooks.md) ## Classes Documentation -* [ApiResponse](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/api-response.md) -* [ApiError](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/api-error.md) +* [ApiResponse](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/api-response.md) +* [ApiError](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/api-error.md) diff --git a/doc/client.md b/doc/client.md index 44c8fa07..22d6629e 100644 --- a/doc/client.md +++ b/doc/client.md @@ -5,13 +5,13 @@ The following parameters are configurable for the API Client: | Parameter | Type | Description | | --- | --- | --- | -| `subdomain` | `string` | The subdomain for your Chargify site.
*Default*: `'subdomain'` | -| `domain` | `string` | The Chargify server domain.
*Default*: `'chargify.com'` | +| `subdomain` | `string` | The subdomain for your Advanced Billing site.
*Default*: `'subdomain'` | +| `domain` | `string` | The Advanced Billing server domain.
*Default*: `'chargify.com'` | | `environment` | `Environment` | The API environment.
**Default: `Environment.Production`** | | `timeout` | `number` | Timeout for API calls.
*Default*: `120000` | | `httpClientOptions` | `Partial` | Stable configurable http client options. | | `unstableHttpClientOptions` | `any` | Unstable configurable http client options. | -| `basicAuthCredentials` | [`BasicAuthCredentials`]($a/basic-authentication.md) | The credential object for basicAuth | +| `basicAuthCredentials` | [`BasicAuthCredentials`](auth/basic-authentication.md) | The credential object for basicAuth | ## HttpClientOptions diff --git a/doc/controllers/advance-invoice.md b/doc/controllers/advance-invoice.md index 15f1d774..7481ebd7 100644 --- a/doc/controllers/advance-invoice.md +++ b/doc/controllers/advance-invoice.md @@ -17,7 +17,7 @@ const advanceInvoiceController = new AdvanceInvoiceController(client); # Issue Advance Invoice -Generate an invoice in advance for a subscription's next renewal date. [Please see our docs](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404811062541-Issue-Invoice-In-Advance) for more information on advance invoices, including eligibility on generating one; for the most part, they function like any other invoice, except they are issued early and have special behavior upon being voided. +Generate an invoice in advance for a subscription's next renewal date. [Please see our docs](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invoice-In-Advance) for more information on advance invoices, including eligibility on generating one; for the most part, they function like any other invoice, except they are issued early and have special behavior upon being voided. A subscription may only have one advance invoice per billing period. Attempting to issue an advance invoice when one already exists will return an error. That said, regeneration of the invoice may be forced with the params `force: true`, which will void an advance invoice if one exists and generate a new one. If no advance invoice exists, a new one will be generated. We recommend using either the create or preview endpoints for proforma invoices to preview this advance invoice before using this endpoint to generate it. diff --git a/doc/controllers/api-exports.md b/doc/controllers/api-exports.md index e6887a36..35218d1d 100644 --- a/doc/controllers/api-exports.md +++ b/doc/controllers/api-exports.md @@ -55,6 +55,7 @@ const collect = { perPage: 100, page: 2 } + try { const { result, ...httpResponse } = await aPIExportsController.listExportedProformaInvoices(collect); // Get more response info... @@ -108,6 +109,7 @@ const collect = { perPage: 100, page: 2 } + try { const { result, ...httpResponse } = await aPIExportsController.listExportedInvoices(collect); // Get more response info... @@ -161,6 +163,7 @@ const collect = { perPage: 100, page: 2 } + try { const { result, ...httpResponse } = await aPIExportsController.listExportedSubscriptions(collect); // Get more response info... diff --git a/doc/controllers/billing-portal.md b/doc/controllers/billing-portal.md index bfb8db6d..953e4b30 100644 --- a/doc/controllers/billing-portal.md +++ b/doc/controllers/billing-portal.md @@ -20,7 +20,7 @@ const billingPortalController = new BillingPortalController(client); ## Billing Portal Documentation -Full documentation on how the Billing Portal operates within the Chargify UI can be located [here](https://chargify.zendesk.com/hc/en-us/articles/4407648972443). +Full documentation on how the Billing Portal operates within the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24252412965133-Billing-Portal-Overview). This documentation is focused on how the to configure the Billing Portal Settings, as well as Subscriber Interaction and Merchant Management of the Billing Portal. @@ -30,9 +30,9 @@ You can use this endpoint to enable Billing Portal access for a Customer, with t If your customer has been invited to the Billing Portal, then they will receive a link to manage their subscription (the “Management URL”) automatically at the bottom of their statements, invoices, and receipts. **This link changes periodically for security and is only valid for 65 days.** -If you need to provide your customer their Management URL through other means, you can retrieve it via the API. Because the URL is cryptographically signed with a timestamp, it is not possible for merchants to generate the URL without requesting it from Chargify. +If you need to provide your customer their Management URL through other means, you can retrieve it via the API. Because the URL is cryptographically signed with a timestamp, it is not possible for merchants to generate the URL without requesting it from Advanced Billing. -In order to prevent abuse & overuse, we ask that you request a new URL only when absolutely necessary. Management URLs are good for 65 days, so you should re-use a previously generated one as much as possible. If you use the URL frequently (such as to display on your website), please **do not** make an API request to Chargify every time. +In order to prevent abuse & overuse, we ask that you request a new URL only when absolutely necessary. Management URLs are good for 65 days, so you should re-use a previously generated one as much as possible. If you use the URL frequently (such as to display on your website), please **do not** make an API request to Advanced Billing every time. ```ts async enableBillingPortalForCustomer( customerId: number, diff --git a/doc/controllers/component-price-points.md b/doc/controllers/component-price-points.md index a67e8f45..a3e61dc4 100644 --- a/doc/controllers/component-price-points.md +++ b/doc/controllers/component-price-points.md @@ -27,7 +27,7 @@ const componentPricePointsController = new ComponentPricePointsController(client Sets a new default price point for the component. This new default will apply to all new subscriptions going forward - existing subscriptions will remain on their current price point. -See [Price Points Documentation](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#price-points) for more information on price points and moving subscriptions between price points. +See [Price Points Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261191737101-Price-Points-Components) for more information on price points and moving subscriptions between price points. Note: Custom price points are not able to be set as the default for a component. @@ -41,8 +41,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `componentId` | `number` | Template, Required | The Chargify id of the component to which the price point belongs | -| `pricePointId` | `number` | Template, Required | The Chargify id of the price point | +| `componentId` | `number` | Template, Required | The Advanced Billing id of the component to which the price point belongs | +| `pricePointId` | `number` | Template, Required | The Advanced Billing id of the price point | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -119,7 +119,7 @@ requestOptions?: RequestOptions): PromiseUse in query `page=1`. | | `perPage` | `number \| undefined` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`. | @@ -210,6 +210,7 @@ const collect = {Liquid error: Value cannot be null. (Parameter 'key') page: 2, perPage: 50 } + try { const { result, ...httpResponse } = await componentPricePointsController.listComponentPricePoints(collect); // Get more response info... @@ -286,7 +287,7 @@ requestOptions?: RequestOptions): Promise> ``` @@ -44,7 +44,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the component belongs | +| `productFamilyId` | `string` | Template, Required | Either the product family's id or its handle prefixed with `handle:` | | `body` | [`CreateMeteredComponent \| undefined`](../../doc/models/create-metered-component.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -55,7 +55,7 @@ requestOptions?: RequestOptions): Promise> ## Example Usage ```ts -const productFamilyId = 140; +const productFamilyId = 'product_family_id4'; const body: CreateMeteredComponent = { meteredComponent: { @@ -161,10 +161,10 @@ One-time quantity-based components are used to create ad hoc usage charges that The allocated quantity for one-time quantity-based components immediately gets reset back to zero after the allocation is made. -For more information on components, please see our documentation [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677). +For more information on components, please see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). ```ts -async createQuantityBasedComponent( productFamilyId: number, +async createQuantityBasedComponent( productFamilyId: string, body?: CreateQuantityBasedComponent, requestOptions?: RequestOptions): Promise> ``` @@ -173,7 +173,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the component belongs | +| `productFamilyId` | `string` | Template, Required | Either the product family's id or its handle prefixed with `handle:` | | `body` | [`CreateQuantityBasedComponent \| undefined`](../../doc/models/create-quantity-based-component.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -184,7 +184,7 @@ requestOptions?: RequestOptions): Promise> ## Example Usage ```ts -const productFamilyId = 140; +const productFamilyId = 'product_family_id4'; const body: CreateQuantityBasedComponent = { quantityBasedComponent: { @@ -281,10 +281,10 @@ This request will create a component definition of kind **on_off_component** und On/off components are used for any flat fee, recurring add on (think $99/month for tech support or a flat add on shipping fee). -For more information on components, please see our documentation [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677). +For more information on components, please see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). ```ts -async createOnOffComponent( productFamilyId: number, +async createOnOffComponent( productFamilyId: string, body?: CreateOnOffComponent, requestOptions?: RequestOptions): Promise> ``` @@ -293,7 +293,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the component belongs | +| `productFamilyId` | `string` | Template, Required | Either the product family's id or its handle prefixed with `handle:` | | `body` | [`CreateOnOffComponent \| undefined`](../../doc/models/create-on-off-component.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -304,7 +304,7 @@ requestOptions?: RequestOptions): Promise> ## Example Usage ```ts -const productFamilyId = 140; +const productFamilyId = 'product_family_id4'; const body: CreateOnOffComponent = { onOffComponent: { @@ -391,10 +391,10 @@ This request will create a component definition of kind **prepaid_usage_componen Prepaid components allow customers to pre-purchase units that can be used up over time on their subscription. In a sense, they are the mirror image of metered components; while metered components charge at the end of the period for the amount of units used, prepaid components are charged for at the time of purchase, and we subsequently keep track of the usage against the amount purchased. -For more information on components, please see our documentation [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677). +For more information on components, please see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). ```ts -async createPrepaidUsageComponent( productFamilyId: number, +async createPrepaidUsageComponent( productFamilyId: string, body?: CreatePrepaidComponent, requestOptions?: RequestOptions): Promise> ``` @@ -403,7 +403,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the component belongs | +| `productFamilyId` | `string` | Template, Required | Either the product family's id or its handle prefixed with `handle:` | | `body` | [`CreatePrepaidComponent \| undefined`](../../doc/models/create-prepaid-component.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -414,7 +414,7 @@ requestOptions?: RequestOptions): Promise> ## Example Usage ```ts -const productFamilyId = 140; +const productFamilyId = 'product_family_id4'; const body: CreatePrepaidComponent = { prepaidUsageComponent: { @@ -439,7 +439,7 @@ const body: CreatePrepaidComponent = { rolloverPrepaidRemainder: true, renewPrepaidAllocation: true, expirationInterval: 15, - expirationIntervalUnit: IntervalUnit.Day, + expirationIntervalUnit: ExpirationIntervalUnit.Day, }, }; @@ -536,10 +536,10 @@ Event-based components are similar to other component types, in that you define So, instead of reporting usage directly for each component (as you would with metered components), the usage is derived from analysis of your events. -For more information on components, please see our documentation [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677). +For more information on components, please see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). ```ts -async createEventBasedComponent( productFamilyId: number, +async createEventBasedComponent( productFamilyId: string, body?: CreateEBBComponent, requestOptions?: RequestOptions): Promise> ``` @@ -548,7 +548,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the component belongs | +| `productFamilyId` | `string` | Template, Required | Either the product family's id or its handle prefixed with `handle:` | | `body` | [`CreateEBBComponent \| undefined`](../../doc/models/create-ebb-component.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -559,7 +559,7 @@ requestOptions?: RequestOptions): Promise> ## Example Usage ```ts -const productFamilyId = 140; +const productFamilyId = 'product_family_id4'; const body: CreateEBBComponent = { eventBasedComponent: { @@ -725,8 +725,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the component belongs | -| `componentId` | `string` | Template, Required | Either the Chargify id of the component or the handle for the component prefixed with `handle:` | +| `productFamilyId` | `number` | Template, Required | The Advanced Billing id of the product family to which the component belongs | +| `componentId` | `string` | Template, Required | Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:` | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -803,8 +803,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the component belongs | -| `componentId` | `string` | Template, Required | Either the Chargify id of the component or the handle for the component prefixed with `handle:` | +| `productFamilyId` | `number` | Template, Required | The Advanced Billing id of the product family to which the component belongs | +| `componentId` | `string` | Template, Required | Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:` | | `body` | [`UpdateComponentRequest \| undefined`](../../doc/models/update-component-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -892,8 +892,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the component belongs | -| `componentId` | `string` | Template, Required | Either the Chargify id of the component or the handle for the component prefixed with `handle:` | +| `productFamilyId` | `number` | Template, Required | The Advanced Billing id of the product family to which the component belongs | +| `componentId` | `string` | Template, Required | Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:` | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -1006,6 +1006,7 @@ const collect = { ], } } + try { const { result, ...httpResponse } = await componentsController.listComponents(collect); // Get more response info... @@ -1224,7 +1225,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family | +| `productFamilyId` | `number` | Template, Required | The Advanced Billing id of the product family | | `includeArchived` | `boolean \| undefined` | Query, Optional | Include archived items. | | `page` | `number \| undefined` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`. | | `perPage` | `number \| undefined` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`. | @@ -1256,6 +1257,7 @@ const collect = { }, dateField: BasicDateField.UpdatedAt } + try { const { result, ...httpResponse } = await componentsController.listComponentsForProductFamily(collect); // Get more response info... diff --git a/doc/controllers/coupons.md b/doc/controllers/coupons.md index bf6dce96..d02d1168 100644 --- a/doc/controllers/coupons.md +++ b/doc/controllers/coupons.md @@ -30,9 +30,9 @@ const couponsController = new CouponsController(client); ## Coupons Documentation -Coupons can be administered in the Chargify application or created via API. Please view our section on [creating coupons](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404742830733) for more information. +Coupons can be administered in the Advanced Billing application or created via API. Please view our section on [creating coupons](https://maxio.zendesk.com/hc/en-us/articles/24261212433165-Creating-Editing-Deleting-Coupons) for more information. -Additionally, for documentation on how to apply a coupon to a subscription within the Chargify UI, please see our documentation [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404761012877). +Additionally, for documentation on how to apply a coupon to a subscription within the Advanced Billing UI, please see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions). ## Create Coupon @@ -53,7 +53,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the coupon belongs | +| `productFamilyId` | `number` | Template, Required | The Advanced Billing id of the product family to which the coupon belongs | | `body` | [`CreateOrUpdateCoupon \| undefined`](../../doc/models/create-or-update-coupon.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -131,7 +131,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the coupon belongs | +| `productFamilyId` | `number` | Template, Required | The Advanced Billing id of the product family to which the coupon belongs | | `page` | `number \| undefined` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`. | | `perPage` | `number \| undefined` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 30. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`. | | `filter` | [`ListCouponsFilter \| undefined`](../../doc/models/list-coupons-filter.md) | Query, Optional | Filter to use for List Coupons operations | @@ -166,6 +166,7 @@ const collect = { }, currencyPrices: true } + try { const { result, ...httpResponse } = await couponsController.listCouponsForProductFamily(collect); // Get more response info... @@ -286,7 +287,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number \| undefined` | Query, Optional | The Chargify id of the product family to which the coupon belongs | +| `productFamilyId` | `number \| undefined` | Query, Optional | The Advanced Billing id of the product family to which the coupon belongs | | `code` | `string \| undefined` | Query, Optional | The code of the coupon | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -312,7 +313,7 @@ try { # Read Coupon -You can retrieve the Coupon via the API with the Show method. You must identify the Coupon in this call by the ID parameter that Chargify assigns. +You can retrieve the Coupon via the API with the Show method. You must identify the Coupon in this call by the ID parameter that Advanced Billing assigns. If instead you would like to find a Coupon using a Coupon code, see the Coupon Find method. When fetching a coupon, if you have defined multiple currencies at the site level, you can optionally pass the `?currency_prices=true` query param to include an array of currency price data in the response. @@ -329,8 +330,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the coupon belongs | -| `couponId` | `number` | Template, Required | The Chargify id of the coupon | +| `productFamilyId` | `number` | Template, Required | The Advanced Billing id of the product family to which the coupon belongs | +| `couponId` | `number` | Template, Required | The Advanced Billing id of the coupon | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -409,8 +410,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the coupon belongs | -| `couponId` | `number` | Template, Required | The Chargify id of the coupon | +| `productFamilyId` | `number` | Template, Required | The Advanced Billing id of the product family to which the coupon belongs | +| `couponId` | `number` | Template, Required | The Advanced Billing id of the coupon | | `body` | [`CreateOrUpdateCoupon \| undefined`](../../doc/models/create-or-update-coupon.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -509,8 +510,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the coupon belongs | -| `couponId` | `number` | Template, Required | The Chargify id of the coupon | +| `productFamilyId` | `number` | Template, Required | The Advanced Billing id of the product family to which the coupon belongs | +| `couponId` | `number` | Template, Required | The Advanced Billing id of the coupon | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -620,6 +621,7 @@ const collect = { }, currencyPrices: true } + try { const { result, ...httpResponse } = await couponsController.listCoupons(collect); // Get more response info... @@ -695,8 +697,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productFamilyId` | `number` | Template, Required | The Chargify id of the product family to which the coupon belongs | -| `couponId` | `number` | Template, Required | The Chargify id of the coupon | +| `productFamilyId` | `number` | Template, Required | The Advanced Billing id of the product family to which the coupon belongs | +| `couponId` | `number` | Template, Required | The Advanced Billing id of the coupon | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -795,7 +797,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `code` | `string` | Query, Required | The code of the coupon | -| `productFamilyId` | `number \| undefined` | Query, Optional | The Chargify id of the product family to which the coupon belongs | +| `productFamilyId` | `number \| undefined` | Query, Optional | The Advanced Billing id of the product family to which the coupon belongs | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -871,7 +873,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `couponId` | `number` | Template, Required | The Chargify id of the coupon | +| `couponId` | `number` | Template, Required | The Advanced Billing id of the coupon | | `body` | [`CouponCurrencyRequest \| undefined`](../../doc/models/coupon-currency-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -937,9 +939,9 @@ When creating a coupon subcode, you must specify a coupon to attach it to using ## Coupon Subcodes Documentation -Full documentation on how to create coupon subcodes in the Chargify UI can be located [here](https://chargify.zendesk.com/hc/en-us/articles/4407755909531#coupon-codes). +Full documentation on how to create coupon subcodes in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261208729229-Coupon-Codes). -Additionally, for documentation on how to apply a coupon to a Subscription within the Chargify UI, please see our documentation [here](https://chargify.zendesk.com/hc/en-us/articles/4407884887835#coupon). +Additionally, for documentation on how to apply a coupon to a Subscription within the Advanced Billing UI, please see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions). ## Create Coupon Subcode @@ -966,7 +968,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `couponId` | `number` | Template, Required | The Chargify id of the coupon | +| `couponId` | `number` | Template, Required | The Advanced Billing id of the coupon | | `body` | [`CouponSubcodes \| undefined`](../../doc/models/coupon-subcodes.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -1030,7 +1032,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `couponId` | `number` | Template, Required | The Chargify id of the coupon | +| `couponId` | `number` | Template, Required | The Advanced Billing id of the coupon | | `page` | `number \| undefined` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`. | | `perPage` | `number \| undefined` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -1047,6 +1049,7 @@ const collect = { page: 2, perPage: 50 } + try { const { result, ...httpResponse } = await couponsController.listCouponSubcodes(collect); // Get more response info... @@ -1113,7 +1116,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `couponId` | `number` | Template, Required | The Chargify id of the coupon | +| `couponId` | `number` | Template, Required | The Advanced Billing id of the coupon | | `body` | [`CouponSubcodes \| undefined`](../../doc/models/coupon-subcodes.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -1185,7 +1188,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `couponId` | `number` | Template, Required | The Chargify id of the coupon to which the subcode belongs | +| `couponId` | `number` | Template, Required | The Advanced Billing id of the coupon to which the subcode belongs | | `subcode` | `string` | Template, Required | The subcode of the coupon | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/controllers/custom-fields.md b/doc/controllers/custom-fields.md index 73b82bf1..e6d7cb43 100644 --- a/doc/controllers/custom-fields.md +++ b/doc/controllers/custom-fields.md @@ -25,12 +25,12 @@ const customFieldsController = new CustomFieldsController(client); ## Custom Fields: Metafield Intro -**Chargify refers to Custom Fields in the API documentation as metafields and metadata.** Within the Chargify UI, metadata and metafields are grouped together under the umbrella of "Custom Fields." All of our UI-based documentation that references custom fields will not cite the terminology metafields or metadata. +**Advanced Billing refers to Custom Fields in the API documentation as metafields and metadata.** Within the Advanced Billing UI, metadata and metafields are grouped together under the umbrella of "Custom Fields." All of our UI-based documentation that references custom fields will not cite the terminology metafields or metadata. + **Metafield is the custom field** + **Metadata is the data populating the custom field.** -Chargify Metafields are used to add meaningful attributes to subscription and customer resources. Full documentation on how to create Custom Fields in the Chargify UI can be located [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405332553613-Custom-Fields-Reference). For additional documentation on how to record data within custom fields, please see our subscription-based documentation [here.](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404434903181-Subscription-Summary#custom-fields) +Advanced Billing Metafields are used to add meaningful attributes to subscription and customer resources. Full documentation on how to create Custom Fields in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/sections/24266118312589-Custom-Fields). For additional documentation on how to record data within custom fields, please see our subscription-based documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24251701302925-Subscription-Summary-Custom-Fields-Tab). Metafield are the place where you will set up your resource to accept additional data. It is scoped to the site instead of a specific customer or subscription. Think of it as the key, and Metadata as the value on every record. @@ -175,6 +175,7 @@ const collect = { page: 2, perPage: 50 } + try { const { result, ...httpResponse } = await customFieldsController.listMetafields(collect); // Get more response info... @@ -314,12 +315,12 @@ try { ## Custom Fields: Metadata Intro -**Chargify refers to Custom Fields in the API documentation as metafields and metadata.** Within the Chargify UI, metadata and metafields are grouped together under the umbrella of "Custom Fields." All of our UI-based documentation that references custom fields will not cite the terminology metafields or metadata. +**Advanced Billing refers to Custom Fields in the API documentation as metafields and metadata.** Within the Advanced Billing UI, metadata and metafields are grouped together under the umbrella of "Custom Fields." All of our UI-based documentation that references custom fields will not cite the terminology metafields or metadata. + **Metafield is the custom field** + **Metadata is the data populating the custom field.** -Chargify Metafields are used to add meaningful attributes to subscription and customer resources. Full documentation on how to create Custom Fields in the Chargify UI can be located [here](https://chargify.zendesk.com/hc/en-us/articles/4407659856411). For additional documentation on how to record data within custom fields, please see our subscription-based documentation [here.](https://chargify.zendesk.com/hc/en-us/articles/4407884887835#custom-fields) +Advanced Billing Metafields are used to add meaningful attributes to subscription and customer resources. Full documentation on how to create Custom Fields in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24266164865677-Custom-Fields-Overview). For additional documentation on how to record data within custom fields, please see our subscription-based documentation [here.](https://maxio.zendesk.com/hc/en-us/articles/24251701302925-Subscription-Summary-Custom-Fields-Tab) Metadata is associated to a customer or subscription, and corresponds to a Metafield. When creating a new metadata object for a given record, **if the metafield is not present it will be created**. @@ -347,7 +348,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `resourceType` | [`ResourceType`](../../doc/models/resource-type.md) | Template, Required | the resource type to which the metafields belong | -| `resourceId` | `number` | Template, Required | The Chargify id of the customer or the subscription for which the metadata applies | +| `resourceId` | `number` | Template, Required | The Advanced Billing id of the customer or the subscription for which the metadata applies | | `body` | [`CreateMetadataRequest \| undefined`](../../doc/models/create-metadata-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -419,7 +420,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `resourceType` | [`ResourceType`](../../doc/models/resource-type.md) | Template, Required | the resource type to which the metafields belong | -| `resourceId` | `number` | Template, Required | The Chargify id of the customer or the subscription for which the metadata applies | +| `resourceId` | `number` | Template, Required | The Advanced Billing id of the customer or the subscription for which the metadata applies | | `page` | `number \| undefined` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`. | | `perPage` | `number \| undefined` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -437,6 +438,7 @@ const collect = { page: 2, perPage: 50 } + try { const { result, ...httpResponse } = await customFieldsController.listMetadata(collect); // Get more response info... @@ -466,7 +468,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `resourceType` | [`ResourceType`](../../doc/models/resource-type.md) | Template, Required | the resource type to which the metafields belong | -| `resourceId` | `number` | Template, Required | The Chargify id of the customer or the subscription for which the metadata applies | +| `resourceId` | `number` | Template, Required | The Advanced Billing id of the customer or the subscription for which the metadata applies | | `body` | [`UpdateMetadataRequest \| undefined`](../../doc/models/update-metadata-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -542,7 +544,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `resourceType` | [`ResourceType`](../../doc/models/resource-type.md) | Template, Required | the resource type to which the metafields belong | -| `resourceId` | `number` | Template, Required | The Chargify id of the customer or the subscription for which the metadata applies | +| `resourceId` | `number` | Template, Required | The Advanced Billing id of the customer or the subscription for which the metadata applies | | `name` | `string \| undefined` | Query, Optional | Name of field to be removed. | | `names` | `string[] \| undefined` | Query, Optional | Names of fields to be removed. Use in query: `names[]=field1&names[]=my-field&names[]=another-field`. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -641,6 +643,7 @@ const collect = { perPage: 50, dateField: BasicDateField.UpdatedAt } + try { const { result, ...httpResponse } = await customFieldsController.listMetadataForResourceType(collect); // Get more response info... diff --git a/doc/controllers/customers.md b/doc/controllers/customers.md index 980319ba..cb437d84 100644 --- a/doc/controllers/customers.md +++ b/doc/controllers/customers.md @@ -23,19 +23,19 @@ const customersController = new CustomersController(client); You may create a new Customer at any time, or you may create a Customer at the same time you create a Subscription. The only validation restriction is that you may only create one customer for a given reference value. -If provided, the `reference` value must be unique. It represents a unique identifier for the customer from your own app, i.e. the customer’s ID. This allows you to retrieve a given customer via a piece of shared information. Alternatively, you may choose to leave `reference` blank, and store Chargify’s unique ID for the customer, which is in the `id` attribute. +If provided, the `reference` value must be unique. It represents a unique identifier for the customer from your own app, i.e. the customer’s ID. This allows you to retrieve a given customer via a piece of shared information. Alternatively, you may choose to leave `reference` blank, and store Advanced Billing’s unique ID for the customer, which is in the `id` attribute. -Full documentation on how to locate, create and edit Customers in the Chargify UI can be located [here](https://chargify.zendesk.com/hc/en-us/articles/4407659914267). +Full documentation on how to locate, create and edit Customers in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24252190590093-Customer-Details). ## Required Country Format -Chargify requires that you use the ISO Standard Country codes when formatting country attribute of the customer. +Advanced Billing requires that you use the ISO Standard Country codes when formatting country attribute of the customer. Countries should be formatted as 2 characters. For more information, please see the following wikipedia article on [ISO_3166-1.](http://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) ## Required State Format -Chargify requires that you use the ISO Standard State codes when formatting state attribute of the customer. +Advanced Billing requires that you use the ISO Standard State codes when formatting state attribute of the customer. + US States (2 characters): [ISO_3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) @@ -43,8 +43,8 @@ Chargify requires that you use the ISO Standard State codes when formatting stat ## Locale -Chargify allows you to attribute a language/region to your customer to deliver invoices in any required language. -For more: [Customer Locale](https://chargify.zendesk.com/hc/en-us/articles/4407870384283#customer-locale) +Advanced Billing allows you to attribute a language/region to your customer to deliver invoices in any required language. +For more: [Customer Locale](https://maxio.zendesk.com/hc/en-us/articles/24286672013709-Customer-Locale) ```ts async createCustomer( body?: CreateCustomerRequest, @@ -149,7 +149,7 @@ Use the search feature with the `q` query parameter to retrieve an array of cust Common use cases are: + Search by an email -+ Search by a Chargify ID ++ Search by an Advanced Billing ID + Search by an organization + Search by a reference value from your application + Search by a first or last name @@ -196,6 +196,7 @@ const collect = { perPage: 30, dateField: BasicDateField.UpdatedAt } + try { const { result, ...httpResponse } = await customersController.listCustomers(collect); // Get more response info... @@ -295,7 +296,7 @@ try { # Read Customer -This method allows to retrieve the Customer properties by Chargify-generated Customer ID. +This method allows to retrieve the Customer properties by Advanced Billing-generated Customer ID. ```ts async readCustomer( id: number, @@ -306,7 +307,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `number` | Template, Required | The Chargify id of the customer | +| `id` | `number` | Template, Required | The Advanced Billing id of the customer | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -345,7 +346,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `number` | Template, Required | The Chargify id of the customer | +| `id` | `number` | Template, Required | The Advanced Billing id of the customer | | `body` | [`UpdateCustomerRequest \| undefined`](../../doc/models/update-customer-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -433,7 +434,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `number` | Template, Required | The Chargify id of the customer | +| `id` | `number` | Template, Required | The Advanced Billing id of the customer | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type diff --git a/doc/controllers/events-based-billing-segments.md b/doc/controllers/events-based-billing-segments.md index 1fe1c460..ab590ab0 100644 --- a/doc/controllers/events-based-billing-segments.md +++ b/doc/controllers/events-based-billing-segments.md @@ -138,6 +138,7 @@ const collect = { segmentProperty1Value: 'EU', } } + try { const { result, ...httpResponse } = await eventsBasedBillingSegmentsController.listSegmentsForPricePoint(collect); // Get more response info... diff --git a/doc/controllers/events.md b/doc/controllers/events.md index 74b1b734..a9463b58 100644 --- a/doc/controllers/events.md +++ b/doc/controllers/events.md @@ -19,9 +19,9 @@ const eventsController = new EventsController(client); ## Events Intro -Chargify Events include various activity that happens around a Site. This information is **especially** useful to track down issues that arise when subscriptions are not created due to errors. +Advanced Billing Events include various activity that happens around a Site. This information is **especially** useful to track down issues that arise when subscriptions are not created due to errors. -Within the Chargify UI, "Events" are referred to as "Site Activity". Full documentation on how to record view Events / Site Activty in the Chargify UI can be located [here](https://chargify.zendesk.com/hc/en-us/articles/4407864698139). +Within the Advanced Billing UI, "Events" are referred to as "Site Activity". Full documentation on how to record view Events / Site Activty in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24250671733517-Site-Activity). ## List Events for a Site @@ -129,6 +129,7 @@ const collect = { ], dateField: ListEventsDateField.CreatedAt } + try { const { result, ...httpResponse } = await eventsController.listEvents(collect); // Get more response info... @@ -251,6 +252,7 @@ const collect = { EventType.PaymentSuccess ] } + try { const { result, ...httpResponse } = await eventsController.listSubscriptionEvents(collect); // Get more response info... @@ -349,6 +351,7 @@ const collect = { EventType.PaymentSuccess ] } + try { const { result, ...httpResponse } = await eventsController.readEventsCount(collect); // Get more response info... diff --git a/doc/controllers/insights.md b/doc/controllers/insights.md index 97c73fc0..1a2c1685 100644 --- a/doc/controllers/insights.md +++ b/doc/controllers/insights.md @@ -145,7 +145,7 @@ This endpoint returns your site's MRR movements. ## Understanding MRR movements -This endpoint will aid in accessing your site's [MRR Report](https://chargify.zendesk.com/hc/en-us/articles/4407838249627) data. +This endpoint will aid in accessing your site's [MRR Report](https://maxio.zendesk.com/hc/en-us/articles/24285894587021-MRR-Analytics) data. Whenever a subscription event occurs that causes your site's MRR to change (such as a signup or upgrade), we record an MRR movement. These records are accessible via the MRR Movements endpoint. @@ -153,7 +153,7 @@ Each MRR Movement belongs to a subscription and contains a timestamp, category, ### Plan & Usage Breakouts -In the MRR Report UI, we support a setting to [include or exclude](https://chargify.zendesk.com/hc/en-us/articles/4407838249627#displaying-component-based-metered-usage-in-mrr) usage revenue. In the MRR APIs, responses include `plan` and `usage` breakouts. +In the MRR Report UI, we support a setting to [include or exclude](https://maxio.zendesk.com/hc/en-us/articles/24285894587021-MRR-Analytics#displaying-component-based-metered-usage-in-mrr) usage revenue. In the MRR APIs, responses include `plan` and `usage` breakouts. Plan includes revenue from: @@ -195,6 +195,7 @@ const collect = { page: 2, perPage: 20 } + try { const { result, ...httpResponse } = await insightsController.listMrrMovements(collect); // Get more response info... @@ -306,6 +307,7 @@ const collect = { perPage: 50, direction: Direction.Desc } + try { const { result, ...httpResponse } = await insightsController.listMrrPerSubscription(collect); // Get more response info... diff --git a/doc/controllers/invoices.md b/doc/controllers/invoices.md index 35d133fa..630d529f 100644 --- a/doc/controllers/invoices.md +++ b/doc/controllers/invoices.md @@ -187,6 +187,7 @@ const collect = { ], sort: InvoiceSortField.TotalAmount } + try { const { result, ...httpResponse } = await invoicesController.listInvoices(collect); // Get more response info... @@ -694,6 +695,7 @@ const collect = { page: 2, perPage: 100 } + try { const { result, ...httpResponse } = await invoicesController.listInvoiceEvents(collect); // Get more response info... @@ -1036,9 +1038,22 @@ try { "tax_rule_id": 1, "percentage": "6.75", "country_code": "US", - "subdivision_code": "NC" + "subdivision_code": "NC", + "tax_amount": "10.66", + "taxable_amount": "157.95", + "tax_exempt_amount": "0.0", + "non_taxable_amount": "0.0", + "tax_name": "NC STATE TAX", + "tax_type": "Sales", + "rate_type": "General", + "tax_authority_type": 45, + "state_assigned_no": "", + "tax_sub_type": "S" } - ] + ], + "eu_vat": false, + "type": "Sales", + "tax_exempt_amount": "0.0" } ], "credit_amount": "0.0", @@ -1123,7 +1138,7 @@ In order to apply a service credit to an invoice, specify the `type` as `service } ``` -Note that Chargify will attempt to fully pay the invoice's `due_amount` from the Subscription's Service Credit account. At this time, partial payments from a Service Credit Account are only allowed for consolidated invoices (subscription groups). Therefore, for normal invoices the Service Credit account balance must be greater than or equal to the invoice's `due_amount`. +Note that Advanced Billing will attempt to fully pay the invoice's `due_amount` from the Subscription's Service Credit account. At this time, partial payments from a Service Credit Account are only allowed for consolidated invoices (subscription groups). Therefore, for normal invoices the Service Credit account balance must be greater than or equal to the invoice's `due_amount`. ```ts async recordPaymentForInvoice( uid: string, @@ -1311,7 +1326,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `subscriptionId` | `number \| undefined` | Query, Optional | The subscription's Chargify id | +| `subscriptionId` | `number \| undefined` | Query, Optional | The subscription's Advanced Billing id | | `page` | `number \| undefined` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`. | | `perPage` | `number \| undefined` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`. | | `lineItems` | `boolean \| undefined` | Query, Optional | Include line items data | @@ -1337,6 +1352,7 @@ const collect = { refunds: false, applications: false } + try { const { result, ...httpResponse } = await invoicesController.listCreditNotes(collect); // Get more response info... @@ -1603,7 +1619,28 @@ try { "taxable_amount": "6.87559535", "tax_amount": "0.46410269" } - ] + ], + "tax_component_breakouts": [ + { + "tax_rule_id": 1, + "percentage": "6.75", + "country_code": "US", + "subdivision_code": "NC", + "tax_amount": "10.66", + "taxable_amount": "157.95", + "tax_exempt_amount": "0.0", + "non_taxable_amount": "0.0", + "tax_name": "NC STATE TAX", + "tax_type": "Sales", + "rate_type": "General", + "tax_authority_type": 45, + "state_assigned_no": "", + "tax_sub_type": "S" + } + ], + "eu_vat": false, + "type": "Sales", + "tax_exempt_amount": "0.0" } ], "applications": [ @@ -1931,7 +1968,28 @@ try { "taxable_amount": "6.87559535", "tax_amount": "0.46410269" } - ] + ], + "tax_component_breakouts": [ + { + "tax_rule_id": 1, + "percentage": "6.75", + "country_code": "US", + "subdivision_code": "NC", + "tax_amount": "10.66", + "taxable_amount": "157.95", + "tax_exempt_amount": "0.0", + "non_taxable_amount": "0.0", + "tax_name": "NC STATE TAX", + "tax_type": "Sales", + "rate_type": "General", + "tax_authority_type": 45, + "state_assigned_no": "", + "tax_sub_type": "S" + } + ], + "eu_vat": false, + "type": "Sales", + "tax_exempt_amount": "0.0" } ], "applications": [ @@ -2189,6 +2247,7 @@ const collect = { perPage: 50, direction: Direction.Asc } + try { const { result, ...httpResponse } = await invoicesController.listConsolidatedInvoiceSegments(collect); // Get more response info... @@ -3186,7 +3245,8 @@ try { "outstanding_amount": "id" } ] - } + }, + "public_url_expires_on": "2024-11-21" } ``` diff --git a/doc/controllers/offers.md b/doc/controllers/offers.md index fd207c19..930c46c8 100644 --- a/doc/controllers/offers.md +++ b/doc/controllers/offers.md @@ -19,7 +19,7 @@ const offersController = new OffersController(client); # Create Offer -Create an offer within your Chargify site by sending a POST request. +Create an offer within your Advanced Billing site by sending a POST request. ## Documentation @@ -27,7 +27,7 @@ Offers allow you to package complicated combinations of products, components and Once an offer is defined it can be used as an alternative to the product when creating subscriptions. -Full documentation on how to use offers in the Chargify UI can be located [here](https://chargify.zendesk.com/hc/en-us/articles/4407753852059). +Full documentation on how to use offers in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261295098637-Offers-Overview). ## Using a Product Price Point @@ -164,6 +164,7 @@ const collect = { perPage: 50, includeArchived: true } + try { const { result, ...httpResponse } = await offersController.listOffers(collect); // Get more response info... diff --git a/doc/controllers/payment-profiles.md b/doc/controllers/payment-profiles.md index 5e1a0bcd..76df97f2 100644 --- a/doc/controllers/payment-profiles.md +++ b/doc/controllers/payment-profiles.md @@ -28,9 +28,9 @@ const paymentProfilesController = new PaymentProfilesController(client); Use this endpoint to create a payment profile for a customer. -Payment Profiles house the credit card, ACH (Authorize.Net or Stripe only,) or PayPal (Braintree only,) data for a customer. The payment information is attached to the customer within Chargify, as opposed to the Subscription itself. +Payment Profiles house the credit card, ACH (Authorize.Net or Stripe only,) or PayPal (Braintree only,) data for a customer. The payment information is attached to the customer within Advanced Billing, as opposed to the Subscription itself. -You must include a customer_id so that Chargify will attach it to the customer entry. If no customer_id is included the API will return a 404. +You must include a customer_id so that Advanced Billing will attach it to the customer entry. If no customer_id is included the API will return a 404. ## Create a Payment Profile for ACH usage @@ -56,11 +56,11 @@ If your subscriber pays taxes on their purchased product, and you are attempting ## Payment Profile Documentation -Full documentation on how Payment Profiles operate within Chargify can be located under the following links: +Full documentation on how Payment Profiles operate within Advanced Billing can be located under the following links: -+ [Subscriber Payment Details](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405212558349-Customers-Reference#customers-reference-0-0) -+ [Self Service Pages](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404759627021) (Allows credit card updates by Subscriber) -+ [Public Signup Pages payment settings](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405267754381-Individual-Page-Settings#credit-card-settings) ++ [Subscriber Payment Details](https://maxio.zendesk.com/hc/en-us/articles/24251599929613-Subscription-Summary-Payment-Details-Tab) ++ [Self Service Pages](https://maxio.zendesk.com/hc/en-us/articles/24261425318541-Self-Service-Pages) (Allows credit card updates by Subscriber) ++ [Public Signup Pages payment settings](https://maxio.zendesk.com/hc/en-us/articles/24261368332557-Individual-Page-Settings) ## Create a Payment Profile with a Chargify.js token @@ -94,7 +94,7 @@ Some merchants use Braintree JavaScript libraries directly and then pass `paymen For more information on GoCardless, please view the following resources: -+ [Full documentation on GoCardless](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404501889677) ++ [Full documentation on GoCardless](https://maxio.zendesk.com/hc/en-us/articles/24176159136909-GoCardless) + [Using Chargify.js with GoCardless - minimal example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-direct-debit-gocardless-gateway) @@ -142,7 +142,7 @@ Following examples create customer, bank account and mandate in GoCardless: ### Importing GoCardless -If the customer, bank account, and mandate already exist in GoCardless, a payment profile can be created by using the IDs. In order to create masked versions of `bank_account_number` and `bank_routing_number` that are used to display within Chargify Admin UI, you can pass the last four digits for this fields which then will be saved in this form `XXXX[four-provided-digits]`. +If the customer, bank account, and mandate already exist in GoCardless, a payment profile can be created by using the IDs. In order to create masked versions of `bank_account_number` and `bank_routing_number` that are used to display within Advanced Billing Admin UI, you can pass the last four digits for this fields which then will be saved in this form `XXXX[four-provided-digits]`. ```json { @@ -168,7 +168,7 @@ If the customer, bank account, and mandate already exist in GoCardless, a paymen For more information on Stripe SEPA Direct Debit, please view the following resources: -+ [Full documentation on Stripe SEPA Direct Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) ++ [Full documentation on Stripe SEPA Direct Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) + [Using Chargify.js with Stripe Direct Debit - minimal example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway) @@ -198,7 +198,7 @@ The following example creates a customer, bank account and mandate in Stripe: For more information on Stripe BECS Direct Debit, please view the following resources: -+ [Full documentation on Stripe BECS Direct Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) ++ [Full documentation on Stripe BECS Direct Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) + [Using Chargify.js with Stripe BECS Direct Debit - minimal example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway) @@ -230,7 +230,7 @@ The following example creates a customer, bank account and mandate in Stripe: Contact the support team to enable this payment method. For more information on Stripe BACS Direct Debit, please view the following resources: -+ [Full documentation on Stripe BACS Direct Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) ++ [Full documentation on Stripe BACS Direct Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) ### Stripe BACS Direct Debit Payment Profiles @@ -255,7 +255,7 @@ The following example creates a customer, bank account and mandate in Stripe: ## 3D Secure - Checkout -It may happen that a payment needs 3D Secure Authentication when the payment profile is created; this is referred to in our help docs as a [post-authentication flow](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405177432077#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response: +It may happen that a payment needs 3D Secure Authentication when the payment profile is created; this is referred to in our help docs as a [post-authentication flow](https://maxio.zendesk.com/hc/en-us/articles/24176278996493-Testing-Implementing-3D-Secure#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response: ```json { @@ -308,7 +308,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `body` | [`CreatePaymentProfileRequest \| undefined`](../../doc/models/create-payment-profile-request.md) | Body, Optional | When following the IBAN or the Local Bank details examples, a customer, bank account and mandate will be created in your current vault. If the customer, bank account, and mandate already exist in your vault, follow the Import example to link the payment profile into Chargify. | +| `body` | [`CreatePaymentProfileRequest \| undefined`](../../doc/models/create-payment-profile-request.md) | Body, Optional | When following the IBAN or the Local Bank details examples, a customer, bank account and mandate will be created in your current vault. If the customer, bank account, and mandate already exist in your vault, follow the Import example to link the payment profile into Advanced Billing. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -410,6 +410,7 @@ const collect = { page: 2, perPage: 50 } + try { const { result, ...httpResponse } = await paymentProfilesController.listPaymentProfiles(collect); // Get more response info... @@ -618,7 +619,7 @@ The result will be that you have updated the billing information for the card, y - Merchants with **Authorize.net**, **Cybersource**, **Forte**, **Braintree Blue** or **Stripe** as their payment gateway can update their Customer’s credit cards without passing in the full credit card number and CVV. -- If you are using **Authorize.net**, **Cybersource**, **Forte**, **Braintree Blue** or **Stripe**, Chargify will ignore the credit card number and CVV when processing an update via the API, and attempt a partial update instead. If you wish to change the card number on a payment profile, you will need to create a new payment profile for the given customer. +- If you are using **Authorize.net**, **Cybersource**, **Forte**, **Braintree Blue** or **Stripe**, Advanced Billing will ignore the credit card number and CVV when processing an update via the API, and attempt a partial update instead. If you wish to change the card number on a payment profile, you will need to create a new payment profile for the given customer. - A Payment Profile cannot be updated with the attributes of another type of Payment Profile. For example, if the payment profile you are attempting to update is a credit card, you cannot pass in bank account attributes (like `bank_account_number`), and vice versa. @@ -657,7 +658,7 @@ const body: UpdatePaymentProfileRequest = { cardType: CardType.Master, expirationMonth: '04', expirationYear: '2030', - currentVault: CurrentVault.Bogus, + currentVault: AllVaults.Bogus, billingAddress: '456 Juniper Court', billingCity: 'Boulder', billingState: 'CO', @@ -1116,11 +1117,11 @@ try { # Read One Time Token -One Time Tokens aka Chargify Tokens house the credit card or ACH (Authorize.Net or Stripe only) data for a customer. +One Time Tokens aka Advanced Billing Tokens house the credit card or ACH (Authorize.Net or Stripe only) data for a customer. You can use One Time Tokens while creating a subscription or payment profile instead of passing all bank account or credit card data directly to a given API endpoint. -To obtain a One Time Token you have to use [chargify.js](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDI0-overview). +To obtain a One Time Token you have to use [Chargify.js](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDI0-overview). ```ts async readOneTimeToken( chargifyToken: string, @@ -1131,7 +1132,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `chargifyToken` | `string` | Template, Required | Chargify Token | +| `chargifyToken` | `string` | Template, Required | Advanced Billing Token | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type diff --git a/doc/controllers/product-families.md b/doc/controllers/product-families.md index 485eab8f..a1dd406e 100644 --- a/doc/controllers/product-families.md +++ b/doc/controllers/product-families.md @@ -66,6 +66,7 @@ const collect = { dateField: BasicDateField.UpdatedAt, include: ListProductsInclude.PrepaidProductPricePoint } + try { const { result, ...httpResponse } = await productFamiliesController.listProductsForProductFamily(collect); // Get more response info... @@ -186,9 +187,9 @@ try { # Create Product Family -This method will create a Product Family within your Chargify site. Create a Product Family to act as a container for your products, components and coupons. +This method will create a Product Family within your Advanced Billing site. Create a Product Family to act as a container for your products, components and coupons. -Full documentation on how Product Families operate within the Chargify UI can be located [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405369633421). +Full documentation on how Product Families operate within the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261098936205-Product-Families). ```ts async createProductFamily( body?: CreateProductFamilyRequest, @@ -283,6 +284,7 @@ requestOptions?: RequestOptions): Promise> const collect = { dateField: BasicDateField.UpdatedAt } + try { const { result, ...httpResponse } = await productFamiliesController.listProductFamilies(collect); // Get more response info... @@ -340,7 +342,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `number` | Template, Required | The Chargify id of the product family | +| `id` | `number` | Template, Required | The Advanced Billing id of the product family | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type diff --git a/doc/controllers/product-price-points.md b/doc/controllers/product-price-points.md index 7891ac05..7d166b25 100644 --- a/doc/controllers/product-price-points.md +++ b/doc/controllers/product-price-points.md @@ -25,7 +25,7 @@ const productPricePointsController = new ProductPricePointsController(client); # Create Product Price Point -[Product Price Point Documentation](https://chargify.zendesk.com/hc/en-us/articles/4407755824155) +[Product Price Point Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261111947789-Product-Price-Points) ```ts async createProductPricePoint( productId: CreateProductPricePointProductId, @@ -64,7 +64,7 @@ const body: CreateProductPricePointRequest = { initialChargeInCents: BigInt(120000), initialChargeAfterTrial: false, expirationInterval: 12, - expirationIntervalUnit: IntervalUnit.Month, + expirationIntervalUnit: ExpirationIntervalUnit.Month, }, }; @@ -153,6 +153,7 @@ const collect = {Liquid error: Value cannot be null. (Parameter 'key') page: 2, perPage: 10 } + try { const { result, ...httpResponse } = await productPricePointsController.listProductPricePoints(collect); // Get more response info... @@ -445,8 +446,8 @@ requestOptions?: RequestOptions): Promise | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productId` | `number` | Template, Required | The Chargify id of the product to which the price point belongs | -| `pricePointId` | `number` | Template, Required | The Chargify id of the product price point | +| `productId` | `number` | Template, Required | The Advanced Billing id of the product to which the price point belongs | +| `pricePointId` | `number` | Template, Required | The Advanced Billing id of the product price point | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -519,8 +520,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productId` | `number` | Template, Required | The Chargify id of the product to which the price point belongs | -| `pricePointId` | `number` | Template, Required | The Chargify id of the product price point | +| `productId` | `number` | Template, Required | The Advanced Billing id of the product to which the price point belongs | +| `pricePointId` | `number` | Template, Required | The Advanced Billing id of the product price point | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -617,7 +618,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productPricePointId` | `number` | Template, Required | The Chargify id of the product price point | +| `productPricePointId` | `number` | Template, Required | The Advanced Billing id of the product price point | | `body` | [`CreateProductCurrencyPricesRequest \| undefined`](../../doc/models/create-product-currency-prices-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -824,7 +825,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productPricePointId` | `number` | Template, Required | The Chargify id of the product price point | +| `productPricePointId` | `number` | Template, Required | The Advanced Billing id of the product price point | | `body` | [`UpdateCurrencyPricesRequest \| undefined`](../../doc/models/update-currency-prices-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -941,6 +942,7 @@ const collect = { page: 2, perPage: 50 } + try { const { result, ...httpResponse } = await productPricePointsController.listAllProductPricePoints(collect); // Get more response info... diff --git a/doc/controllers/products.md b/doc/controllers/products.md index 87eedad0..151dd365 100644 --- a/doc/controllers/products.md +++ b/doc/controllers/products.md @@ -20,10 +20,10 @@ const productsController = new ProductsController(client); # Create Product -Use this method to create a product within your Chargify site. +Use this method to create a product within your Advanced Billing site. -+ [Products Documentation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405561405709) -+ [Changing a Subscription's Product](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404225334669-Product-Changes-Migrations) ++ [Products Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261090117645-Products-Overview) ++ [Changing a Subscription's Product](https://maxio.zendesk.com/hc/en-us/articles/24252069837581-Product-Changes-and-Migrations) ```ts async createProduct( productFamilyId: string, @@ -136,7 +136,7 @@ try { # Read Product -This endpoint allows you to read the current details of a product that you've created in Chargify. +This endpoint allows you to read the current details of a product that you've created in Advanced Billing. ```ts async readProduct( productId: number, @@ -147,7 +147,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productId` | `number` | Template, Required | The Chargify id of the product | +| `productId` | `number` | Template, Required | The Advanced Billing id of the product | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -237,7 +237,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productId` | `number` | Template, Required | The Chargify id of the product | +| `productId` | `number` | Template, Required | The Advanced Billing id of the product | | `body` | [`CreateOrUpdateProductRequest \| undefined`](../../doc/models/create-or-update-product-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -332,7 +332,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `productId` | `number` | Template, Required | The Chargify id of the product | +| `productId` | `number` | Template, Required | The Advanced Billing id of the product | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -560,6 +560,7 @@ const collect = { includeArchived: true, include: ListProductsInclude.PrepaidProductPricePoint } + try { const { result, ...httpResponse } = await productsController.listProducts(collect); // Get more response info... diff --git a/doc/controllers/proforma-invoices.md b/doc/controllers/proforma-invoices.md index 550f9779..4d730ca9 100644 --- a/doc/controllers/proforma-invoices.md +++ b/doc/controllers/proforma-invoices.md @@ -117,6 +117,7 @@ const collect = { payments: false, customFields: false } + try { const { result, ...httpResponse } = await proformaInvoicesController.listSubscriptionGroupProformaInvoices(collect); // Get more response info... @@ -293,6 +294,7 @@ const collect = { payments: false, customFields: false } + try { const { result, ...httpResponse } = await proformaInvoicesController.listProformaInvoices(collect); // Get more response info... diff --git a/doc/controllers/reason-codes.md b/doc/controllers/reason-codes.md index 7954c1c8..01adbfb0 100644 --- a/doc/controllers/reason-codes.md +++ b/doc/controllers/reason-codes.md @@ -23,13 +23,13 @@ const reasonCodesController = new ReasonCodesController(client); ReasonCodes are a way to gain a high level view of why your customers are cancelling the subcription to your product or service. -Add a set of churn reason codes to be displayed in-app and/or the Chargify Billing Portal. As your subscribers decide to cancel their subscription, learn why they decided to cancel. +Add a set of churn reason codes to be displayed in-app and/or the Maxio Billing Portal. As your subscribers decide to cancel their subscription, learn why they decided to cancel. ## Reason Code Documentation -Full documentation on how Reason Codes operate within Chargify can be located under the following links. +Full documentation on how Reason Codes operate within Advanced Billing can be located under the following links. -[Churn Reason Codes](https://chargify.zendesk.com/hc/en-us/articles/4407896775579#churn-reason-codes) +[Churn Reason Codes](https://maxio.zendesk.com/hc/en-us/articles/24286647554701-Churn-Reason-Codes) ## Create Reason Code @@ -110,6 +110,7 @@ const collect = { page: 2, perPage: 50 } + try { const { result, ...httpResponse } = await reasonCodesController.listReasonCodes(collect); // Get more response info... @@ -176,7 +177,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `reasonCodeId` | `number` | Template, Required | The Chargify id of the reason code | +| `reasonCodeId` | `number` | Template, Required | The Advanced Billing id of the reason code | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -221,7 +222,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `reasonCodeId` | `number` | Template, Required | The Chargify id of the reason code | +| `reasonCodeId` | `number` | Template, Required | The Advanced Billing id of the reason code | | `body` | [`UpdateReasonCodeRequest \| undefined`](../../doc/models/update-reason-code-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -266,7 +267,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `reasonCodeId` | `number` | Template, Required | The Chargify id of the reason code | +| `reasonCodeId` | `number` | Template, Required | The Advanced Billing id of the reason code | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type diff --git a/doc/controllers/referral-codes.md b/doc/controllers/referral-codes.md index 59cd12fc..347e3514 100644 --- a/doc/controllers/referral-codes.md +++ b/doc/controllers/referral-codes.md @@ -15,7 +15,7 @@ Use this method to determine if the referral code is valid and applicable within ## Referrals Documentation -Full documentation on how to use the referrals feature in the Chargify UI can be located [here](https://chargify.zendesk.com/hc/en-us/articles/4407802831643). +Full documentation on how to use the referrals feature in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/sections/24286965611405-Referrals). ## Server Response diff --git a/doc/controllers/sales-commissions.md b/doc/controllers/sales-commissions.md index b5b5bce3..c00cebb5 100644 --- a/doc/controllers/sales-commissions.md +++ b/doc/controllers/sales-commissions.md @@ -23,7 +23,7 @@ Endpoint returns subscriptions with associated sales reps The Sales Commission API differs from other Chargify API endpoints. This resource is associated with the seller itself. Up to now all available resources were at the level of the site, therefore creating the API Key per site was a sufficient solution. To share resources at the seller level, a new authentication method was introduced, which is user authentication. Creating an API Key for a user is a required step to correctly use the Sales Commission API, more details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication). -Access to the Sales Commission API endpoints is available to users with financial access, where the seller has the Advanced Analytics component enabled. For further information on getting access to Advanced Analytics please contact Chargify support. +Access to the Sales Commission API endpoints is available to users with financial access, where the seller has the Advanced Analytics component enabled. For further information on getting access to Advanced Analytics please contact Maxio support. > Note: The request is at seller level, it means `<>` variable will be replaced by `app` @@ -60,6 +60,7 @@ const collect = { page: 2, perPage: 100 } + try { const { result, ...httpResponse } = await salesCommissionsController.listSalesCommissionSettings(collect); // Get more response info... @@ -115,7 +116,7 @@ Endpoint returns sales rep list with details The Sales Commission API differs from other Chargify API endpoints. This resource is associated with the seller itself. Up to now all available resources were at the level of the site, therefore creating the API Key per site was a sufficient solution. To share resources at the seller level, a new authentication method was introduced, which is user authentication. Creating an API Key for a user is a required step to correctly use the Sales Commission API, more details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication). -Access to the Sales Commission API endpoints is available to users with financial access, where the seller has the Advanced Analytics component enabled. For further information on getting access to Advanced Analytics please contact Chargify support. +Access to the Sales Commission API endpoints is available to users with financial access, where the seller has the Advanced Analytics component enabled. For further information on getting access to Advanced Analytics please contact Maxio support. > Note: The request is at seller level, it means `<>` variable will be replaced by `app` @@ -152,6 +153,7 @@ const collect = { page: 2, perPage: 100 } + try { const { result, ...httpResponse } = await salesCommissionsController.listSalesReps(collect); // Get more response info... @@ -256,7 +258,7 @@ Endpoint returns sales rep and attached subscriptions details. The Sales Commission API differs from other Chargify API endpoints. This resource is associated with the seller itself. Up to now all available resources were at the level of the site, therefore creating the API Key per site was a sufficient solution. To share resources at the seller level, a new authentication method was introduced, which is user authentication. Creating an API Key for a user is a required step to correctly use the Sales Commission API, more details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication). -Access to the Sales Commission API endpoints is available to users with financial access, where the seller has the Advanced Analytics component enabled. For further information on getting access to Advanced Analytics please contact Chargify support. +Access to the Sales Commission API endpoints is available to users with financial access, where the seller has the Advanced Analytics component enabled. For further information on getting access to Advanced Analytics please contact Maxio support. > Note: The request is at seller level, it means `<>` variable will be replaced by `app` @@ -275,7 +277,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `sellerId` | `string` | Template, Required | The Chargify id of your seller account | -| `salesRepId` | `string` | Template, Required | The Chargify id of sales rep. | +| `salesRepId` | `string` | Template, Required | The Advanced Billing id of sales rep. | | `authorization` | `string \| undefined` | Header, Optional | For authorization use user API key. See details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication). | | `liveMode` | `boolean \| undefined` | Query, Optional | This parameter indicates if records should be fetched from live mode sites. Default value is true. | | `page` | `number \| undefined` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`. | diff --git a/doc/controllers/sites.md b/doc/controllers/sites.md index af62ef16..5d16fd53 100644 --- a/doc/controllers/sites.md +++ b/doc/controllers/sites.md @@ -19,9 +19,9 @@ const sitesController = new SitesController(client); This endpoint allows you to fetch some site data. -Full documentation on Sites in the Chargify UI can be located [here](https://chargify.zendesk.com/hc/en-us/articles/4407870738587). +Full documentation on Sites in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/sections/24250550707085-Sites). -Specifically, the [Clearing Site Data](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405428327309) section is extremely relevant to this endpoint documentation. +Specifically, the [Clearing Site Data](https://maxio.zendesk.com/hc/en-us/articles/24250617028365-Clearing-Site-Data) section is extremely relevant to this endpoint documentation. #### Relationship invoicing enabled @@ -32,7 +32,7 @@ If site has RI enabled then you will see more settings like: "whopays_default_payer": "self" You can read more about these settings here: -[Who Pays & Customer Hierarchy](https://chargify.zendesk.com/hc/en-us/articles/4407746683291) +[Who Pays & Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays) ```ts async readSite(requestOptions?: RequestOptions): Promise> @@ -183,6 +183,7 @@ const collect = { page: 2, perPage: 50 } + try { const { result, ...httpResponse } = await sitesController.listChargifyJsPublicKeys(collect); // Get more response info... diff --git a/doc/controllers/subscription-components.md b/doc/controllers/subscription-components.md index 66421c1a..dcc87edb 100644 --- a/doc/controllers/subscription-components.md +++ b/doc/controllers/subscription-components.md @@ -44,7 +44,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `subscriptionId` | `number` | Template, Required | The Chargify id of the subscription | -| `componentId` | `number` | Template, Required | The Chargify id of the component | +| `componentId` | `number` | Template, Required | The Advanced Billing id of the component | | `body` | [`CreateAllocationRequest \| undefined`](../../doc/models/create-allocation-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -588,9 +589,9 @@ This endpoint returns the 50 most recent Allocations, ordered by most recent fir When a subscription's on/off component has been toggled to on (`1`) or off (`0`), usage will be logged in this response. -## Querying data via Chargify gem +## Querying data via Advanced Billing gem -You can also query the current quantity via the [official Chargify Gem.](http://github.com/chargify/chargify_api_ares) +You can also query the current quantity via the [official Advanced Billing Gem.](http://github.com/chargify/chargify_api_ares) ```# First way component = Chargify::Subscription::Component.find(1, :params => {:subscription_id => 7}) @@ -615,7 +616,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `subscriptionId` | `number` | Template, Required | The Chargify id of the subscription | -| `componentId` | `number` | Template, Required | The Chargify id of the component | +| `componentId` | `number` | Template, Required | The Advanced Billing id of the component | | `page` | `number \| undefined` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -817,7 +818,7 @@ try { # Preview Allocations -Chargify offers the ability to preview a potential subscription's **quantity-based** or **on/off** component allocation in the middle of the current billing period. This is useful if you want users to be able to see the effect of a component operation before actually doing it. +Advanced Billing offers the ability to preview a potential subscription's **quantity-based** or **on/off** component allocation in the middle of the current billing period. This is useful if you want users to be able to see the effect of a component operation before actually doing it. ## Fine-grained Component Control: Use with multiple `upgrade_charge`s or `downgrade_credits` @@ -1014,8 +1015,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `subscriptionId` | `number` | Template, Required | The Chargify id of the subscription | -| `componentId` | `number` | Template, Required | The Chargify id of the component | -| `allocationId` | `number` | Template, Required | The Chargify id of the allocation | +| `componentId` | `number` | Template, Required | The Advanced Billing id of the component | +| `allocationId` | `number` | Template, Required | The Advanced Billing id of the allocation | | `body` | [`UpdateAllocationExpirationDate \| undefined`](../../doc/models/update-allocation-expiration-date.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -1088,8 +1089,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `subscriptionId` | `number` | Template, Required | The Chargify id of the subscription | -| `componentId` | `number` | Template, Required | The Chargify id of the component | -| `allocationId` | `number` | Template, Required | The Chargify id of the allocation | +| `componentId` | `number` | Template, Required | The Advanced Billing id of the component | +| `allocationId` | `number` | Template, Required | The Advanced Billing id of the allocation | | `body` | [`CreditSchemeRequest \| undefined`](../../doc/models/credit-scheme-request.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -1139,12 +1140,12 @@ try { ## Documentation -Full documentation on how to create Components in the Chargify UI can be located [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677#creating-components). Additionally, for information on how to record component usage against a subscription, please see the following resources: +Full documentation on how to create Components in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive-Components). Additionally, for information on how to record component usage against a subscription, please see the following resources: -+ [Recording Metered Component Usage](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404527849997#reporting-metered-component-usage) -+ [Reporting Prepaid Component Status](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404527849997#reporting-prepaid-component-status) ++ [Recording Metered Component Usage](https://maxio.zendesk.com/hc/en-us/articles/24251890500109-Reporting-Component-Allocations#reporting-metered-component-usage) ++ [Reporting Prepaid Component Status](https://maxio.zendesk.com/hc/en-us/articles/24251890500109-Reporting-Component-Allocations#reporting-prepaid-component-status) -You may choose to report metered or prepaid usage to Chargify as often as you wish. You may report usage as it happens. You may also report usage periodically, such as each night or once per billing period. If usage events occur in your system very frequently (on the order of thousands of times an hour), it is best to accumulate usage into batches on your side, and then report those batches less frequently, such as daily. This will ensure you remain below any API throttling limits. If your use case requires higher rates of usage reporting, we recommend utilizing Events Based Components. +You may choose to report metered or prepaid usage to Advanced Billing as often as you wish. You may report usage as it happens. You may also report usage periodically, such as each night or once per billing period. If usage events occur in your system very frequently (on the order of thousands of times an hour), it is best to accumulate usage into batches on your side, and then report those batches less frequently, such as daily. This will ensure you remain below any API throttling limits. If your use case requires higher rates of usage reporting, we recommend utilizing Events Based Components. ## Create Usage for Subscription @@ -1152,7 +1153,7 @@ This endpoint allows you to record an instance of metered or prepaid usage for a ## Price Point ID usage -If you are using price points, for metered and prepaid usage components, Chargify gives you the option to specify a price point in your request. +If you are using price points, for metered and prepaid usage components, Advanced Billing gives you the option to specify a price point in your request. You do not need to specify a price point ID. If a price point is not included, the default price point for the component will be used when the usage is recorded. @@ -1326,6 +1327,7 @@ const collect = { page: 2, perPage: 50 } + try { const { result, ...httpResponse } = await subscriptionComponentsController.listUsages(collect); // Get more response info... @@ -1374,15 +1376,16 @@ try { In order to bill your subscribers on your Events data under the Events-Based Billing feature, the components must be activated for the subscriber. -Learn more about the role of activation in the [Events-Based Billing docs](https://chargify.zendesk.com/hc/en-us/articles/4407720810907#activating-components-for-subscribers). +Learn more about the role of activation in the [Events-Based Billing docs](https://maxio.zendesk.com/hc/en-us/articles/24260323329805-Events-Based-Billing-Overview). -Use this endpoint to activate an event-based component for a single subscription. Activating an event-based component causes Chargify to bill for events when the subscription is renewed. +Use this endpoint to activate an event-based component for a single subscription. Activating an event-based component causes Advanced Billing to bill for events when the subscription is renewed. *Note: it is possible to stream events for a subscription at any time, regardless of component activation status. The activation status only determines if the subscription should be billed for event-based component usage at renewal.* ```ts async activateEventBasedComponent( subscriptionId: number, componentId: number, + body?: ActivateEventBasedComponent, requestOptions?: RequestOptions): Promise> ``` @@ -1390,8 +1393,9 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `subscriptionId` | `number` | Template, Required | The Chargify id of the subscription | -| `componentId` | `number` | Template, Required | The Chargify id of the component | +| `subscriptionId` | `number` | Template, Required | The Advanced Billing id of the subscription | +| `componentId` | `number` | Template, Required | The Advanced Billing id of the component | +| `body` | [`ActivateEventBasedComponent \| undefined`](../../doc/models/activate-event-based-component.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -1405,10 +1409,30 @@ const subscriptionId = 222; const componentId = 222; +const body: ActivateEventBasedComponent = { + pricePointId: 1, + billingSchedule: { + initialBillingAt: '2022-01-01', + }, + customPrice: { + prices: [ + { + startingQuantity: 1, + unitPrice: '5.0', + } + ], + taxIncluded: false, + pricingScheme: PricingScheme.PerUnit, + interval: 30, + intervalUnit: IntervalUnit.Day, + }, +}; + try { const { result, ...httpResponse } = await subscriptionComponentsController.activateEventBasedComponent( subscriptionId, - componentId + componentId, + body ); // Get more response info... // const { statusCode, headers } = httpResponse; @@ -1423,7 +1447,7 @@ try { # Deactivate Event Based Component -Use this endpoint to deactivate an event-based component for a single subscription. Deactivating the event-based component causes Chargify to ignore related events at subscription renewal. +Use this endpoint to deactivate an event-based component for a single subscription. Deactivating the event-based component causes Advanced Billing to ignore related events at subscription renewal. ```ts async deactivateEventBasedComponent( subscriptionId: number, @@ -1435,8 +1459,8 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `subscriptionId` | `number` | Template, Required | The Chargify id of the subscription | -| `componentId` | `number` | Template, Required | The Chargify id of the component | +| `subscriptionId` | `number` | Template, Required | The Advanced Billing id of the subscription | +| `componentId` | `number` | Template, Required | The Advanced Billing id of the component | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -1470,19 +1494,19 @@ try { ## Documentation -Events-Based Billing is an evolved form of metered billing that is based on data-rich events streamed in real-time from your system to Chargify. +Events-Based Billing is an evolved form of metered billing that is based on data-rich events streamed in real-time from your system to Advanced Billing. These events can then be transformed, enriched, or analyzed to form the computed totals of usage charges billed to your customers. -This API allows you to stream events into the Chargify data ingestion engine. +This API allows you to stream events into the Advanced Billing data ingestion engine. -Learn more about the feature in general in the [Events-Based Billing help docs](https://chargify.zendesk.com/hc/en-us/articles/4407720613403). +Learn more about the feature in general in the [Events-Based Billing help docs](https://maxio.zendesk.com/hc/en-us/articles/24260323329805-Events-Based-Billing-Overview). ## Record Event Use this endpoint to record a single event. -*Note: this endpoint differs from the standard Chargify endpoints in that the URL subdomain will be `events` and your site subdomain will be included in the URL path. For example:* +*Note: this endpoint differs from the standard Chargify API endpoints in that the URL subdomain will be `events` and your site subdomain will be included in the URL path. For example:* ``` https://events.chargify.com/my-site-subdomain/events/my-stream-api-handle @@ -1502,7 +1526,7 @@ requestOptions?: RequestOptions): Promise> | --- | --- | --- | --- | | `subdomain` | `string` | Template, Required | Your site's subdomain | | `apiHandle` | `string` | Template, Required | Identifies the Stream for which the event should be published. | -| `storeUid` | `string \| undefined` | Query, Optional | If you've attached your own Keen project as a Chargify event data-store, use this parameter to indicate the data-store. | +| `storeUid` | `string \| undefined` | Query, Optional | If you've attached your own Keen project as an Advanced Billing event data-store, use this parameter to indicate the data-store. | | `body` | [`EBBEvent \| undefined`](../../doc/models/ebb-event.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -1546,7 +1570,7 @@ try { Use this endpoint to record a collection of events. -*Note: this endpoint differs from the standard Chargify endpoints in that the subdomain will be `events` and your site subdomain will be included in the URL path.* +*Note: this endpoint differs from the standard Chargify API endpoints in that the subdomain will be `events` and your site subdomain will be included in the URL path.* A maximum of 1000 events can be published in a single request. A 422 will be returned if this limit is exceeded. @@ -1564,7 +1588,7 @@ requestOptions?: RequestOptions): Promise> | --- | --- | --- | --- | | `subdomain` | `string` | Template, Required | Your site's subdomain | | `apiHandle` | `string` | Template, Required | Identifies the Stream for which the events should be published. | -| `storeUid` | `string \| undefined` | Query, Optional | If you've attached your own Keen project as a Chargify event data-store, use this parameter to indicate the data-store. | +| `storeUid` | `string \| undefined` | Query, Optional | If you've attached your own Keen project as an Advanced Billing event data-store, use this parameter to indicate the data-store. | | `body` | [`EBBEvent[] \| undefined`](../../doc/models/ebb-event.md) | Body, Optional | - | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -1679,6 +1703,7 @@ const collect = { ], include: ListSubscriptionComponentsInclude.Subscription } + try { const { result, ...httpResponse } = await subscriptionComponentsController.listSubscriptionComponentsForSite(collect); // Get more response info... diff --git a/doc/controllers/subscription-group-invoice-account.md b/doc/controllers/subscription-group-invoice-account.md index c322b0a9..5a7a728c 100644 --- a/doc/controllers/subscription-group-invoice-account.md +++ b/doc/controllers/subscription-group-invoice-account.md @@ -113,6 +113,7 @@ const collect = { endDate: '2024-01-31', } } + try { const { result, ...httpResponse } = await subscriptionGroupInvoiceAccountController.listPrepaymentsForSubscriptionGroup(collect); // Get more response info... diff --git a/doc/controllers/subscription-groups.md b/doc/controllers/subscription-groups.md index 6881dc88..ed315621 100644 --- a/doc/controllers/subscription-groups.md +++ b/doc/controllers/subscription-groups.md @@ -203,6 +203,7 @@ const collect = { SubscriptionGroupsListInclude.AccountBalances ] } + try { const { result, ...httpResponse } = await subscriptionGroupsController.listSubscriptionGroups(collect); // Get more response info... @@ -497,7 +498,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `subscriptionId` | `number` | Template, Required | The Chargify id of the subscription | -| `noteId` | `number` | Template, Required | The Chargify id of the note | +| `noteId` | `number` | Template, Required | The Advanced Billing id of the note | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -223,7 +224,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `subscriptionId` | `number` | Template, Required | The Chargify id of the subscription | -| `noteId` | `number` | Template, Required | The Chargify id of the note | +| `noteId` | `number` | Template, Required | The Advanced Billing id of the note | | `body` | [`UpdateSubscriptionNoteRequest \| undefined`](../../doc/models/update-subscription-note-request.md) | Body, Optional | Updatable fields for Subscription Note | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -277,7 +278,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `subscriptionId` | `number` | Template, Required | The Chargify id of the subscription | -| `noteId` | `number` | Template, Required | The Chargify id of the note | +| `noteId` | `number` | Template, Required | The Advanced Billing id of the note | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type diff --git a/doc/controllers/subscription-products.md b/doc/controllers/subscription-products.md index 7577cd85..6d4a73e2 100644 --- a/doc/controllers/subscription-products.md +++ b/doc/controllers/subscription-products.md @@ -26,7 +26,7 @@ Subscriptions should be in the `active` or `trialing` state in order to be migra ## Migrations Documentation -Full documentation on how to record Migrations in the Chargify UI can be located [here](https://chargify.zendesk.com/hc/en-us/articles/4407898373531). +Full documentation on how to record Migrations in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24181589372429-Data-Migration-to-Advanced-Billing). ## Failed Migrations @@ -34,7 +34,7 @@ One of the most common ways that a migration can fail is when the attempt is mad ## Migration 3D Secure - Stripe -It may happen that a payment needs 3D Secure Authentication when the subscription is migrated to a new product; this is referred to in our help docs as a [post-authentication flow](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405177432077#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response: +It may happen that a payment needs 3D Secure Authentication when the subscription is migrated to a new product; this is referred to in our help docs as a [post-authentication flow](https://maxio.zendesk.com/hc/en-us/articles/24176278996493-Testing-Implementing-3D-Secure#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response: ```json { diff --git a/doc/controllers/subscription-status.md b/doc/controllers/subscription-status.md index 7ee8c59e..45cc27d8 100644 --- a/doc/controllers/subscription-status.md +++ b/doc/controllers/subscription-status.md @@ -24,7 +24,7 @@ const subscriptionStatusController = new SubscriptionStatusController(client); # Retry Subscription -Chargify offers the ability to retry collecting the balance due on a past due Subscription without waiting for the next scheduled attempt. +Advanced Billing offers the ability to retry collecting the balance due on a past due Subscription without waiting for the next scheduled attempt. ## Successful Reactivation @@ -899,10 +899,10 @@ try { # Reactivate Subscription -Chargify offers the ability to reactivate a previously canceled subscription. For details on how the reactivation works, and how to reactivate subscriptions through the application, see [reactivation](https://chargify.zendesk.com/hc/en-us/articles/4407898737691). +Advanced Billing offers the ability to reactivate a previously canceled subscription. For details on how the reactivation works, and how to reactivate subscriptions through the application, see [reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming). **Please note: The term -"resume" is used also during another process in Chargify. This occurs when an on-hold subscription is "resumed". This returns the subscription to an active state.** +"resume" is used also during another process in Advanced Billing. This occurs when an on-hold subscription is "resumed". This returns the subscription to an active state.** + The response returns the subscription object in the `active` or `trialing` state. + The `canceled_at` and `cancellation_message` fields do not have values. @@ -917,9 +917,9 @@ A resumed subscription's billing date remains the same as before it was canceled Consider a subscription which was created on June 1st, and would renew on July 1st. The subscription is then canceled on June 15. -If a reactivation with `resume: true` were attempted _before_ what would have been the next billing date of July 1st, then Chargify would resume the subscription. +If a reactivation with `resume: true` were attempted _before_ what would have been the next billing date of July 1st, then Advanced Billing would resume the subscription. -If a reactivation with `resume: true` were attempted _after_ what would have been the next billing date of July 1st, then Chargify would not resume the subscription, and instead it would be reactivated with a new billing period. +If a reactivation with `resume: true` were attempted _after_ what would have been the next billing date of July 1st, then Advanced Billing would not resume the subscription, and instead it would be reactivated with a new billing period. | Canceled | Reactivation | Resumable? | |---|---|---| @@ -1227,7 +1227,7 @@ try { # Initiate Delayed Cancellation -Chargify offers the ability to cancel a subscription at the end of the current billing period. This period is set by its current product. +Advanced Billing offers the ability to cancel a subscription at the end of the current billing period. This period is set by its current product. Requesting to cancel the subscription at the end of the period sets the `cancel_at_end_of_period` flag to true. @@ -1371,7 +1371,7 @@ try { The Chargify API allows you to preview a renewal by posting to the renewals endpoint. Renewal Preview is an object representing a subscription’s next assessment. You can retrieve it to see a snapshot of how much your customer will be charged on their next renewal. -The "Next Billing" amount and "Next Billing" date are already represented in the UI on each Subscriber's Summary. For more information, please see our documentation [here](https://chargify.zendesk.com/hc/en-us/articles/4407884887835#next-billing). +The "Next Billing" amount and "Next Billing" date are already represented in the UI on each Subscriber's Summary. For more information, please see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscriber-Interface-Overview). ## Optional Component Fields diff --git a/doc/controllers/subscriptions.md b/doc/controllers/subscriptions.md index a6fd3c7b..79998dfa 100644 --- a/doc/controllers/subscriptions.md +++ b/doc/controllers/subscriptions.md @@ -26,19 +26,19 @@ const subscriptionsController = new SubscriptionsController(client); # Create Subscription -Full documentation on how subscriptions operate within Chargify can be located under the following topics: +Full documentation on how subscriptions operate within Advanced Billing can be located under the following topics: -+ [Subscriptions Reference](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405577172749-Subscription-Introduction) -+ [Subscriptions Actions](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405510556557-Actions) -+ [Subscription Cancellation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405510556557-Actions#initiate-cancellation) -+ [Subscription Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404559291021-Reactivating-and-Resuming) -+ [Subscription Import](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404863655821-Imports) ++ [Subscriptions Reference](https://maxio.zendesk.com/hc/en-us/articles/24251526991757-Subscription-Overview) ++ [Subscriptions Actions](https://maxio.zendesk.com/hc/en-us/articles/24251983024653-Subscription-Actions-Overview) ++ [Subscription Cancellation](https://maxio.zendesk.com/hc/en-us/articles/24251957778829-Cancel-Subscriptions) ++ [Subscription Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) ++ [Subscription Import](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Imports) -When creating a subscription, you must specify a product and a customer. Credit card details may be required, depending on the options for the Product being subscribed ([see Product Options](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221#payment-method-settings)). +When creating a subscription, you must specify a product and a customer. Credit card details may be required, depending on the options for the Product being subscribed ([see Product Options](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing)). The product may be specified by `product_id` or by `product_handle` (API Handle). In similar fashion, to pass a particular product price point, you may either use `product_price_point_handle` or `product_price_point_id`. -An existing customer may be specified by a `customer_id` (ID within Chargify) or a `customer_reference` (unique value within your app that you have shared with Chargify via the reference attribute on a customer). You may also pass in an existing payment profile for that customer with `payment_profile_id`. A new customer may be created by providing `customer_attributes`. +An existing customer may be specified by a `customer_id` (ID within Advanced Billing) or a `customer_reference` (unique value within your app that you have shared with Advanced Billing via the reference attribute on a customer). You may also pass in an existing payment profile for that customer with `payment_profile_id`. A new customer may be created by providing `customer_attributes`. Credit card details may be required, depending on the options for the product being subscribed. The product can be specified by `product_id` or by `product_handle` (API Handle). @@ -46,13 +46,13 @@ If you are creating a subscription with a payment profile, the attribute to send ## Taxable Subscriptions -If your intent is to charge your subscribers tax via [Avalara Taxes](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405275711885-Avalara-VAT-Tax) or [Custom Taxes](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405069041549-Custom-Taxes), there are a few considerations to be made regarding collecting subscription data. +If your intent is to charge your subscribers tax via [Avalara Taxes](https://maxio.zendesk.com/hc/en-us/articles/24287043035661-Avalara-VAT-Tax) or [Custom Taxes](https://maxio.zendesk.com/hc/en-us/articles/24287044212749-Custom-Taxes), there are a few considerations to be made regarding collecting subscription data. For subscribers to be eligible to be taxed, the following information for the `customer` object or `payment_profile` object must by supplied: -+ A subscription to a [taxable product](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221-Product-Editing#tax-settings) -+ [Full valid billing or shipping address](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405356114317#full-address-required-for-taxable-subscriptions) to identify the tax locale -+ The portion of the address that houses the [state information](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405356114317#required-state-format-for-taxable-subscriptions) of either adddress must adhere to the ISO standard of a 2-3 character limit/format. -+ The portion of the address that houses the [country information](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405356114317#required-country-format-for-taxable-subscriptions) must adhere to the ISO standard of a 2 character limit/format. ++ A subscription to a [taxable product](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing#tax-settings) ++ [Full valid billing or shipping address](https://maxio.zendesk.com/hc/en-us/articles/24287008131853-Advanced-Billing-Managed-Sales-Tax#full-address-required-for-taxable-subscriptions) to identify the tax locale ++ The portion of the address that houses the [state information](https://maxio.zendesk.com/hc/en-us/articles/24287008131853-Advanced-Billing-Managed-Sales-Tax#required-state-format-for-taxable-subscriptions) of either adddress must adhere to the ISO standard of a 2-3 character limit/format. ++ The portion of the address that houses the [country information](https://maxio.zendesk.com/hc/en-us/articles/24287008131853-Advanced-Billing-Managed-Sales-Tax#required-country-format-for-taxable-subscriptions) must adhere to the ISO standard of a 2 character limit/format. ## Subscription Request Examples @@ -60,7 +60,7 @@ The subscription examples below will be split into two sections. The first section, "Subscription Customization", will focus on passing different information with a subscription, such as components, calendar billing, and custom fields. These examples will presume you are using a secure `chargify_token` generated by Chargify.js. -The second section, "Passing Payment Information", will focus on passing payment information into Chargify. Please be aware that collecting and sending Chargify raw card details requires PCI compliance on your end; these examples are provided as guidance. If your business is not PCI compliant, we recommend using Chargify.js to collect credit cards or bank accounts. +The second section, "Passing Payment Information", will focus on passing payment information into Advanced Billing. Please be aware that collecting and sending Advanced Billing raw card details requires PCI compliance on your end; these examples are provided as guidance. If your business is not PCI compliant, we recommend using Chargify.js to collect credit cards or bank accounts. # Subscription Customization @@ -109,7 +109,7 @@ Custom prices and price points can exist in harmony on a subscription. ## Subscription with Chargify.js token -The `chargify_token` can be obtained using [chargify.js](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDI0-overview). The token represents payment profile attributes that were provided by the customer in their browser and stored at the payment gateway. +The `chargify_token` can be obtained using [Chargify.js](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDI0-overview). The token represents payment profile attributes that were provided by the customer in their browser and stored at the payment gateway. The `payment_type` attribute may either be `credit_card` or `bank_account`, depending on the type of payment method being added. If a bank account is being passed, the payment attributes should be changed to `bank_account_attributes`. @@ -132,7 +132,7 @@ The `payment_type` attribute may either be `credit_card` or `bank_account`, depe ## Subscription with vault token -If you already have a customer and card stored in your payment gateway, you may create a subscription with a `vault_token`. Providing the last_four, card type and expiration date will allow the card to be displayed properly in the Chargify UI. +If you already have a customer and card stored in your payment gateway, you may create a subscription with a `vault_token`. Providing the last_four, card type and expiration date will allow the card to be displayed properly in the Advanced Billing UI. ```json { @@ -274,7 +274,7 @@ For more information on GoCardless, please view the following two resources: + [Payment Profiles via API for GoCardless](https://developers.chargify.com/docs/api-docs/1f10a4f170405-create-payment-profile#gocardless) -+ [Full documentation on GoCardless](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404501889677) ++ [Full documentation on GoCardless](https://maxio.zendesk.com/hc/en-us/articles/24176159136909-GoCardless) + [Using Chargify.js with GoCardless - minimal example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-direct-debit-gocardless-gateway) @@ -336,7 +336,7 @@ For more information on Stripe Direct Debit, please view the following two resou + [Payment Profiles via API for Stripe SEPA Direct Debit](https://developers.chargify.com/docs/api-docs/1f10a4f170405-create-payment-profile#sepa-direct-debit) -+ [Full documentation on Stripe Direct Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) ++ [Full documentation on Stripe Direct Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) + [Using Chargify.js with Stripe SEPA or BECS Direct Debit - minimal example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway) @@ -366,7 +366,7 @@ For more information on Stripe Direct Debit, please view the following two resou + [Payment Profiles via API for Stripe BECS Direct Debit]($e/Payment%20Profiles/createPaymentProfile) -+ [Full documentation on Stripe Direct Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) ++ [Full documentation on Stripe Direct Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) + [Using Chargify.js with Stripe SEPA, BECS or BACS Direct Debit - minimal example](page:development-tools/chargify-js/examples#minimal-example-with-sepa-becs-or-bacs-direct-debit-stripe-gateway) @@ -397,7 +397,7 @@ For more information on Stripe Direct Debit, please view the following two resou + [Payment Profiles via API for Stripe BACS Direct Debit]($e/Payment%20Profiles/createPaymentProfile) -+ [Full documentation on Stripe Direct Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) ++ [Full documentation on Stripe Direct Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) + [Using Chargify.js with Stripe SEPA, BECS or BACS Direct Debit - minimal example](page:development-tools/chargify-js/examples#minimal-example-with-sepa-becs-or-bacs-direct-debit-stripe-gateway) @@ -429,7 +429,7 @@ For more information on Stripe Direct Debit, please view the following two resou ## 3D Secure - Stripe -It may happen that a payment needs 3D Secure Authentication when the subscription is created; this is referred to in our help docs as a [post-authentication flow](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405177432077#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response: +It may happen that a payment needs 3D Secure Authentication when the subscription is created; this is referred to in our help docs as a [post-authentication flow](https://maxio.zendesk.com/hc/en-us/articles/24176278996493-Testing-Implementing-3D-Secure#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response: ```json { @@ -457,7 +457,7 @@ The final URL that you send a customer to to complete 3D Secure may resemble the ## 3D Secure - Checkout -It may happen that a payment needs 3D Secure Authentication when the subscription is created; this is referred to in our help docs as a [post-authentication flow](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405177432077#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response: +It may happen that a payment needs 3D Secure Authentication when the subscription is created; this is referred to in our help docs as a [post-authentication flow](https://maxio.zendesk.com/hc/en-us/articles/24176278996493-Testing-Implementing-3D-Secure#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response: ```json { @@ -500,16 +500,16 @@ You may wish to redirect customers to different pages depending on whether their Subscriptions can be “imported” via the API to handle the following scenarios: -+ You already have existing subscriptions with specific start and renewal dates that you would like to import to Chargify ++ You already have existing subscriptions with specific start and renewal dates that you would like to import to Advanced Billing + You already have credit cards stored in your provider’s vault and you would like to create subscriptions using those tokens Before importing, you should have already set up your products to match your offerings. Then, you can create Subscriptions via the API just like you normally would, but using a few special attributes. -Full documentation on how import Subscriptions using the **import tool** in the Chargify UI can be located [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404863655821#imports-0-0). +Full documentation on how import Subscriptions using the **import tool** in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Imports). ### Important Notices and Disclaimers regarding Imports -Before performing a bulk import of subscriptions via the API, we suggest reading the [Subscriptions Import](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404863655821#important-notices-and-disclaimers) instructions to understand the repurcussions of a large import. +Before performing a bulk import of subscriptions via the API, we suggest reading the [Subscriptions Import](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Imports) instructions to understand the repurcussions of a large import. ### Subscription Input Attributes @@ -527,7 +527,7 @@ When importing PayPal type payment profiles, please set `payment_type` to `paypa ### Stripe ACH Imports -If the bank account has already been verified, currently you will need to create the customer, create the payment profile in Chargify - setting verified=true, then create a subscription using the customer_id and payment_profile_id. +If the bank account has already been verified, currently you will need to create the customer, create the payment profile in Advanced Billing - setting verified=true, then create a subscription using the customer_id and payment_profile_id. ### Webhooks During Import @@ -591,7 +591,7 @@ When reading a subscription via API, they will return a top-level attribute call ### Subscription in a Customer Hierarchy -For sites making use of the [Relationship Billing](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices) and [Customer Hierarchy](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404900384141) features, it is possible to create subscriptions within a customer hierarchy. This can be achieved through the API by passing group parameters in the **Create Subscription** request. +For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays) features, it is possible to create subscriptions within a customer hierarchy. This can be achieved through the API by passing group parameters in the **Create Subscription** request. + The `group` parameters are optional and consist of the required `target` and optional `billing` parameters. @@ -605,7 +605,7 @@ The optional `billing` parameters specify how some aspects of the billing for th ### Subscription in a Subscription Group -For sites making use of [Relationship Billing](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices) it may be desireable to create a subscription as part of a [subscription group](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405577356173) in order to rely on [invoice consolidation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404980119949). This can be achieved through the API by passing group parameters in the Create Subscription request. The `group` parameters are optional and consist of the required `target` and optional `billing` parameters. +For sites making use of [Relationship Billing](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview) it may be desireable to create a subscription as part of a [subscription group](https://maxio.zendesk.com/hc/en-us/articles/24252172565005-Subscription-Groups-Overview) in order to rely on [invoice consolidation](https://maxio.zendesk.com/hc/en-us/articles/24252269909389-Invoice-Consolidation). This can be achieved through the API by passing group parameters in the Create Subscription request. The `group` parameters are optional and consist of the required `target` and optional `billing` parameters. The `target` parameters specify an existing subscription with which the newly created subscription should be grouped. If the target subscription is already part of a group, the new subscription will become a member of the group as well. If the target subscription is not part of a group, a new group will be created and both the target and the new subscription will become part of the group with the target as the group's primary subscription. @@ -955,6 +955,7 @@ const collect = { SubscriptionListInclude.SelfServicePageToken ] } + try { const { result, ...httpResponse } = await subscriptionsController.listSubscriptions(collect); // Get more response info... @@ -1373,9 +1374,9 @@ try { This API endpoint allows you to set certain subscription fields that are usually managed for you automatically. Some of the fields can be set via the normal Subscriptions Update API, but others can only be set using this endpoint. -This endpoint is provided for cases where you need to “align” Chargify data with data that happened in your system, perhaps before you started using Chargify. For example, you may choose to import your historical subscription data, and would like the activation and cancellation dates in Chargify to match your existing historical dates. Chargify does not backfill historical events (i.e. from the Events API), but some static data can be changed via this API. +This endpoint is provided for cases where you need to “align” Advanced Billing data with data that happened in your system, perhaps before you started using Advanced Billing. For example, you may choose to import your historical subscription data, and would like the activation and cancellation dates in Advanced Billing to match your existing historical dates. Advanced Billing does not backfill historical events (i.e. from the Events API), but some static data can be changed via this API. -Why are some fields only settable from this endpoint, and not the normal subscription create and update endpoints? Because we want users of this endpoint to be aware that these fields are usually managed by Chargify, and using this API means **you are stepping out on your own.** +Why are some fields only settable from this endpoint, and not the normal subscription create and update endpoints? Because we want users of this endpoint to be aware that these fields are usually managed by Advanced Billing, and using this API means **you are stepping out on your own.** Changing these fields will not affect any other attributes. For example, adding an expiration date will not affect the next assessment date on the subscription. @@ -1612,7 +1613,7 @@ try { The Chargify API allows you to preview a subscription by POSTing the same JSON or XML as for a subscription creation. -The "Next Billing" amount and "Next Billing" date are represented in each Subscriber's Summary. For more information, please see our documentation [here](https://chargify.zendesk.com/hc/en-us/articles/4407884887835#next-billing). +The "Next Billing" amount and "Next Billing" date are represented in each Subscriber's Summary. For more information, please see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscriber-Interface-Overview). ## Side effects @@ -1626,9 +1627,9 @@ This endpoint will preview taxes applicable to a purchase. In order for taxes to + The preview must be for the purchase of a taxable product or component, or combination of the two. + The subscription payload must contain a full billing or shipping address in order to calculate tax -For more information about creating taxable previews, please see our documentation guide on how to create [taxable subscriptions.](https://chargify.zendesk.com/hc/en-us/articles/4407904217755#creating-taxable-subscriptions) +For more information about creating taxable previews, please see our documentation guide on how to create [taxable subscriptions.](https://maxio.zendesk.com/hc/en-us/sections/24287012349325-Taxes) -You do **not** need to include a card number to generate tax information when you are previewing a subscription. However, please note that when you actually want to create the subscription, you must include the credit card information if you want the billing address to be stored in Chargify. The billing address and the credit card information are stored together within the payment profile object. Also, you may not send a billing address to Chargify without payment profile information, as the address is stored on the card. +You do **not** need to include a card number to generate tax information when you are previewing a subscription. However, please note that when you actually want to create the subscription, you must include the credit card information if you want the billing address to be stored in Advanced Billing. The billing address and the credit card information are stored together within the payment profile object. Also, you may not send a billing address to Advanced Billing without payment profile information, as the address is stored on the card. You can pass shipping and billing addresses and still decide not to calculate taxes. To do that, pass `skip_billing_manifest_taxes: true` attribute. @@ -1796,7 +1797,7 @@ try { # Apply Coupons to Subscription -An existing subscription can accommodate multiple discounts/coupon codes. This is only applicable if each coupon is stackable. For more information on stackable coupons, we recommend reviewing our [coupon documentation.](https://chargify.zendesk.com/hc/en-us/articles/4407755909531#stackable-coupons) +An existing subscription can accommodate multiple discounts/coupon codes. This is only applicable if each coupon is stackable. For more information on stackable coupons, we recommend reviewing our [coupon documentation.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#stackability-rules) ## Query Parameters vs Request Body Parameters @@ -2013,7 +2014,7 @@ try { Use this endpoint to remove a coupon from an existing subscription. -For more information on the expected behaviour of removing a coupon from a subscription, please see our documentation [here.](https://chargify.zendesk.com/hc/en-us/articles/4407896488987#removing-a-coupon) +For more information on the expected behaviour of removing a coupon from a subscription, please see our documentation [here.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#removing-a-coupon) ```ts async removeCouponFromSubscription( subscriptionId: number, @@ -2065,14 +2066,14 @@ try { # Activate Subscription -Chargify offers the ability to activate awaiting signup and trialing subscriptions. This feature is only available on the Relationship Invoicing architecture. Subscriptions in a group may not be activated immediately. +Advanced Billing offers the ability to activate awaiting signup and trialing subscriptions. This feature is only available on the Relationship Invoicing architecture. Subscriptions in a group may not be activated immediately. For details on how the activation works, and how to activate subscriptions through the application, see [activation](#). The `revert_on_failure` parameter controls the behavior upon activation failure. -- If set to `true` and something goes wrong i.e. payment fails, then Chargify will not change the subscription's state. The subscription’s billing period will also remain the same. -- If set to `false` and something goes wrong i.e. payment fails, then Chargify will continue through with the activation and enter an end of life state. For trialing subscriptions, that will either be trial ended (if the trial is no obligation), past due (if the trial has an obligation), or canceled (if the site has no dunning strategy, or has a strategy that says to cancel immediately). For awaiting signup subscriptions, that will always be canceled. +- If set to `true` and something goes wrong i.e. payment fails, then Advanced Billing will not change the subscription's state. The subscription’s billing period will also remain the same. +- If set to `false` and something goes wrong i.e. payment fails, then Advanced Billing will continue through with the activation and enter an end of life state. For trialing subscriptions, that will either be trial ended (if the trial is no obligation), past due (if the trial has an obligation), or canceled (if the site has no dunning strategy, or has a strategy that says to cancel immediately). For awaiting signup subscriptions, that will always be canceled. The default activation failure behavior can be configured per activation attempt, or you may set a default value under Config > Settings > Subscription Activation Settings. @@ -2106,7 +2107,7 @@ The default activation failure behavior can be configured per activation attempt ### Activate Trialing subscription -You can read more about the behavior of trialing subscriptions [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404494617357#trialing-subscriptions-0-0). +You can read more about the behavior of trialing subscriptions [here](https://maxio.zendesk.com/hc/en-us/articles/24252155721869-Trialing-Subscriptions). When the `revert_on_failure` parameter is set to `true`, the subscription's state will remain as Trialing, we will void the invoice from activation and return any prepayments and credits applied to the invoice back to the subscription. ```ts diff --git a/doc/controllers/webhooks.md b/doc/controllers/webhooks.md index 291c02e3..11529b26 100644 --- a/doc/controllers/webhooks.md +++ b/doc/controllers/webhooks.md @@ -24,12 +24,12 @@ const webhooksController = new WebhooksController(client); The Webhooks API allows you to view a list of all webhooks and to selectively resend individual or groups of webhooks. Webhooks will be sent on endpoints specified by you. Endpoints can be added via API or Web UI. There is also an option to enable / disable webhooks via API request. -We recommend that you review Chargify's webhook documentation located in our help site. The following resources will help guide you on how to use webhooks in Chargify, in addition to these webhook endpoints: +We recommend that you review Advanced Billing's webhook documentation located in our help site. The following resources will help guide you on how to use webhooks in Advanced Billing, in addition to these webhook endpoints: -+ [Adding/editing new webhooks](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404448450317#configure-webhook-url) -+ [Webhooks introduction and delivery information](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405568068365#webhooks-introduction-0-0) -+ [Main webhook overview](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405357509645-Webhooks-Reference#webhooks-reference-0-0) -+ [Available webhooks and payloads](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405357509645-Webhooks-Reference#events) ++ [Adding/editing new webhooks](https://maxio.zendesk.com/hc/en-us/articles/24286723085197-Webhooks#configure-webhook-url) ++ [Webhooks introduction and delivery information](https://maxio.zendesk.com/hc/en-us/articles/24266143173901-Webhooks-Overview) ++ [Main webhook reference](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-Reference) ++ [Available webhooks and payloads](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-Reference#events) ## List Webhooks for a Site @@ -56,7 +56,7 @@ requestOptions?: RequestOptions): Promise> | `page` | `number \| undefined` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`. | | `perPage` | `number \| undefined` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`. | | `order` | [`WebhookOrder \| undefined`](../../doc/models/webhook-order.md) | Query, Optional | The order in which the Webhooks are returned. | -| `subscription` | `number \| undefined` | Query, Optional | The Chargify id of a subscription you'd like to filter for | +| `subscription` | `number \| undefined` | Query, Optional | The Advanced Billing id of a subscription you'd like to filter for | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -70,6 +70,7 @@ const collect = { page: 2, perPage: 50 } + try { const { result, ...httpResponse } = await webhooksController.listWebhooks(collect); // Get more response info... @@ -228,7 +229,7 @@ try { The Chargify API allows you to create an endpoint and assign a list of webhooks subscriptions (events) to it. You can check available events here. -[Event keys](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405357509645-Webhooks-Reference#example-payloads) +[Event keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-Reference#events) ```ts async createEndpoint( body?: CreateOrUpdateEndpointRequest, @@ -362,7 +363,7 @@ try { You can update an Endpoint via the API with a PUT request to the resource endpoint. You can change the `url` of your endpoint which consumes webhooks or list of `webhook_subscriptions`. -Check available [Event keys](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404448450317-Webhooks#configure-webhook-url). +Check available [Event keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-Reference#events). Always send a complete list of events which you want subscribe/watch. Sending an PUT request for existing endpoint with empty list of `webhook_subscriptions` will end with unsubscribe from all events. @@ -379,7 +380,7 @@ requestOptions?: RequestOptions): Promise> | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `endpointId` | `number` | Template, Required | The Chargify id for the endpoint that should be updated | +| `endpointId` | `number` | Template, Required | The Advanced Billing id for the endpoint that should be updated | | `body` | [`CreateOrUpdateEndpointRequest \| undefined`](../../doc/models/create-or-update-endpoint-request.md) | Body, Optional | Used to Create or Update Endpoint | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/models/activate-event-based-component.md b/doc/models/activate-event-based-component.md new file mode 100644 index 00000000..9329404a --- /dev/null +++ b/doc/models/activate-event-based-component.md @@ -0,0 +1,44 @@ + +# Activate Event Based Component + +## Structure + +`ActivateEventBasedComponent` + +## Fields + +| Name | Type | Tags | Description | +| --- | --- | --- | --- | +| `pricePointId` | `number \| undefined` | Optional | The Chargify id of the price point | +| `billingSchedule` | [`BillingSchedule \| undefined`](../../doc/models/billing-schedule.md) | Optional | This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. Please note this only works for site with Multifrequency enabled | +| `customPrice` | [`ComponentCustomPrice \| undefined`](../../doc/models/component-custom-price.md) | Optional | Create or update custom pricing unique to the subscription. Used in place of `price_point_id`. | + +## Example (as JSON) + +```json +{ + "price_point_id": 44, + "billing_schedule": { + "initial_billing_at": "2016-03-13T12:52:32.123Z" + }, + "custom_price": { + "tax_included": false, + "pricing_scheme": "stairstep", + "interval": 66, + "interval_unit": "day", + "prices": [ + { + "starting_quantity": 242, + "ending_quantity": 40, + "unit_price": 23.26 + }, + { + "starting_quantity": 242, + "ending_quantity": 40, + "unit_price": 23.26 + } + ] + } +} +``` + diff --git a/doc/models/all-vaults.md b/doc/models/all-vaults.md new file mode 100644 index 00000000..be2f56f6 --- /dev/null +++ b/doc/models/all-vaults.md @@ -0,0 +1,48 @@ + +# All Vaults + +The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. + +## Enumeration + +`AllVaults` + +## Fields + +| Name | +| --- | +| `Adyen` | +| `Authorizenet` | +| `Beanstream` | +| `BlueSnap` | +| `Bogus` | +| `Braintree1` | +| `BraintreeBlue` | +| `Checkout` | +| `Cybersource` | +| `Elavon` | +| `Eway` | +| `EwayRapid` | +| `EwayRapidStd` | +| `Firstdata` | +| `Forte` | +| `Gocardless` | +| `Litle` | +| `MaxioPayments` | +| `Maxp` | +| `Moduslink` | +| `Moneris` | +| `Nmi` | +| `Orbital` | +| `PaymentExpress` | +| `Paymill` | +| `Paypal` | +| `PaypalComplete` | +| `Pin` | +| `Square` | +| `Stripe` | +| `StripeConnect` | +| `TrustCommerce` | +| `Unipaas` | +| `Wirecard` | + diff --git a/doc/models/allocation-preview-direction.md b/doc/models/allocation-preview-direction.md index 36f646f7..26731f4c 100644 --- a/doc/models/allocation-preview-direction.md +++ b/doc/models/allocation-preview-direction.md @@ -9,6 +9,6 @@ | Name | | --- | -| `upgrade` | -| `downgrade` | +| `Upgrade` | +| `Downgrade` | diff --git a/doc/models/allocation-preview-item.md b/doc/models/allocation-preview-item.md index 7f431d73..a118b660 100644 --- a/doc/models/allocation-preview-item.md +++ b/doc/models/allocation-preview-item.md @@ -22,7 +22,7 @@ | `downgradeCredit` | [`CreditType \| null \| undefined`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | | `pricePointId` | `number \| undefined` | Optional | - | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | | `previousPricePointId` | `number \| undefined` | Optional | - | | `pricePointHandle` | `string \| undefined` | Optional | - | | `pricePointName` | `string \| undefined` | Optional | - | diff --git a/doc/models/allocation-preview-line-item-kind.md b/doc/models/allocation-preview-line-item-kind.md index 124e5f82..7fb25c3f 100644 --- a/doc/models/allocation-preview-line-item-kind.md +++ b/doc/models/allocation-preview-line-item-kind.md @@ -11,8 +11,8 @@ A handle for the line item kind for allocation preview | Name | | --- | -| `quantityBasedComponent` | -| `onOffComponent` | -| `coupon` | -| `tax` | +| `QuantityBasedComponent` | +| `OnOffComponent` | +| `Coupon` | +| `Tax` | diff --git a/doc/models/allocation.md b/doc/models/allocation.md index a8579465..74c7bfea 100644 --- a/doc/models/allocation.md +++ b/doc/models/allocation.md @@ -24,7 +24,7 @@ | `pricePointName` | `string \| undefined` | Optional | - | | `pricePointHandle` | `string \| undefined` | Optional | - | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | | `previousPricePointId` | `number \| undefined` | Optional | - | | `accrueCharge` | `boolean \| undefined` | Optional | If the change in cost is an upgrade, this determines if the charge should accrue to the next renewal or if capture should be attempted immediately. | | `initiateDunning` | `boolean \| undefined` | Optional | If true, if the immediate component payment fails, initiate dunning for the subscription.
Otherwise, leave the charges on the subscription to pay for at renewal. | diff --git a/doc/models/apple-pay-payment-profile.md b/doc/models/apple-pay-payment-profile.md new file mode 100644 index 00000000..aba900de --- /dev/null +++ b/doc/models/apple-pay-payment-profile.md @@ -0,0 +1,41 @@ + +# Apple Pay Payment Profile + +## Structure + +`ApplePayPaymentProfile` + +## Fields + +| Name | Type | Tags | Description | +| --- | --- | --- | --- | +| `id` | `number \| undefined` | Optional | The Chargify-assigned ID of the Apple Pay payment profile. | +| `firstName` | `string \| undefined` | Optional | The first name of the Apple Pay account holder | +| `lastName` | `string \| undefined` | Optional | The last name of the Apple Pay account holder | +| `customerId` | `number \| undefined` | Optional | The Chargify-assigned id for the customer record to which the Apple Pay account belongs | +| `currentVault` | [`ApplePayVault \| undefined`](../../doc/models/apple-pay-vault.md) | Optional | The vault that stores the payment profile with the provided vault_token. | +| `vaultToken` | `string \| undefined` | Optional | The “token” provided by your vault storage for an already stored payment profile | +| `billingAddress` | `string \| null \| undefined` | Optional | The current billing street address for the Apple Pay account | +| `billingCity` | `string \| null \| undefined` | Optional | The current billing address city for the Apple Pay account | +| `billingState` | `string \| null \| undefined` | Optional | The current billing address state for the Apple Pay account | +| `billingZip` | `string \| null \| undefined` | Optional | The current billing address zip code for the Apple Pay account | +| `billingCountry` | `string \| null \| undefined` | Optional | The current billing address country for the Apple Pay account | +| `customerVaultToken` | `string \| null \| undefined` | Optional | - | +| `billingAddress2` | `string \| null \| undefined` | Optional | The current billing street address, second line, for the Apple Pay account | +| `paymentType` | [`PaymentType`](../../doc/models/payment-type.md) | Required | **Default**: `PaymentType.ApplePay` | +| `siteGatewaySettingId` | `number \| null \| undefined` | Optional | - | +| `gatewayHandle` | `string \| null \| undefined` | Optional | - | + +## Example (as JSON) + +```json +{ + "payment_type": "apple_pay", + "id": 60, + "first_name": "first_name2", + "last_name": "last_name0", + "customer_id": 98, + "current_vault": "braintree_blue" +} +``` + diff --git a/doc/models/apple-pay-vault.md b/doc/models/apple-pay-vault.md new file mode 100644 index 00000000..ca51e9f1 --- /dev/null +++ b/doc/models/apple-pay-vault.md @@ -0,0 +1,15 @@ + +# Apple Pay Vault + +The vault that stores the payment profile with the provided vault_token. + +## Enumeration + +`ApplePayVault` + +## Fields + +| Name | +| --- | +| `BraintreeBlue` | + diff --git a/doc/models/apply-credit-note-event.md b/doc/models/apply-credit-note-event.md index dc3b1092..aa800a61 100644 --- a/doc/models/apply-credit-note-event.md +++ b/doc/models/apply-credit-note-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/apply-debit-note-event.md b/doc/models/apply-debit-note-event.md index fc44e651..2568234d 100644 --- a/doc/models/apply-debit-note-event.md +++ b/doc/models/apply-debit-note-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/apply-payment-event.md b/doc/models/apply-payment-event.md index d2f23931..e1c4b248 100644 --- a/doc/models/apply-payment-event.md +++ b/doc/models/apply-payment-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/auto-invite.md b/doc/models/auto-invite.md index ff2ed32f..2ee5341e 100644 --- a/doc/models/auto-invite.md +++ b/doc/models/auto-invite.md @@ -9,6 +9,6 @@ | Name | Description | | --- | --- | -| `no` | Do not send the invitation email. | -| `yes` | Automatically send the invitation email. | +| `No` | Do not send the invitation email. | +| `Yes` | Automatically send the invitation email. | diff --git a/doc/models/backport-invoice-event.md b/doc/models/backport-invoice-event.md index 14e8a4bf..be10f091 100644 --- a/doc/models/backport-invoice-event.md +++ b/doc/models/backport-invoice-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, @@ -36,6 +37,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 206, "uid": "uid6", "site_id": 132, diff --git a/doc/models/bank-account-attributes.md b/doc/models/bank-account-attributes.md index ed10c776..58efdce3 100644 --- a/doc/models/bank-account-attributes.md +++ b/doc/models/bank-account-attributes.md @@ -18,7 +18,7 @@ | `bankIban` | `string \| undefined` | Optional | (Optional when creating a subscription with GoCardless). International Bank Account Number. Alternatively, local bank details can be provided | | `bankAccountHolderType` | [`BankAccountHolderType \| undefined`](../../doc/models/bank-account-holder-type.md) | Optional | Defaults to personal | | `paymentType` | [`PaymentType \| undefined`](../../doc/models/payment-type.md) | Optional | - | -| `currentVault` | [`BankAccountVault \| undefined`](../../doc/models/bank-account-vault.md) | Optional | The vault that stores the payment profile with the provided vault_token. | +| `currentVault` | [`BankAccountVault \| undefined`](../../doc/models/bank-account-vault.md) | Optional | The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. | | `vaultToken` | `string \| undefined` | Optional | - | | `customerVaultToken` | `string \| undefined` | Optional | (only for Authorize.Net CIM storage or Square) The customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token | diff --git a/doc/models/bank-account-holder-type.md b/doc/models/bank-account-holder-type.md index b81bae6a..b820e92d 100644 --- a/doc/models/bank-account-holder-type.md +++ b/doc/models/bank-account-holder-type.md @@ -11,6 +11,6 @@ Defaults to personal | Name | | --- | -| `personal` | -| `business` | +| `Personal` | +| `Business` | diff --git a/doc/models/bank-account-payment-profile.md b/doc/models/bank-account-payment-profile.md index 56bdfffc..e5ecc797 100644 --- a/doc/models/bank-account-payment-profile.md +++ b/doc/models/bank-account-payment-profile.md @@ -13,7 +13,7 @@ | `firstName` | `string \| undefined` | Optional | The first name of the bank account holder | | `lastName` | `string \| undefined` | Optional | The last name of the bank account holder | | `customerId` | `number \| undefined` | Optional | The Chargify-assigned id for the customer record to which the bank account belongs | -| `currentVault` | [`BankAccountVault \| undefined`](../../doc/models/bank-account-vault.md) | Optional | The vault that stores the payment profile with the provided vault_token. | +| `currentVault` | [`BankAccountVault \| undefined`](../../doc/models/bank-account-vault.md) | Optional | The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. | | `vaultToken` | `string \| undefined` | Optional | The “token” provided by your vault storage for an already stored payment profile | | `billingAddress` | `string \| null \| undefined` | Optional | The current billing street address for the bank account | | `billingCity` | `string \| null \| undefined` | Optional | The current billing address city for the bank account | @@ -23,11 +23,11 @@ | `customerVaultToken` | `string \| null \| undefined` | Optional | (only for Authorize.Net CIM storage): the customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token. | | `billingAddress2` | `string \| null \| undefined` | Optional | The current billing street address, second line, for the bank account | | `bankName` | `string \| undefined` | Optional | The bank where the account resides | -| `maskedBankRoutingNumber` | `string` | Required | A string representation of the stored bank routing number with all but the last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’). payment_type will be bank_account | +| `maskedBankRoutingNumber` | `string \| undefined` | Optional | A string representation of the stored bank routing number with all but the last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’). payment_type will be bank_account | | `maskedBankAccountNumber` | `string` | Required | A string representation of the stored bank account number with all but the last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’) | | `bankAccountType` | [`BankAccountType \| undefined`](../../doc/models/bank-account-type.md) | Optional | Defaults to checking | | `bankAccountHolderType` | [`BankAccountHolderType \| undefined`](../../doc/models/bank-account-holder-type.md) | Optional | Defaults to personal | -| `paymentType` | [`PaymentType \| undefined`](../../doc/models/payment-type.md) | Optional | - | +| `paymentType` | [`PaymentType`](../../doc/models/payment-type.md) | Required | **Default**: `PaymentType.BankAccount` | | `verified` | `boolean \| undefined` | Optional | denotes whether a bank account has been verified by providing the amounts of two small deposits made into the account
**Default**: `false` | | `siteGatewaySettingId` | `number \| null \| undefined` | Optional | - | | `gatewayHandle` | `string \| null \| undefined` | Optional | - | @@ -36,8 +36,8 @@ ```json { - "masked_bank_routing_number": "masked_bank_routing_number8", "masked_bank_account_number": "masked_bank_account_number8", + "payment_type": "bank_account", "verified": false, "id": 188, "first_name": "first_name6", diff --git a/doc/models/bank-account-response.md b/doc/models/bank-account-response.md index 1d315573..0a0d0c6c 100644 --- a/doc/models/bank-account-response.md +++ b/doc/models/bank-account-response.md @@ -16,14 +16,14 @@ ```json { "payment_profile": { - "masked_bank_routing_number": "masked_bank_routing_number0", "masked_bank_account_number": "masked_bank_account_number6", + "payment_type": "bank_account", "verified": false, "id": 44, "first_name": "first_name4", "last_name": "last_name2", "customer_id": 82, - "current_vault": "gocardless" + "current_vault": "authorizenet" } } ``` diff --git a/doc/models/bank-account-type.md b/doc/models/bank-account-type.md index 4f310f77..ccce016c 100644 --- a/doc/models/bank-account-type.md +++ b/doc/models/bank-account-type.md @@ -11,6 +11,6 @@ Defaults to checking | Name | | --- | -| `checking` | -| `savings` | +| `Checking` | +| `Savings` | diff --git a/doc/models/bank-account-vault.md b/doc/models/bank-account-vault.md index 979a37ba..cbef4ba6 100644 --- a/doc/models/bank-account-vault.md +++ b/doc/models/bank-account-vault.md @@ -1,7 +1,7 @@ # Bank Account Vault -The vault that stores the payment profile with the provided vault_token. +The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. ## Enumeration @@ -11,9 +11,12 @@ The vault that stores the payment profile with the provided vault_token. | Name | | --- | -| `bogus` | -| `authorizenet` | -| `stripeConnect` | -| `braintreeBlue` | -| `gocardless` | +| `Authorizenet` | +| `BlueSnap` | +| `Bogus` | +| `Forte` | +| `Gocardless` | +| `MaxioPayments` | +| `Maxp` | +| `StripeConnect` | diff --git a/doc/models/basic-date-field.md b/doc/models/basic-date-field.md index cae2faac..ebcf891c 100644 --- a/doc/models/basic-date-field.md +++ b/doc/models/basic-date-field.md @@ -11,8 +11,8 @@ Allows to filter by `created_at` or `updated_at`. | Name | | --- | -| `updatedAt` | -| `createdAt` | +| `UpdatedAt` | +| `CreatedAt` | ## Example diff --git a/doc/models/billing-manifest-line-item-kind.md b/doc/models/billing-manifest-line-item-kind.md index 2918b84b..dd5e0a15 100644 --- a/doc/models/billing-manifest-line-item-kind.md +++ b/doc/models/billing-manifest-line-item-kind.md @@ -11,10 +11,10 @@ A handle for the billing manifest line item kind | Name | | --- | -| `baseline` | -| `initial` | -| `trial` | -| `coupon` | -| `component` | -| `tax` | +| `Baseline` | +| `Initial` | +| `Trial` | +| `Coupon` | +| `Component` | +| `Tax` | diff --git a/doc/models/cancellation-method.md b/doc/models/cancellation-method.md index a5d44904..d38e9d22 100644 --- a/doc/models/cancellation-method.md +++ b/doc/models/cancellation-method.md @@ -11,9 +11,9 @@ The process used to cancel the subscription, if the subscription has been cancel | Name | | --- | -| `merchantUi` | -| `merchantApi` | -| `dunning` | -| `billingPortal` | -| `unknown` | +| `MerchantUi` | +| `MerchantApi` | +| `Dunning` | +| `BillingPortal` | +| `Unknown` | diff --git a/doc/models/card-type.md b/doc/models/card-type.md index 8df680c8..2acd7669 100644 --- a/doc/models/card-type.md +++ b/doc/models/card-type.md @@ -11,40 +11,40 @@ The type of card used. | Name | | --- | -| `visa` | -| `master` | -| `elo` | -| `cabal` | -| `alelo` | -| `discover` | -| `americanExpress` | -| `naranja` | -| `dinersClub` | -| `jcb` | -| `dankort` | -| `maestro` | -| `maestroNoLuhn` | -| `forbrugsforeningen` | -| `sodexo` | -| `alia` | -| `vr` | -| `unionpay` | -| `carnet` | -| `cartesBancaires` | -| `olimpica` | -| `creditel` | -| `confiable` | -| `synchrony` | -| `routex` | -| `mada` | -| `bpPlus` | -| `passcard` | -| `edenred` | -| `anda` | -| `tarjetad` | -| `hipercard` | -| `bogus` | -| `switch` | -| `solo` | -| `laser` | +| `Visa` | +| `Master` | +| `Elo` | +| `Cabal` | +| `Alelo` | +| `Discover` | +| `AmericanExpress` | +| `Naranja` | +| `DinersClub` | +| `Jcb` | +| `Dankort` | +| `Maestro` | +| `MaestroNoLuhn` | +| `Forbrugsforeningen` | +| `Sodexo` | +| `Alia` | +| `Vr` | +| `Unionpay` | +| `Carnet` | +| `CartesBancaires` | +| `Olimpica` | +| `Creditel` | +| `Confiable` | +| `Synchrony` | +| `Routex` | +| `Mada` | +| `BpPlus` | +| `Passcard` | +| `Edenred` | +| `Anda` | +| `Tarjetad` | +| `Hipercard` | +| `Bogus` | +| `Switch` | +| `Solo` | +| `Laser` | diff --git a/doc/models/change-chargeback-status-event.md b/doc/models/change-chargeback-status-event.md index 9c93fe78..c0609049 100644 --- a/doc/models/change-chargeback-status-event.md +++ b/doc/models/change-chargeback-status-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/change-invoice-collection-method-event.md b/doc/models/change-invoice-collection-method-event.md index 7127e5ea..6a1a820e 100644 --- a/doc/models/change-invoice-collection-method-event.md +++ b/doc/models/change-invoice-collection-method-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/change-invoice-status-event-data.md b/doc/models/change-invoice-status-event-data.md index c3b4ebdc..0063bc39 100644 --- a/doc/models/change-invoice-status-event-data.md +++ b/doc/models/change-invoice-status-event-data.md @@ -13,8 +13,8 @@ Example schema for an `change_invoice_status` event | --- | --- | --- | --- | | `gatewayTransId` | `string \| undefined` | Optional | Identifier for the transaction within the payment gateway. | | `amount` | `string \| undefined` | Optional | The monetary value associated with the linked payment, expressed in dollars. | -| `fromStatus` | [`InvoiceStatus`](../../doc/models/invoice-status.md) | Required | The status of the invoice before any changes occurred. See [Invoice Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices#invoice-statuses) for more. | -| `toStatus` | [`InvoiceStatus`](../../doc/models/invoice-status.md) | Required | The updated status of the invoice after changes have been made. See [Invoice Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices#invoice-statuses) for more. | +| `fromStatus` | [`InvoiceStatus`](../../doc/models/invoice-status.md) | Required | The status of the invoice before any changes occurred. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. | +| `toStatus` | [`InvoiceStatus`](../../doc/models/invoice-status.md) | Required | The updated status of the invoice after changes have been made. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. | | `consolidationLevel` | [`InvoiceConsolidationLevel \| undefined`](../../doc/models/invoice-consolidation-level.md) | Optional | - | ## Example (as JSON) diff --git a/doc/models/change-invoice-status-event.md b/doc/models/change-invoice-status-event.md index e87dbfce..34aa3b39 100644 --- a/doc/models/change-invoice-status-event.md +++ b/doc/models/change-invoice-status-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/chargeback-status.md b/doc/models/chargeback-status.md index 43947c35..d57bae0f 100644 --- a/doc/models/chargeback-status.md +++ b/doc/models/chargeback-status.md @@ -11,8 +11,8 @@ The current chargeback status. | Name | | --- | -| `open` | -| `lost` | -| `won` | -| `closed` | +| `Open` | +| `Lost` | +| `Won` | +| `Closed` | diff --git a/doc/models/cleanup-scope.md b/doc/models/cleanup-scope.md index 12fe7205..51cb5160 100644 --- a/doc/models/cleanup-scope.md +++ b/doc/models/cleanup-scope.md @@ -11,6 +11,6 @@ all: Will clear all products, customers, and related subscriptions from the site | Name | | --- | -| `all` | -| `customers` | +| `All` | +| `Customers` | diff --git a/doc/models/collection-method.md b/doc/models/collection-method.md index 6bf5693d..337df240 100644 --- a/doc/models/collection-method.md +++ b/doc/models/collection-method.md @@ -11,8 +11,8 @@ The type of payment collection to be used in the subscription. For legacy Statem | Name | | --- | -| `automatic` | -| `remittance` | -| `prepaid` | -| `invoice` | +| `Automatic` | +| `Remittance` | +| `Prepaid` | +| `Invoice` | diff --git a/doc/models/component-custom-price.md b/doc/models/component-custom-price.md index 096a25c9..3bc5780e 100644 --- a/doc/models/component-custom-price.md +++ b/doc/models/component-custom-price.md @@ -11,25 +11,27 @@ Create or update custom pricing unique to the subscription. Used in place of `pr | Name | Type | Tags | Description | | --- | --- | --- | --- | +| `taxIncluded` | `boolean \| undefined` | Optional | Whether or not the price point includes tax | | `pricingScheme` | [`PricingScheme \| undefined`](../../doc/models/pricing-scheme.md) | Optional | Omit for On/Off components | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | -| `prices` | [`Price[] \| undefined`](../../doc/models/price.md) | Optional | On/off components only need one price bracket starting at 1 | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `prices` | [`Price[]`](../../doc/models/price.md) | Required | On/off components only need one price bracket starting at 1 | ## Example (as JSON) ```json { - "pricing_scheme": "stairstep", - "interval": 162, - "interval_unit": "day", "prices": [ { "starting_quantity": 242, "ending_quantity": 40, "unit_price": 23.26 } - ] + ], + "tax_included": false, + "pricing_scheme": "stairstep", + "interval": 162, + "interval_unit": "day" } ``` diff --git a/doc/models/component-kind.md b/doc/models/component-kind.md index a4c8978b..915b0b68 100644 --- a/doc/models/component-kind.md +++ b/doc/models/component-kind.md @@ -11,9 +11,9 @@ A handle for the component type | Name | | --- | -| `meteredComponent` | -| `quantityBasedComponent` | -| `onOffComponent` | -| `prepaidUsageComponent` | -| `eventBasedComponent` | +| `MeteredComponent` | +| `QuantityBasedComponent` | +| `OnOffComponent` | +| `PrepaidUsageComponent` | +| `EventBasedComponent` | diff --git a/doc/models/component-price-point-item.md b/doc/models/component-price-point-item.md index bd17aad5..e46ceefb 100644 --- a/doc/models/component-price-point-item.md +++ b/doc/models/component-price-point-item.md @@ -13,7 +13,7 @@ | `handle` | `string \| undefined` | Optional | - | | `pricingScheme` | [`PricingScheme \| undefined`](../../doc/models/pricing-scheme.md) | Optional | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | | `prices` | [`Price[] \| undefined`](../../doc/models/price.md) | Optional | - | ## Example (as JSON) diff --git a/doc/models/component.md b/doc/models/component.md index 3313c6d7..c684e5de 100644 --- a/doc/models/component.md +++ b/doc/models/component.md @@ -42,7 +42,7 @@ | `accountingCode` | `string \| null \| undefined` | Optional | E.g. Internal ID or SKU Number | | `eventBasedBillingMetricId` | `number \| undefined` | Optional | (Only for Event Based Components) This is an ID of a metric attached to the component. This metric is used to bill upon collected events. | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. | ## Example (as JSON) diff --git a/doc/models/compounding-strategy.md b/doc/models/compounding-strategy.md index 5e3d9430..272bfa93 100644 --- a/doc/models/compounding-strategy.md +++ b/doc/models/compounding-strategy.md @@ -9,6 +9,6 @@ | Name | | --- | -| `compound` | -| `fullprice` | +| `Compound` | +| `Fullprice` | diff --git a/doc/models/containers/payment-profile-response-payment-profile.md b/doc/models/containers/payment-profile.md similarity index 53% rename from doc/models/containers/payment-profile-response-payment-profile.md rename to doc/models/containers/payment-profile.md index f05dcf6c..c144cb25 100644 --- a/doc/models/containers/payment-profile-response-payment-profile.md +++ b/doc/models/containers/payment-profile.md @@ -1,14 +1,16 @@ -# Payment Profile Response Payment Profile +# Payment Profile ## Class Name -`PaymentProfileResponsePaymentProfile` +`PaymentProfile` ## Cases | Type | | --- | +| [`ApplePayPaymentProfile`](../../../doc/models/apple-pay-payment-profile.md) | | [`BankAccountPaymentProfile`](../../../doc/models/bank-account-payment-profile.md) | | [`CreditCardPaymentProfile`](../../../doc/models/credit-card-payment-profile.md) | +| [`PaypalPaymentProfile`](../../../doc/models/paypal-payment-profile.md) | diff --git a/doc/models/create-component-price-point.md b/doc/models/create-component-price-point.md index e26772a6..a597a900 100644 --- a/doc/models/create-component-price-point.md +++ b/doc/models/create-component-price-point.md @@ -16,7 +16,7 @@ | `useSiteExchangeRate` | `boolean \| undefined` | Optional | Whether to use the site level exchange rate or define your own prices for each currency if you have multiple currencies defined on the site.
**Default**: `true` | | `taxIncluded` | `boolean \| undefined` | Optional | Whether or not the price point includes tax | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this price point, either month or day. This property is only available for sites with Multifrequency enabled. | ## Example (as JSON) diff --git a/doc/models/create-credit-note-event.md b/doc/models/create-credit-note-event.md index b0edea6b..cec82d35 100644 --- a/doc/models/create-credit-note-event.md +++ b/doc/models/create-credit-note-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/create-customer.md b/doc/models/create-customer.md index d0b840cb..3dc7c97d 100644 --- a/doc/models/create-customer.md +++ b/doc/models/create-customer.md @@ -27,6 +27,7 @@ | `taxExempt` | `boolean \| undefined` | Optional | - | | `taxExemptReason` | `string \| undefined` | Optional | - | | `parentId` | `number \| null \| undefined` | Optional | The parent ID in Chargify if applicable. Parent is another Customer object. | +| `salesforceId` | `string \| null \| undefined` | Optional | The Salesforce ID of the customer | ## Example (as JSON) diff --git a/doc/models/create-debit-note-event.md b/doc/models/create-debit-note-event.md index bd8d6480..469cf138 100644 --- a/doc/models/create-debit-note-event.md +++ b/doc/models/create-debit-note-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/create-invoice-status.md b/doc/models/create-invoice-status.md index f0966003..6afef48f 100644 --- a/doc/models/create-invoice-status.md +++ b/doc/models/create-invoice-status.md @@ -9,8 +9,8 @@ | Name | | --- | -| `draft` | -| `open` | +| `Draft` | +| `Open` | ## Example diff --git a/doc/models/create-metafield.md b/doc/models/create-metafield.md index ec807495..8576b289 100644 --- a/doc/models/create-metafield.md +++ b/doc/models/create-metafield.md @@ -12,7 +12,7 @@ | `name` | `string \| undefined` | Optional | - | | `scope` | [`MetafieldScope \| undefined`](../../doc/models/metafield-scope.md) | Optional | Warning: When updating a metafield's scope attribute, all scope attributes must be passed. Partially complete scope attributes will override the existing settings. | | `inputType` | [`MetafieldInput \| undefined`](../../doc/models/metafield-input.md) | Optional | Indicates how data should be added to the metafield. For example, a text type is just a string, so a given metafield of this type can have any value attached. On the other hand, dropdown and radio have a set of allowed values that can be input, and appear differently on a Public Signup Page. Defaults to 'text' | -| `mEnum` | `string[] \| undefined` | Optional | Only applicable when input_type is radio or dropdown | +| `mEnum` | `string[] \| undefined` | Optional | Only applicable when input_type is radio or dropdown. Empty strings will not be submitted. | ## Example (as JSON) diff --git a/doc/models/create-or-update-product.md b/doc/models/create-or-update-product.md index 9e373362..07e56c36 100644 --- a/doc/models/create-or-update-product.md +++ b/doc/models/create-or-update-product.md @@ -19,10 +19,10 @@ | `intervalUnit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Required | A string representing the interval unit for this product, either month or day | | `trialPriceInCents` | `bigint \| undefined` | Optional | The product trial price, in integer cents | | `trialInterval` | `number \| undefined` | Optional | The numerical trial interval. i.e. an interval of ‘30’ coupled with a trial_interval_unit of day would mean this product trial would last 30 days. | -| `trialIntervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the trial interval unit for this product, either month or day | +| `trialIntervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the trial interval unit for this product, either month or day | | `trialType` | `string \| undefined` | Optional | - | | `expirationInterval` | `number \| undefined` | Optional | The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product would expire after 30 days. | -| `expirationIntervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the expiration interval unit for this product, either month or day | +| `expirationIntervalUnit` | [`ExpirationIntervalUnit \| null \| undefined`](../../doc/models/expiration-interval-unit.md) | Optional | A string representing the expiration interval unit for this product, either month, day or never | | `autoCreateSignupPage` | `boolean \| undefined` | Optional | - | | `taxCode` | `string \| undefined` | Optional | A string representing the tax code related to the product type. This is especially important when using the Avalara service to tax based on locale. This attribute has a max length of 10 characters.
**Constraints**: *Maximum Length*: `10` | diff --git a/doc/models/create-payment-profile-request.md b/doc/models/create-payment-profile-request.md index db3689c4..48ae386d 100644 --- a/doc/models/create-payment-profile-request.md +++ b/doc/models/create-payment-profile-request.md @@ -19,7 +19,7 @@ "chargify_token": "tok_9g6hw85pnpt6knmskpwp4ttt", "full_number": "5424000000000015", "id": 44, - "payment_type": "bank_account", + "payment_type": "credit_card", "first_name": "first_name4", "last_name": "last_name2" } diff --git a/doc/models/create-payment-profile.md b/doc/models/create-payment-profile.md index 7f903380..216c8808 100644 --- a/doc/models/create-payment-profile.md +++ b/doc/models/create-payment-profile.md @@ -25,7 +25,7 @@ | `billingState` | `string \| undefined` | Optional | The credit card or bank account billing address state (i.e. MA). This value is merely passed through to the payment gateway. This must conform to the [ISO_3166-1](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) in order to be valid for tax locale purposes. | | `billingCountry` | `string \| undefined` | Optional | The credit card or bank account billing address country, required in [ISO_3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format (i.e. “US”). This value is merely passed through to the payment gateway. Some gateways require country codes in a specific format. Please check your gateway’s documentation. If creating an ACH subscription, only US is supported at this time. | | `billingZip` | `string \| undefined` | Optional | The credit card or bank account billing address zip code (i.e. 12345). This value is merely passed through to the payment gateway. | -| `currentVault` | [`CurrentVault \| undefined`](../../doc/models/current-vault.md) | Optional | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | +| `currentVault` | [`AllVaults \| undefined`](../../doc/models/all-vaults.md) | Optional | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | | `vaultToken` | `string \| undefined` | Optional | The “token” provided by your vault storage for an already stored payment profile | | `customerVaultToken` | `string \| undefined` | Optional | (only for Authorize.Net CIM storage or Square) The customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token | | `customerId` | `number \| undefined` | Optional | (Required when creating a new payment profile) The Chargify customer id. | @@ -49,7 +49,7 @@ "chargify_token": "tok_9g6hw85pnpt6knmskpwp4ttt", "full_number": "5424000000000015", "id": 76, - "payment_type": "paypal_account", + "payment_type": "credit_card", "first_name": "first_name8", "last_name": "last_name6" } diff --git a/doc/models/create-prepaid-usage-component-price-point.md b/doc/models/create-prepaid-usage-component-price-point.md index b5476390..72d75cb8 100644 --- a/doc/models/create-prepaid-usage-component-price-point.md +++ b/doc/models/create-prepaid-usage-component-price-point.md @@ -18,7 +18,7 @@ | `rolloverPrepaidRemainder` | `boolean \| undefined` | Optional | Boolean which controls whether or not remaining units should be rolled over to the next period | | `renewPrepaidAllocation` | `boolean \| undefined` | Optional | Boolean which controls whether or not the allocated quantity should be renewed at the beginning of each period | | `expirationInterval` | `number \| undefined` | Optional | (only for prepaid usage components where rollover_prepaid_remainder is true) The number of `expiration_interval_unit`s after which rollover amounts should expire | -| `expirationIntervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | - | +| `expirationIntervalUnit` | [`ExpirationIntervalUnit \| null \| undefined`](../../doc/models/expiration-interval-unit.md) | Optional | A string representing the expiration interval unit for this component, either month or day | ## Example (as JSON) diff --git a/doc/models/create-prepayment-method.md b/doc/models/create-prepayment-method.md index 0c4f7ed8..2f15e906 100644 --- a/doc/models/create-prepayment-method.md +++ b/doc/models/create-prepayment-method.md @@ -11,12 +11,12 @@ | Name | | --- | -| `check` | -| `cash` | -| `moneyOrder` | -| `ach` | -| `paypalAccount` | -| `creditCard` | -| `creditCardOnFile` | -| `other` | +| `Check` | +| `Cash` | +| `MoneyOrder` | +| `Ach` | +| `PaypalAccount` | +| `CreditCard` | +| `CreditCardOnFile` | +| `Other` | diff --git a/doc/models/create-product-price-point.md b/doc/models/create-product-price-point.md index dff12e6a..52726c59 100644 --- a/doc/models/create-product-price-point.md +++ b/doc/models/create-product-price-point.md @@ -21,7 +21,7 @@ | `initialChargeInCents` | `bigint \| undefined` | Optional | The product price point initial charge, in integer cents | | `initialChargeAfterTrial` | `boolean \| undefined` | Optional | - | | `expirationInterval` | `number \| undefined` | Optional | The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product price point would expire after 30 days. | -| `expirationIntervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the expiration interval unit for this product price point, either month or day | +| `expirationIntervalUnit` | [`ExpirationIntervalUnit \| null \| undefined`](../../doc/models/expiration-interval-unit.md) | Optional | A string representing the expiration interval unit for this product price point, either month, day or never | | `useSiteExchangeRate` | `boolean \| undefined` | Optional | Whether or not to use the site's exchange rate or define your own pricing when your site has multiple currencies defined.
**Default**: `true` | ## Example (as JSON) diff --git a/doc/models/create-signup-proforma-preview-include.md b/doc/models/create-signup-proforma-preview-include.md index c6b56239..5330e39c 100644 --- a/doc/models/create-signup-proforma-preview-include.md +++ b/doc/models/create-signup-proforma-preview-include.md @@ -9,7 +9,7 @@ | Name | | --- | -| `nextProformaInvoice` | +| `NextProformaInvoice` | ## Example diff --git a/doc/models/create-subscription.md b/doc/models/create-subscription.md index dec0ea8e..b4194702 100644 --- a/doc/models/create-subscription.md +++ b/doc/models/create-subscription.md @@ -20,8 +20,8 @@ | `receivesInvoiceEmails` | `string \| undefined` | Optional | (Optional) Default: True - Whether or not this subscription is set to receive emails related to this subscription. | | `netTerms` | `string \| undefined` | Optional | (Optional) Default: null The number of days after renewal (on invoice billing) that a subscription is due. A value between 0 (due immediately) and 180. | | `customerId` | `number \| undefined` | Optional | The ID of an existing customer within Chargify. Required, unless a `customer_reference` or a set of `customer_attributes` is given. | -| `nextBillingAt` | `string \| undefined` | Optional | (Optional) Set this attribute to a future date/time to sync imported subscriptions to your existing renewal schedule. See the notes on “Date/Time Format” in our [subscription import documentation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404863655821#date-format). If you provide a next_billing_at timestamp that is in the future, no trial or initial charges will be applied when you create the subscription. In fact, no payment will be captured at all. The first payment will be captured, according to the prices defined by the product, near the time specified by next_billing_at. If you do not provide a value for next_billing_at, any trial and/or initial charges will be assessed and charged at the time of subscription creation. If the card cannot be successfully charged, the subscription will not be created. See further notes in the section on Importing Subscriptions. | -| `initialBillingAt` | `string \| undefined` | Optional | (Optional) Set this attribute to a future date/time to create a subscription in the "Awaiting Signup" state, rather than "Active" or "Trialing". See the notes on “Date/Time Format” in our [subscription import documentation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404863655821#date-format). In the "Awaiting Signup" state, a subscription behaves like any other. It can be canceled, allocated to, had its billing date changed. etc. When the initial_billing_at date hits, the subscription will transition to the expected state. If the product has a trial, the subscription will enter a trial, otherwise it will go active. Setup fees will be respected either before or after the trial, as configured on the price point. If the payment is due at the initial_billing_at and it fails the subscription will be immediately canceled. See further notes in the section on Delayed Signups. | +| `nextBillingAt` | `string \| undefined` | Optional | (Optional) Set this attribute to a future date/time to sync imported subscriptions to your existing renewal schedule. See the notes on “Date/Time Format” in our [subscription import documentation](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Advanced-Billing-Subscription-Imports#date-format). If you provide a next_billing_at timestamp that is in the future, no trial or initial charges will be applied when you create the subscription. In fact, no payment will be captured at all. The first payment will be captured, according to the prices defined by the product, near the time specified by next_billing_at. If you do not provide a value for next_billing_at, any trial and/or initial charges will be assessed and charged at the time of subscription creation. If the card cannot be successfully charged, the subscription will not be created. See further notes in the section on Importing Subscriptions. | +| `initialBillingAt` | `string \| undefined` | Optional | (Optional) Set this attribute to a future date/time to create a subscription in the "Awaiting Signup" state, rather than "Active" or "Trialing". See the notes on “Date/Time Format” in our [subscription import documentation](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Advanced-Billing-Subscription-Imports#date-format). In the "Awaiting Signup" state, a subscription behaves like any other. It can be canceled, allocated to, had its billing date changed. etc. When the initial_billing_at date hits, the subscription will transition to the expected state. If the product has a trial, the subscription will enter a trial, otherwise it will go active. Setup fees will be respected either before or after the trial, as configured on the price point. If the payment is due at the initial_billing_at and it fails the subscription will be immediately canceled. See further notes in the section on Delayed Signups. | | `storedCredentialTransactionId` | `number \| undefined` | Optional | For European sites subject to PSD2 and using 3D Secure, this can be used to reference a previous transaction for the customer. This will ensure the card will be charged successfully at renewal. | | `salesRepId` | `number \| undefined` | Optional | - | | `paymentProfileId` | `number \| undefined` | Optional | The Payment Profile ID of an existing card or bank account, which belongs to an existing customer to use for payment for this subscription. If the card, bank account, or customer does not exist already, or if you want to use a new (unstored) card or bank account for the subscription, use `payment_profile_attributes` instead to create a new payment profile along with the subscription. (This value is available on an existing subscription via the API as `credit_card` > id or `bank_account` > id) | @@ -30,12 +30,12 @@ | `paymentProfileAttributes` | [`PaymentProfileAttributes \| undefined`](../../doc/models/payment-profile-attributes.md) | Optional | alias to credit_card_attributes | | `creditCardAttributes` | [`PaymentProfileAttributes \| undefined`](../../doc/models/payment-profile-attributes.md) | Optional | Credit Card data to create a new Subscription. Interchangeable with `payment_profile_attributes` property. | | `bankAccountAttributes` | [`BankAccountAttributes \| undefined`](../../doc/models/bank-account-attributes.md) | Optional | - | -| `components` | [`CreateSubscriptionComponent[] \| undefined`](../../doc/models/create-subscription-component.md) | Optional | (Optional) An array of component ids and quantities to be added to the subscription. See [Components](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677) for more information. | +| `components` | [`CreateSubscriptionComponent[] \| undefined`](../../doc/models/create-subscription-component.md) | Optional | (Optional) An array of component ids and quantities to be added to the subscription. See [Components](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview) for more information. | | `calendarBilling` | [`CalendarBilling \| undefined`](../../doc/models/calendar-billing.md) | Optional | (Optional). Cannot be used when also specifying next_billing_at | | `metafields` | `Record \| undefined` | Optional | (Optional) A set of key/value pairs representing custom fields and their values. Metafields will be created “on-the-fly” in your site for a given key, if they have not been created yet. | | `customerReference` | `string \| undefined` | Optional | The reference value (provided by your app) of an existing customer within Chargify. Required, unless a `customer_id` or a set of `customer_attributes` is given. | | `group` | [`GroupSettings \| undefined`](../../doc/models/group-settings.md) | Optional | - | -| `ref` | `string \| undefined` | Optional | A valid referral code. (optional, see [Referrals](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405420204045-Referrals-Reference#how-to-obtain-referral-codes) for more details). If supplied, must be valid, or else subscription creation will fail. | +| `ref` | `string \| undefined` | Optional | A valid referral code. (optional, see [Referrals](https://maxio.zendesk.com/hc/en-us/articles/24286981223693-Referrals-Reference#how-to-obtain-referral-codes) for more details). If supplied, must be valid, or else subscription creation will fail. | | `cancellationMessage` | `string \| undefined` | Optional | (Optional) Can be used when canceling a subscription (via the HTTP DELETE method) to make a note about the reason for cancellation. | | `cancellationMethod` | `string \| undefined` | Optional | (Optional) Can be used when canceling a subscription (via the HTTP DELETE method) to make a note about how the subscription was canceled. | | `currency` | `string \| undefined` | Optional | (Optional) If Multi-Currency is enabled and the currency is configured in Chargify, pass it at signup to create a subscription on a non-default currency. Note that you cannot update the currency of an existing subscription. | diff --git a/doc/models/credit-card-payment-profile.md b/doc/models/credit-card-payment-profile.md index 4a5f6e3d..85208594 100644 --- a/doc/models/credit-card-payment-profile.md +++ b/doc/models/credit-card-payment-profile.md @@ -12,12 +12,12 @@ | `id` | `number \| undefined` | Optional | The Chargify-assigned ID of the stored card. This value can be used as an input to payment_profile_id when creating a subscription, in order to re-use a stored payment profile for the same customer. | | `firstName` | `string \| undefined` | Optional | The first name of the card holder. | | `lastName` | `string \| undefined` | Optional | The last name of the card holder. | -| `maskedCardNumber` | `string` | Required | A string representation of the credit card number with all but the last 4 digits masked with X’s (i.e. ‘XXXX-XXXX-XXXX-1234’). | +| `maskedCardNumber` | `string \| undefined` | Optional | A string representation of the credit card number with all but the last 4 digits masked with X’s (i.e. ‘XXXX-XXXX-XXXX-1234’). | | `cardType` | [`CardType \| undefined`](../../doc/models/card-type.md) | Optional | The type of card used. | | `expirationMonth` | `number \| undefined` | Optional | An integer representing the expiration month of the card(1 – 12). | | `expirationYear` | `number \| undefined` | Optional | An integer representing the 4-digit expiration year of the card(i.e. ‘2012’). | | `customerId` | `number \| undefined` | Optional | The Chargify-assigned id for the customer record to which the card belongs. | -| `currentVault` | [`CurrentVault \| undefined`](../../doc/models/current-vault.md) | Optional | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | +| `currentVault` | [`CreditCardVault \| undefined`](../../doc/models/credit-card-vault.md) | Optional | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | | `vaultToken` | `string \| null \| undefined` | Optional | The “token” provided by your vault storage for an already stored payment profile. | | `billingAddress` | `string \| null \| undefined` | Optional | The current billing street address for the card. | | `billingCity` | `string \| null \| undefined` | Optional | The current billing address city for the card. | @@ -26,7 +26,7 @@ | `billingCountry` | `string \| null \| undefined` | Optional | The current billing address country for the card. | | `customerVaultToken` | `string \| null \| undefined` | Optional | (only for Authorize.Net CIM storage): the customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token. | | `billingAddress2` | `string \| null \| undefined` | Optional | The current billing street address, second line, for the card. | -| `paymentType` | [`PaymentType \| undefined`](../../doc/models/payment-type.md) | Optional | - | +| `paymentType` | [`PaymentType`](../../doc/models/payment-type.md) | Required | **Default**: `PaymentType.CreditCard` | | `disabled` | `boolean \| undefined` | Optional | - | | `chargifyToken` | `string \| undefined` | Optional | Token received after sending billing information using chargify.js. This token will only be received if passed as a sole attribute of credit_card_attributes (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) | | `siteGatewaySettingId` | `number \| null \| undefined` | Optional | - | diff --git a/doc/models/credit-card-vault.md b/doc/models/credit-card-vault.md new file mode 100644 index 00000000..e2156056 --- /dev/null +++ b/doc/models/credit-card-vault.md @@ -0,0 +1,47 @@ + +# Credit Card Vault + +The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. + +## Enumeration + +`CreditCardVault` + +## Fields + +| Name | +| --- | +| `Adyen` | +| `Authorizenet` | +| `Beanstream` | +| `BlueSnap` | +| `Bogus` | +| `Braintree1` | +| `BraintreeBlue` | +| `Checkout` | +| `Cybersource` | +| `Elavon` | +| `Eway` | +| `EwayRapid` | +| `EwayRapidStd` | +| `Firstdata` | +| `Forte` | +| `Litle` | +| `MaxioPayments` | +| `Maxp` | +| `Moduslink` | +| `Moneris` | +| `Nmi` | +| `Orbital` | +| `PaymentExpress` | +| `Paymill` | +| `Paypal` | +| `PaypalComplete` | +| `Pin` | +| `Square` | +| `Stripe` | +| `StripeConnect` | +| `TrustCommerce` | +| `Unipaas` | +| `Wirecard` | + diff --git a/doc/models/credit-note-status.md b/doc/models/credit-note-status.md index e4c97de8..45f47344 100644 --- a/doc/models/credit-note-status.md +++ b/doc/models/credit-note-status.md @@ -11,6 +11,6 @@ Current status of the credit note. | Name | | --- | -| `open` | -| `applied` | +| `Open` | +| `Applied` | diff --git a/doc/models/credit-note.md b/doc/models/credit-note.md index 957dd62e..c533c436 100644 --- a/doc/models/credit-note.md +++ b/doc/models/credit-note.md @@ -35,7 +35,7 @@ | `taxes` | [`InvoiceTax[] \| undefined`](../../doc/models/invoice-tax.md) | Optional | - | | `applications` | [`CreditNoteApplication[] \| undefined`](../../doc/models/credit-note-application.md) | Optional | - | | `refunds` | [`InvoiceRefund[] \| undefined`](../../doc/models/invoice-refund.md) | Optional | - | -| `originInvoices` | [`OriginInvoice[] \| undefined`](../../doc/models/origin-invoice.md) | Optional | An array of origin invoices for the credit note. Learn more about [Origin Invoice from our docs](https://chargify.zendesk.com/hc/en-us/articles/4407753036699#origin-invoices) | +| `originInvoices` | [`OriginInvoice[] \| undefined`](../../doc/models/origin-invoice.md) | Optional | An array of origin invoices for the credit note. Learn more about [Origin Invoice from our docs](https://maxio.zendesk.com/hc/en-us/articles/24252261284749-Credit-Notes-Proration#origin-invoices) | ## Example (as JSON) diff --git a/doc/models/credit-scheme.md b/doc/models/credit-scheme.md index 2bf1ff6b..1e2e746f 100644 --- a/doc/models/credit-scheme.md +++ b/doc/models/credit-scheme.md @@ -9,7 +9,7 @@ | Name | | --- | -| `none` | -| `credit` | -| `refund` | +| `None` | +| `Credit` | +| `Refund` | diff --git a/doc/models/credit-type.md b/doc/models/credit-type.md index 16297f0b..130b05f6 100644 --- a/doc/models/credit-type.md +++ b/doc/models/credit-type.md @@ -12,7 +12,7 @@ Available values: `full`, `prorated`, `none`. | Name | | --- | -| `full` | -| `prorated` | -| `none` | +| `Full` | +| `Prorated` | +| `None` | diff --git a/doc/models/currency-price-role.md b/doc/models/currency-price-role.md index dc1714ae..91332999 100644 --- a/doc/models/currency-price-role.md +++ b/doc/models/currency-price-role.md @@ -11,7 +11,7 @@ Role for the price. | Name | | --- | -| `baseline` | -| `trial` | -| `initial` | +| `Baseline` | +| `Trial` | +| `Initial` | diff --git a/doc/models/current-vault.md b/doc/models/current-vault.md deleted file mode 100644 index 690aaa96..00000000 --- a/doc/models/current-vault.md +++ /dev/null @@ -1,41 +0,0 @@ - -# Current Vault - -The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. - -## Enumeration - -`CurrentVault` - -## Fields - -| Name | -| --- | -| `adyen` | -| `authorizenet` | -| `avalara` | -| `beanstream` | -| `blueSnap` | -| `bogus` | -| `braintreeBlue` | -| `checkout` | -| `cybersource` | -| `elavon` | -| `eway` | -| `ewayRapidStd` | -| `firstdata` | -| `forte` | -| `gocardless` | -| `litle` | -| `maxioPayments` | -| `moduslink` | -| `moneris` | -| `nmi` | -| `orbital` | -| `paymentExpress` | -| `pin` | -| `square` | -| `stripeConnect` | -| `trustCommerce` | -| `unipaas` | - diff --git a/doc/models/custom-field-owner.md b/doc/models/custom-field-owner.md index 9e0fdb4d..4fbe607e 100644 --- a/doc/models/custom-field-owner.md +++ b/doc/models/custom-field-owner.md @@ -9,6 +9,6 @@ | Name | | --- | -| `customer` | -| `subscription` | +| `Customer` | +| `Subscription` | diff --git a/doc/models/customer-attributes.md b/doc/models/customer-attributes.md index febe5a82..348b581e 100644 --- a/doc/models/customer-attributes.md +++ b/doc/models/customer-attributes.md @@ -27,6 +27,7 @@ | `vatNumber` | `string \| undefined` | Optional | (Optional) Supplying the VAT number allows EU customer’s to opt-out of the Value Added Tax assuming the merchant address and customer billing address are not within the same EU country. It’s important to omit the country code from the VAT number upon entry. Otherwise, taxes will be assessed upon the purchase. | | `metafields` | `Record \| undefined` | Optional | (Optional) A set of key/value pairs representing custom fields and their values. Metafields will be created “on-the-fly” in your site for a given key, if they have not been created yet. | | `parentId` | `number \| null \| undefined` | Optional | The parent ID in Chargify if applicable. Parent is another Customer object. | +| `salesforceId` | `string \| null \| undefined` | Optional | (Optional) The Salesforce ID of the customer. | ## Example (as JSON) diff --git a/doc/models/customer.md b/doc/models/customer.md index 787a67f2..fb034953 100644 --- a/doc/models/customer.md +++ b/doc/models/customer.md @@ -36,6 +36,7 @@ | `parentId` | `number \| null \| undefined` | Optional | The parent ID in Chargify if applicable. Parent is another Customer object. | | `locale` | `string \| null \| undefined` | Optional | The locale for the customer to identify language-region | | `defaultSubscriptionGroupUid` | `string \| null \| undefined` | Optional | - | +| `salesforceId` | `string \| null \| undefined` | Optional | The Salesforce ID for the customer | ## Example (as JSON) diff --git a/doc/models/debit-note-role.md b/doc/models/debit-note-role.md index 36fc1557..d4bc83dd 100644 --- a/doc/models/debit-note-role.md +++ b/doc/models/debit-note-role.md @@ -11,6 +11,6 @@ The role of the debit note. | Name | | --- | -| `chargeback` | -| `refund` | +| `Chargeback` | +| `Refund` | diff --git a/doc/models/debit-note-status.md b/doc/models/debit-note-status.md index bb2b1413..42e4a81c 100644 --- a/doc/models/debit-note-status.md +++ b/doc/models/debit-note-status.md @@ -11,8 +11,8 @@ Current status of the debit note. | Name | | --- | -| `open` | -| `applied` | -| `banished` | -| `paid` | +| `Open` | +| `Applied` | +| `Banished` | +| `Paid` | diff --git a/doc/models/direction.md b/doc/models/direction.md index 15bb1a56..356aa18f 100644 --- a/doc/models/direction.md +++ b/doc/models/direction.md @@ -9,6 +9,6 @@ | Name | | --- | -| `asc` | -| `desc` | +| `Asc` | +| `Desc` | diff --git a/doc/models/discount-type.md b/doc/models/discount-type.md index 200be698..b08252c9 100644 --- a/doc/models/discount-type.md +++ b/doc/models/discount-type.md @@ -9,6 +9,6 @@ | Name | | --- | -| `amount` | -| `percent` | +| `Amount` | +| `Percent` | diff --git a/doc/models/ebb-component.md b/doc/models/ebb-component.md index 5de261a4..dffadf32 100644 --- a/doc/models/ebb-component.md +++ b/doc/models/ebb-component.md @@ -25,7 +25,7 @@ | `priceInCents` | `string \| undefined` | Optional | deprecated May 2011 - use unit_price instead | | `eventBasedBillingMetricId` | `number` | Required | The ID of an event based billing metric that will be attached to this component. | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. | ## Example (as JSON) diff --git a/doc/models/event-type.md b/doc/models/event-type.md index 5affcc61..35c63e82 100644 --- a/doc/models/event-type.md +++ b/doc/models/event-type.md @@ -9,38 +9,38 @@ | Name | | --- | -| `accountTransactionChanged` | -| `billingDateChange` | -| `componentAllocationChange` | -| `customerUpdate` | -| `customerCreate` | -| `dunningStepReached` | -| `expirationDateChange` | -| `expiringCard` | -| `meteredUsage` | -| `paymentSuccess` | -| `paymentSuccessRecreated` | -| `paymentFailure` | -| `paymentFailureRecreated` | -| `refundFailure` | -| `refundSuccess` | -| `renewalSuccess` | -| `renewalSuccessRecreated` | -| `renewalFailure` | -| `signupSuccess` | -| `signupFailure` | -| `statementClosed` | -| `statementSettled` | -| `subscriptionBankAccountUpdate` | -| `subscriptionDeletion` | -| `subscriptionPaypalAccountUpdate` | -| `subscriptionProductChange` | -| `subscriptionStateChange` | -| `trialEndNotice` | -| `upgradeDowngradeSuccess` | -| `upgradeDowngradeFailure` | -| `upcomingRenewalNotice` | -| `customFieldValueChange` | -| `subscriptionPrepaymentAccountBalanceChanged` | -| `subscriptionServiceCreditAccountBalanceChanged` | +| `AccountTransactionChanged` | +| `BillingDateChange` | +| `ComponentAllocationChange` | +| `CustomerUpdate` | +| `CustomerCreate` | +| `DunningStepReached` | +| `ExpirationDateChange` | +| `ExpiringCard` | +| `MeteredUsage` | +| `PaymentSuccess` | +| `PaymentSuccessRecreated` | +| `PaymentFailure` | +| `PaymentFailureRecreated` | +| `RefundFailure` | +| `RefundSuccess` | +| `RenewalSuccess` | +| `RenewalSuccessRecreated` | +| `RenewalFailure` | +| `SignupSuccess` | +| `SignupFailure` | +| `StatementClosed` | +| `StatementSettled` | +| `SubscriptionBankAccountUpdate` | +| `SubscriptionDeletion` | +| `SubscriptionPaypalAccountUpdate` | +| `SubscriptionProductChange` | +| `SubscriptionStateChange` | +| `TrialEndNotice` | +| `UpgradeDowngradeSuccess` | +| `UpgradeDowngradeFailure` | +| `UpcomingRenewalNotice` | +| `CustomFieldValueChange` | +| `SubscriptionPrepaymentAccountBalanceChanged` | +| `SubscriptionServiceCreditAccountBalanceChanged` | diff --git a/doc/models/expiration-interval-unit.md b/doc/models/expiration-interval-unit.md new file mode 100644 index 00000000..c0ee210b --- /dev/null +++ b/doc/models/expiration-interval-unit.md @@ -0,0 +1,15 @@ + +# Expiration Interval Unit + +## Enumeration + +`ExpirationIntervalUnit` + +## Fields + +| Name | +| --- | +| `Day` | +| `Month` | +| `Never` | + diff --git a/doc/models/extended-interval-unit.md b/doc/models/extended-interval-unit.md deleted file mode 100644 index 805e3177..00000000 --- a/doc/models/extended-interval-unit.md +++ /dev/null @@ -1,15 +0,0 @@ - -# Extended Interval Unit - -## Enumeration - -`ExtendedIntervalUnit` - -## Fields - -| Name | -| --- | -| `day` | -| `month` | -| `never` | - diff --git a/doc/models/failed-payment-action.md b/doc/models/failed-payment-action.md index 1f7ea74e..9a6a809b 100644 --- a/doc/models/failed-payment-action.md +++ b/doc/models/failed-payment-action.md @@ -15,7 +15,7 @@ Action taken when payment for an invoice fails: | Name | | --- | -| `leaveOpenInvoice` | -| `rollbackToPending` | -| `initiateDunning` | +| `LeaveOpenInvoice` | +| `RollbackToPending` | +| `InitiateDunning` | diff --git a/doc/models/failed-payment-event.md b/doc/models/failed-payment-event.md index a374769d..681d1259 100644 --- a/doc/models/failed-payment-event.md +++ b/doc/models/failed-payment-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/first-charge-type.md b/doc/models/first-charge-type.md index 7d7f6089..c35a7c93 100644 --- a/doc/models/first-charge-type.md +++ b/doc/models/first-charge-type.md @@ -9,7 +9,7 @@ | Name | | --- | -| `prorated` | -| `immediate` | -| `delayed` | +| `Prorated` | +| `Immediate` | +| `Delayed` | diff --git a/doc/models/full-subscription-group-response.md b/doc/models/full-subscription-group-response.md index 91bd91d5..72838daf 100644 --- a/doc/models/full-subscription-group-response.md +++ b/doc/models/full-subscription-group-response.md @@ -16,7 +16,7 @@ | `subscriptionIds` | `number[] \| undefined` | Optional | - | | `primarySubscriptionId` | `number \| undefined` | Optional | - | | `nextAssessmentAt` | `string \| undefined` | Optional | - | -| `state` | [`SubscriptionState \| undefined`](../../doc/models/subscription-state.md) | Optional | The state of a subscription.

* **Live States**
* `active` - A normal, active subscription. It is not in a trial and is paid and up to date.
* `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
* `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.
* **Problem States**
* `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
* `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.
* `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) settings to have a Final Action of `mark the subscription unpaid`.
* **End of Life States**
* `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) process without payment. See the [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404559291021) documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.
* `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.
* `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)
* `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.
* `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.
* `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221) for more details.

See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773) for more info about subscription states and state transitions. | +| `state` | [`SubscriptionState \| undefined`](../../doc/models/subscription-state.md) | Optional | The state of a subscription.

* **Live States**
* `active` - A normal, active subscription. It is not in a trial and is paid and up to date.
* `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
* `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.
* **Problem States**
* `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
* `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.
* `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) settings to have a Final Action of `mark the subscription unpaid`.
* **End of Life States**
* `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.
* `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.
* `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)
* `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.
* `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.
* `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing) for more details.

See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscription-States) for more info about subscription states and state transitions. | | `cancelAtEndOfPeriod` | `boolean \| undefined` | Optional | - | | `currentBillingAmountInCents` | `bigint \| undefined` | Optional | - | | `customer` | [`SubscriptionGroupCustomer \| undefined`](../../doc/models/subscription-group-customer.md) | Optional | - | diff --git a/doc/models/get-one-time-token-payment-profile.md b/doc/models/get-one-time-token-payment-profile.md index 70240f64..eb5fcee9 100644 --- a/doc/models/get-one-time-token-payment-profile.md +++ b/doc/models/get-one-time-token-payment-profile.md @@ -17,7 +17,7 @@ | `expirationMonth` | `number` | Required | - | | `expirationYear` | `number` | Required | - | | `customerId` | `string \| null \| undefined` | Optional | - | -| `currentVault` | [`CurrentVault`](../../doc/models/current-vault.md) | Required | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | +| `currentVault` | [`CreditCardVault`](../../doc/models/credit-card-vault.md) | Required | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | | `vaultToken` | `string` | Required | **Constraints**: *Minimum Length*: `1` | | `billingAddress` | `string` | Required | **Constraints**: *Minimum Length*: `1` | | `billingAddress2` | `string \| undefined` | Optional | - | @@ -43,7 +43,7 @@ "expiration_month": 187.78, "expiration_year": 164.44, "customer_id": "customer_id0", - "current_vault": "firstdata", + "current_vault": "braintree_blue", "vault_token": "vault_token4", "billing_address": "billing_address4", "billing_address_2": "billing_address_24", diff --git a/doc/models/get-one-time-token-request.md b/doc/models/get-one-time-token-request.md index c7e5103c..67390908 100644 --- a/doc/models/get-one-time-token-request.md +++ b/doc/models/get-one-time-token-request.md @@ -24,7 +24,7 @@ "expiration_month": 133.5, "expiration_year": 156.84, "customer_id": "customer_id2", - "current_vault": "eway", + "current_vault": "stripe", "vault_token": "vault_token6", "billing_address": "billing_address4", "billing_address_2": "billing_address_26", diff --git a/doc/models/group-target-type.md b/doc/models/group-target-type.md index 0ae0c29f..bce9ce84 100644 --- a/doc/models/group-target-type.md +++ b/doc/models/group-target-type.md @@ -11,9 +11,9 @@ The type of object indicated by the id attribute. | Name | | --- | -| `customer` | -| `subscription` | -| `self` | -| `parent` | -| `eldest` | +| `Customer` | +| `Subscription` | +| `Self` | +| `Parent` | +| `Eldest` | diff --git a/doc/models/group-type.md b/doc/models/group-type.md index 929cd896..97c0dfbc 100644 --- a/doc/models/group-type.md +++ b/doc/models/group-type.md @@ -9,6 +9,6 @@ | Name | | --- | -| `singleCustomer` | -| `multipleCustomers` | +| `SingleCustomer` | +| `MultipleCustomers` | diff --git a/doc/models/include-not-null.md b/doc/models/include-not-null.md index 53b587ec..3b297da0 100644 --- a/doc/models/include-not-null.md +++ b/doc/models/include-not-null.md @@ -11,7 +11,7 @@ Passed as a parameter to list methods to return only non null values. | Name | | --- | -| `notNull` | +| `NotNull` | ## Example diff --git a/doc/models/include-null-or-not-null.md b/doc/models/include-null-or-not-null.md index b8f141cd..c9209811 100644 --- a/doc/models/include-null-or-not-null.md +++ b/doc/models/include-null-or-not-null.md @@ -11,8 +11,8 @@ Allows to filter by `not_null` or `null`. | Name | | --- | -| `notNull` | -| `null` | +| `NotNull` | +| `Null` | ## Example diff --git a/doc/models/include-option.md b/doc/models/include-option.md index 4c4a0831..41d05156 100644 --- a/doc/models/include-option.md +++ b/doc/models/include-option.md @@ -9,6 +9,6 @@ | Name | | --- | -| `exclude` | -| `include` | +| `Exclude` | +| `Include` | diff --git a/doc/models/interval-unit.md b/doc/models/interval-unit.md index 61806aa1..94829529 100644 --- a/doc/models/interval-unit.md +++ b/doc/models/interval-unit.md @@ -9,6 +9,6 @@ | Name | | --- | -| `day` | -| `month` | +| `Day` | +| `Month` | diff --git a/doc/models/invoice-consolidation-level.md b/doc/models/invoice-consolidation-level.md index 5cd7c85a..9afb1551 100644 --- a/doc/models/invoice-consolidation-level.md +++ b/doc/models/invoice-consolidation-level.md @@ -9,7 +9,7 @@ Consolidation level of the invoice, which is applicable to invoice consolidation "Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments. -See also the [invoice consolidation documentation](https://chargify.zendesk.com/hc/en-us/articles/4407746391835). +See also the [invoice consolidation documentation](https://maxio.zendesk.com/hc/en-us/articles/24252269909389-Invoice-Consolidation). ## Enumeration @@ -19,7 +19,7 @@ See also the [invoice consolidation documentation](https://chargify.zendesk.com/ | Name | | --- | -| `none` | -| `child` | -| `parent` | +| `None` | +| `Child` | +| `Parent` | diff --git a/doc/models/invoice-date-field.md b/doc/models/invoice-date-field.md index af7215cf..350228c9 100644 --- a/doc/models/invoice-date-field.md +++ b/doc/models/invoice-date-field.md @@ -9,11 +9,11 @@ | Name | | --- | -| `createdAt` | -| `dueDate` | -| `issueDate` | -| `updatedAt` | -| `paidDate` | +| `CreatedAt` | +| `DueDate` | +| `IssueDate` | +| `UpdatedAt` | +| `PaidDate` | ## Example diff --git a/doc/models/invoice-discount-source-type.md b/doc/models/invoice-discount-source-type.md index 4cf6508b..fe7f4087 100644 --- a/doc/models/invoice-discount-source-type.md +++ b/doc/models/invoice-discount-source-type.md @@ -9,7 +9,7 @@ | Name | | --- | -| `coupon` | -| `referral` | -| `enumAdHocCoupon` | +| `Coupon` | +| `Referral` | +| `EnumAdHocCoupon` | diff --git a/doc/models/invoice-discount-type.md b/doc/models/invoice-discount-type.md index 22c76152..186af0a5 100644 --- a/doc/models/invoice-discount-type.md +++ b/doc/models/invoice-discount-type.md @@ -9,7 +9,7 @@ | Name | | --- | -| `percentage` | -| `flatAmount` | -| `rollover` | +| `Percentage` | +| `FlatAmount` | +| `Rollover` | diff --git a/doc/models/invoice-event-payment-method.md b/doc/models/invoice-event-payment-method.md index bff474f3..56503b33 100644 --- a/doc/models/invoice-event-payment-method.md +++ b/doc/models/invoice-event-payment-method.md @@ -9,9 +9,9 @@ | Name | | --- | -| `applePay` | -| `bankAccount` | -| `creditCard` | -| `external` | -| `paypalAccount` | +| `ApplePay` | +| `BankAccount` | +| `CreditCard` | +| `External` | +| `PaypalAccount` | diff --git a/doc/models/invoice-event-type.md b/doc/models/invoice-event-type.md index 4365bfa5..a6318ab4 100644 --- a/doc/models/invoice-event-type.md +++ b/doc/models/invoice-event-type.md @@ -11,19 +11,19 @@ Invoice Event Type | Name | | --- | -| `issueInvoice` | -| `applyCreditNote` | -| `createCreditNote` | -| `applyPayment` | -| `applyDebitNote` | -| `createDebitNote` | -| `refundInvoice` | -| `voidInvoice` | -| `voidRemainder` | -| `backportInvoice` | -| `changeInvoiceStatus` | -| `changeInvoiceCollectionMethod` | -| `removePayment` | -| `failedPayment` | -| `changeChargebackStatus` | +| `IssueInvoice` | +| `ApplyCreditNote` | +| `CreateCreditNote` | +| `ApplyPayment` | +| `ApplyDebitNote` | +| `CreateDebitNote` | +| `RefundInvoice` | +| `VoidInvoice` | +| `VoidRemainder` | +| `BackportInvoice` | +| `ChangeInvoiceStatus` | +| `ChangeInvoiceCollectionMethod` | +| `RemovePayment` | +| `FailedPayment` | +| `ChangeChargebackStatus` | diff --git a/doc/models/invoice-payment-method-type.md b/doc/models/invoice-payment-method-type.md index 2c792632..5b3c3461 100644 --- a/doc/models/invoice-payment-method-type.md +++ b/doc/models/invoice-payment-method-type.md @@ -11,10 +11,10 @@ The type of payment method used. Defaults to other. | Name | | --- | -| `creditCard` | -| `check` | -| `cash` | -| `moneyOrder` | -| `ach` | -| `other` | +| `CreditCard` | +| `Check` | +| `Cash` | +| `MoneyOrder` | +| `Ach` | +| `Other` | diff --git a/doc/models/invoice-payment-type.md b/doc/models/invoice-payment-type.md index 5d88e97d..1547e4f9 100644 --- a/doc/models/invoice-payment-type.md +++ b/doc/models/invoice-payment-type.md @@ -11,8 +11,8 @@ The type of payment to be applied to an Invoice. Defaults to external. | Name | | --- | -| `external` | -| `prepayment` | -| `serviceCredit` | -| `payment` | +| `External` | +| `Prepayment` | +| `ServiceCredit` | +| `Payment` | diff --git a/doc/models/invoice-refund.md b/doc/models/invoice-refund.md index be8c9d6d..13ba1bd4 100644 --- a/doc/models/invoice-refund.md +++ b/doc/models/invoice-refund.md @@ -17,6 +17,7 @@ | `gatewayTransactionId` | `string \| null \| undefined` | Optional | The transaction ID for the refund as returned from the payment gateway | | `gatewayUsed` | `string \| undefined` | Optional | - | | `gatewayHandle` | `string \| null \| undefined` | Optional | - | +| `achLateReject` | `boolean \| null \| undefined` | Optional | - | ## Example (as JSON) diff --git a/doc/models/invoice-response.md b/doc/models/invoice-response.md index eca1065d..1f4ba040 100644 --- a/doc/models/invoice-response.md +++ b/doc/models/invoice-response.md @@ -19,6 +19,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/invoice-role.md b/doc/models/invoice-role.md index 5530ccd8..0fb77224 100644 --- a/doc/models/invoice-role.md +++ b/doc/models/invoice-role.md @@ -9,14 +9,14 @@ | Name | | --- | -| `unset` | -| `signup` | -| `renewal` | -| `usage` | -| `reactivation` | -| `proration` | -| `migration` | -| `adhoc` | -| `backport` | -| `backportbalancereconciliation` | +| `Unset` | +| `Signup` | +| `Renewal` | +| `Usage` | +| `Reactivation` | +| `Proration` | +| `Migration` | +| `Adhoc` | +| `Backport` | +| `Backportbalancereconciliation` | diff --git a/doc/models/invoice-sort-field.md b/doc/models/invoice-sort-field.md index 97b3baca..030ebb64 100644 --- a/doc/models/invoice-sort-field.md +++ b/doc/models/invoice-sort-field.md @@ -9,14 +9,14 @@ | Name | | --- | -| `status` | -| `totalAmount` | -| `dueAmount` | -| `createdAt` | -| `updatedAt` | -| `issueDate` | -| `dueDate` | -| `number` | +| `Status` | +| `TotalAmount` | +| `DueAmount` | +| `CreatedAt` | +| `UpdatedAt` | +| `IssueDate` | +| `DueDate` | +| `Number` | ## Example diff --git a/doc/models/invoice-status.md b/doc/models/invoice-status.md index 687adbe5..b5785d72 100644 --- a/doc/models/invoice-status.md +++ b/doc/models/invoice-status.md @@ -1,7 +1,7 @@ # Invoice Status -The current status of the invoice. See [Invoice Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices#invoice-statuses) for more. +The current status of the invoice. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. ## Enumeration @@ -11,10 +11,10 @@ The current status of the invoice. See [Invoice Statuses](https://maxio-chargify | Name | | --- | -| `draft` | -| `open` | -| `paid` | -| `pending` | -| `voided` | -| `canceled` | +| `Draft` | +| `Open` | +| `Paid` | +| `Pending` | +| `Voided` | +| `Canceled` | diff --git a/doc/models/invoice-tax-component-breakout.md b/doc/models/invoice-tax-component-breakout.md index 150570ce..3624509a 100644 --- a/doc/models/invoice-tax-component-breakout.md +++ b/doc/models/invoice-tax-component-breakout.md @@ -13,6 +13,16 @@ | `percentage` | `string \| undefined` | Optional | - | | `countryCode` | `string \| undefined` | Optional | - | | `subdivisionCode` | `string \| undefined` | Optional | - | +| `taxAmount` | `string \| undefined` | Optional | - | +| `taxableAmount` | `string \| undefined` | Optional | - | +| `taxExemptAmount` | `string \| undefined` | Optional | - | +| `nonTaxableAmount` | `string \| undefined` | Optional | - | +| `taxName` | `string \| undefined` | Optional | - | +| `taxType` | `string \| undefined` | Optional | - | +| `rateType` | `string \| undefined` | Optional | - | +| `taxAuthorityType` | `number \| undefined` | Optional | - | +| `stateAssignedNo` | `string \| undefined` | Optional | - | +| `taxSubType` | `string \| undefined` | Optional | - | ## Example (as JSON) @@ -21,7 +31,8 @@ "tax_rule_id": 226, "percentage": "percentage0", "country_code": "country_code8", - "subdivision_code": "subdivision_code6" + "subdivision_code": "subdivision_code6", + "tax_amount": "tax_amount4" } ``` diff --git a/doc/models/invoice-tax.md b/doc/models/invoice-tax.md index fc47afcc..9ba63956 100644 --- a/doc/models/invoice-tax.md +++ b/doc/models/invoice-tax.md @@ -20,6 +20,9 @@ | `transactionId` | `number \| undefined` | Optional | - | | `lineItemBreakouts` | [`InvoiceTaxBreakout[] \| undefined`](../../doc/models/invoice-tax-breakout.md) | Optional | - | | `taxComponentBreakouts` | [`InvoiceTaxComponentBreakout[] \| undefined`](../../doc/models/invoice-tax-component-breakout.md) | Optional | - | +| `euVat` | `boolean \| undefined` | Optional | - | +| `type` | `string \| undefined` | Optional | - | +| `taxExemptAmount` | `string \| undefined` | Optional | - | ## Example (as JSON) diff --git a/doc/models/invoice.md b/doc/models/invoice.md index 69073f1a..fd3cb9ef 100644 --- a/doc/models/invoice.md +++ b/doc/models/invoice.md @@ -22,13 +22,13 @@ | `issueDate` | `string \| undefined` | Optional | Date the invoice was issued to the customer. This is the date that the invoice was made available for payment.

The format is `"YYYY-MM-DD"`. | | `dueDate` | `string \| undefined` | Optional | Date the invoice is due.

The format is `"YYYY-MM-DD"`. | | `paidDate` | `string \| null \| undefined` | Optional | Date the invoice became fully paid.

If partial payments are applied to the invoice, this date will not be present until payment has been made in full.

The format is `"YYYY-MM-DD"`. | -| `status` | [`InvoiceStatus \| undefined`](../../doc/models/invoice-status.md) | Optional | The current status of the invoice. See [Invoice Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices#invoice-statuses) for more. | +| `status` | [`InvoiceStatus \| undefined`](../../doc/models/invoice-status.md) | Optional | The current status of the invoice. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. | | `role` | [`InvoiceRole \| undefined`](../../doc/models/invoice-role.md) | Optional | - | | `parentInvoiceId` | `number \| null \| undefined` | Optional | - | | `collectionMethod` | [`CollectionMethod \| undefined`](../../doc/models/collection-method.md) | Optional | The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For current Relationship Invoicing Architecture valid options are - `remittance`, `automatic`, `prepaid`. | | `paymentInstructions` | `string \| undefined` | Optional | A message that is printed on the invoice when it is marked for remittance collection. It is intended to describe to the customer how they may make payment, and is configured by the merchant. | | `currency` | `string \| undefined` | Optional | The ISO 4217 currency code (3 character string) representing the currency of invoice transaction. | -| `consolidationLevel` | [`InvoiceConsolidationLevel \| undefined`](../../doc/models/invoice-consolidation-level.md) | Optional | Consolidation level of the invoice, which is applicable to invoice consolidation. It will hold one of the following values:

* "none": A normal invoice with no consolidation.
* "child": An invoice segment which has been combined into a consolidated invoice.
* "parent": A consolidated invoice, whose contents are composed of invoice segments.

"Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments.

See also the [invoice consolidation documentation](https://chargify.zendesk.com/hc/en-us/articles/4407746391835). | +| `consolidationLevel` | [`InvoiceConsolidationLevel \| undefined`](../../doc/models/invoice-consolidation-level.md) | Optional | Consolidation level of the invoice, which is applicable to invoice consolidation. It will hold one of the following values:

* "none": A normal invoice with no consolidation.
* "child": An invoice segment which has been combined into a consolidated invoice.
* "parent": A consolidated invoice, whose contents are composed of invoice segments.

"Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments.

See also the [invoice consolidation documentation](https://maxio.zendesk.com/hc/en-us/articles/24252269909389-Invoice-Consolidation). | | `parentInvoiceUid` | `string \| null \| undefined` | Optional | For invoices with `consolidation_level` of `child`, this specifies the UID of the parent (consolidated) invoice. | | `subscriptionGroupId` | `number \| null \| undefined` | Optional | - | | `parentInvoiceNumber` | `number \| null \| undefined` | Optional | For invoices with `consolidation_level` of `child`, this specifies the number of the parent (consolidated) invoice. | @@ -61,6 +61,7 @@ | `displaySettings` | [`InvoiceDisplaySettings \| undefined`](../../doc/models/invoice-display-settings.md) | Optional | - | | `publicUrl` | `string \| undefined` | Optional | The public URL of the invoice | | `previousBalanceData` | [`InvoicePreviousBalance \| undefined`](../../doc/models/invoice-previous-balance.md) | Optional | - | +| `publicUrlExpiresOn` | `string \| undefined` | Optional | The format is `"YYYY-MM-DD"`. | ## Example (as JSON) @@ -69,6 +70,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 252, "uid": "uid0", "site_id": 178, diff --git a/doc/models/issue-invoice-event-data.md b/doc/models/issue-invoice-event-data.md index d894d0fb..63ad92cd 100644 --- a/doc/models/issue-invoice-event-data.md +++ b/doc/models/issue-invoice-event-data.md @@ -11,9 +11,9 @@ Example schema for an `issue_invoice` event | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `consolidationLevel` | [`InvoiceConsolidationLevel`](../../doc/models/invoice-consolidation-level.md) | Required | Consolidation level of the invoice, which is applicable to invoice consolidation. It will hold one of the following values:

* "none": A normal invoice with no consolidation.
* "child": An invoice segment which has been combined into a consolidated invoice.
* "parent": A consolidated invoice, whose contents are composed of invoice segments.

"Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments.

See also the [invoice consolidation documentation](https://chargify.zendesk.com/hc/en-us/articles/4407746391835). | -| `fromStatus` | [`InvoiceStatus`](../../doc/models/invoice-status.md) | Required | The status of the invoice before event occurrence. See [Invoice Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices#invoice-statusess) for more. | -| `toStatus` | [`InvoiceStatus`](../../doc/models/invoice-status.md) | Required | The status of the invoice after event occurrence. See [Invoice Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices#invoice-statusess) for more. | +| `consolidationLevel` | [`InvoiceConsolidationLevel`](../../doc/models/invoice-consolidation-level.md) | Required | Consolidation level of the invoice, which is applicable to invoice consolidation. It will hold one of the following values:

* "none": A normal invoice with no consolidation.
* "child": An invoice segment which has been combined into a consolidated invoice.
* "parent": A consolidated invoice, whose contents are composed of invoice segments.

"Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments.

See also the [invoice consolidation documentation](https://maxio.zendesk.com/hc/en-us/articles/24252269909389-Invoice-Consolidation). | +| `fromStatus` | [`InvoiceStatus`](../../doc/models/invoice-status.md) | Required | The status of the invoice before event occurrence. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. | +| `toStatus` | [`InvoiceStatus`](../../doc/models/invoice-status.md) | Required | The status of the invoice after event occurrence. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. | | `dueAmount` | `string` | Required | Amount due on the invoice, which is `total_amount - credit_amount - paid_amount`. | | `totalAmount` | `string` | Required | The invoice total, which is `subtotal_amount - discount_amount + tax_amount`.' | diff --git a/doc/models/issue-invoice-event.md b/doc/models/issue-invoice-event.md index b4962cbd..19465d6e 100644 --- a/doc/models/issue-invoice-event.md +++ b/doc/models/issue-invoice-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/item-category.md b/doc/models/item-category.md index 6ccb4cd8..3d882ad3 100644 --- a/doc/models/item-category.md +++ b/doc/models/item-category.md @@ -11,11 +11,11 @@ One of the following: Business Software, Consumer Software, Digital Services, Ph | Name | | --- | -| `enumBusinessSoftware` | -| `enumConsumerSoftware` | -| `enumDigitalServices` | -| `enumPhysicalGoods` | -| `other` | +| `EnumBusinessSoftware` | +| `EnumConsumerSoftware` | +| `EnumDigitalServices` | +| `EnumPhysicalGoods` | +| `Other` | ## Example diff --git a/doc/models/line-item-kind.md b/doc/models/line-item-kind.md index 9614bf55..3e5e5d1d 100644 --- a/doc/models/line-item-kind.md +++ b/doc/models/line-item-kind.md @@ -11,14 +11,14 @@ A handle for the line item kind | Name | | --- | -| `baseline` | -| `initial` | -| `trial` | -| `quantityBasedComponent` | -| `prepaidUsageComponent` | -| `onOffComponent` | -| `meteredComponent` | -| `eventBasedComponent` | -| `coupon` | -| `tax` | +| `Baseline` | +| `Initial` | +| `Trial` | +| `QuantityBasedComponent` | +| `PrepaidUsageComponent` | +| `OnOffComponent` | +| `MeteredComponent` | +| `EventBasedComponent` | +| `Coupon` | +| `Tax` | diff --git a/doc/models/line-item-transaction-type.md b/doc/models/line-item-transaction-type.md index fe516563..64e30b89 100644 --- a/doc/models/line-item-transaction-type.md +++ b/doc/models/line-item-transaction-type.md @@ -11,11 +11,11 @@ A handle for the line item transaction type | Name | | --- | -| `charge` | -| `credit` | -| `adjustment` | -| `payment` | -| `refund` | -| `infoTransaction` | -| `paymentAuthorization` | +| `Charge` | +| `Credit` | +| `Adjustment` | +| `Payment` | +| `Refund` | +| `InfoTransaction` | +| `PaymentAuthorization` | diff --git a/doc/models/list-components-price-points-include.md b/doc/models/list-components-price-points-include.md index d5e6d043..78039a91 100644 --- a/doc/models/list-components-price-points-include.md +++ b/doc/models/list-components-price-points-include.md @@ -9,7 +9,7 @@ | Name | | --- | -| `currencyPrices` | +| `CurrencyPrices` | ## Example diff --git a/doc/models/list-events-date-field.md b/doc/models/list-events-date-field.md index 523d6301..d6364419 100644 --- a/doc/models/list-events-date-field.md +++ b/doc/models/list-events-date-field.md @@ -9,7 +9,7 @@ | Name | | --- | -| `createdAt` | +| `CreatedAt` | ## Example diff --git a/doc/models/list-invoices-response.md b/doc/models/list-invoices-response.md index 237bf512..55ca4b8f 100644 --- a/doc/models/list-invoices-response.md +++ b/doc/models/list-invoices-response.md @@ -20,6 +20,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 196, "uid": "uid6", "site_id": 122, diff --git a/doc/models/list-prepayment-date-field.md b/doc/models/list-prepayment-date-field.md index f9a67068..a143aa4d 100644 --- a/doc/models/list-prepayment-date-field.md +++ b/doc/models/list-prepayment-date-field.md @@ -9,8 +9,8 @@ | Name | | --- | -| `createdAt` | -| `applicationAt` | +| `CreatedAt` | +| `ApplicationAt` | ## Example diff --git a/doc/models/list-products-include.md b/doc/models/list-products-include.md index 8a5bb3b3..9cfc57b4 100644 --- a/doc/models/list-products-include.md +++ b/doc/models/list-products-include.md @@ -9,7 +9,7 @@ | Name | | --- | -| `prepaidProductPricePoint` | +| `PrepaidProductPricePoint` | ## Example diff --git a/doc/models/list-products-price-points-include.md b/doc/models/list-products-price-points-include.md index 45f0a73f..45aaf37f 100644 --- a/doc/models/list-products-price-points-include.md +++ b/doc/models/list-products-price-points-include.md @@ -9,7 +9,7 @@ | Name | | --- | -| `currencyPrices` | +| `CurrencyPrices` | ## Example diff --git a/doc/models/list-subscription-components-include.md b/doc/models/list-subscription-components-include.md index f147cbf0..2f68f49e 100644 --- a/doc/models/list-subscription-components-include.md +++ b/doc/models/list-subscription-components-include.md @@ -9,8 +9,8 @@ | Name | | --- | -| `subscription` | -| `historicUsages` | +| `Subscription` | +| `HistoricUsages` | ## Example diff --git a/doc/models/list-subscription-components-sort.md b/doc/models/list-subscription-components-sort.md index 97ec65d0..d0d59aed 100644 --- a/doc/models/list-subscription-components-sort.md +++ b/doc/models/list-subscription-components-sort.md @@ -9,8 +9,8 @@ | Name | | --- | -| `id` | -| `updatedAt` | +| `Id` | +| `UpdatedAt` | ## Example diff --git a/doc/models/metafield-input.md b/doc/models/metafield-input.md index 8412095f..6bf74038 100644 --- a/doc/models/metafield-input.md +++ b/doc/models/metafield-input.md @@ -11,8 +11,8 @@ Indicates how data should be added to the metafield. For example, a text type is | Name | | --- | -| `balanceTracker` | -| `text` | -| `radio` | -| `dropdown` | +| `BalanceTracker` | +| `Text` | +| `Radio` | +| `Dropdown` | diff --git a/doc/models/metered-component.md b/doc/models/metered-component.md index 48f2d8ba..c6ffbe40 100644 --- a/doc/models/metered-component.md +++ b/doc/models/metered-component.md @@ -15,7 +15,7 @@ | `handle` | `string \| undefined` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | | `taxable` | `boolean \| undefined` | Optional | Boolean flag describing whether a component is taxable or not. | | `pricingScheme` | [`PricingScheme`](../../doc/models/pricing-scheme.md) | Required | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. | -| `prices` | [`Price[] \| undefined`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | +| `prices` | [`Price[] \| undefined`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Component-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | | `upgradeCharge` | [`CreditType \| null \| undefined`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | | `downgradeCredit` | [`CreditType \| null \| undefined`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | | `pricePoints` | [`ComponentPricePointItem[] \| undefined`](../../doc/models/component-price-point-item.md) | Optional | - | @@ -27,7 +27,7 @@ | `allowFractionalQuantities` | `boolean \| undefined` | Optional | - | | `publicSignupPageIds` | `number[] \| undefined` | Optional | - | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. | ## Example (as JSON) diff --git a/doc/models/offer-item.md b/doc/models/offer-item.md index faf86e5e..81698eb8 100644 --- a/doc/models/offer-item.md +++ b/doc/models/offer-item.md @@ -18,7 +18,7 @@ | `pricePointName` | `string \| undefined` | Optional | - | | `currencyPrices` | [`CurrencyPrice[] \| undefined`](../../doc/models/currency-price.md) | Optional | - | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of '30' coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | ## Example (as JSON) diff --git a/doc/models/on-off-component.md b/doc/models/on-off-component.md index 6c05c097..c54dc4a2 100644 --- a/doc/models/on-off-component.md +++ b/doc/models/on-off-component.md @@ -13,7 +13,7 @@ | `description` | `string \| undefined` | Optional | A description for the component that will be displayed to the user on the hosted signup page. | | `handle` | `string \| undefined` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | | `taxable` | `boolean \| undefined` | Optional | Boolean flag describing whether a component is taxable or not. | -| `prices` | [`Price[] \| undefined`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | +| `prices` | [`Price[] \| undefined`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261191737101-Price-Points-Components) for an overview of how price brackets work for different pricing schemes. | | `upgradeCharge` | [`CreditType \| null \| undefined`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | | `downgradeCredit` | [`CreditType \| null \| undefined`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | | `pricePoints` | [`ComponentPricePointItem[] \| undefined`](../../doc/models/component-price-point-item.md) | Optional | - | @@ -25,7 +25,7 @@ | `allowFractionalQuantities` | `boolean \| undefined` | Optional | - | | `publicSignupPageIds` | `number[] \| undefined` | Optional | - | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. | ## Example (as JSON) diff --git a/doc/models/paid-invoice.md b/doc/models/paid-invoice.md index fa6a20b9..3637db42 100644 --- a/doc/models/paid-invoice.md +++ b/doc/models/paid-invoice.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `invoiceId` | `string \| undefined` | Optional | The uid of the paid invoice | -| `status` | [`InvoiceStatus \| undefined`](../../doc/models/invoice-status.md) | Optional | The current status of the invoice. See [Invoice Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices#invoice-statuses) for more. | +| `status` | [`InvoiceStatus \| undefined`](../../doc/models/invoice-status.md) | Optional | The current status of the invoice. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. | | `dueAmount` | `string \| undefined` | Optional | The remaining due amount on the invoice | | `paidAmount` | `string \| undefined` | Optional | The total amount paid on this invoice (including any prior payments) | diff --git a/doc/models/pay-pal-vault.md b/doc/models/pay-pal-vault.md new file mode 100644 index 00000000..fc7462f6 --- /dev/null +++ b/doc/models/pay-pal-vault.md @@ -0,0 +1,18 @@ + +# Pay Pal Vault + +The vault that stores the payment profile with the provided vault_token. + +## Enumeration + +`PayPalVault` + +## Fields + +| Name | +| --- | +| `BraintreeBlue` | +| `Paypal` | +| `Moduslink` | +| `PaypalComplete` | + diff --git a/doc/models/payment-profile-attributes.md b/doc/models/payment-profile-attributes.md index 19bb5307..15a52725 100644 --- a/doc/models/payment-profile-attributes.md +++ b/doc/models/payment-profile-attributes.md @@ -11,9 +11,9 @@ alias to credit_card_attributes | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `chargifyToken` | `string \| undefined` | Optional | (Optional) Token received after sending billing informations using chargify.js. This token must be passed as a sole attribute of `payment_profile_attributes` (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) | +| `chargifyToken` | `string \| undefined` | Optional | (Optional) Token received after sending billing information using chargify.js. This token must be passed as a sole attribute of `payment_profile_attributes` (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) | | `id` | `number \| undefined` | Optional | - | -| `paymentType` | `string \| undefined` | Optional | - | +| `paymentType` | [`PaymentType \| undefined`](../../doc/models/payment-type.md) | Optional | - | | `firstName` | `string \| undefined` | Optional | (Optional) First name on card or bank account. If omitted, the first_name from customer attributes will be used. | | `lastName` | `string \| undefined` | Optional | (Optional) Last name on card or bank account. If omitted, the last_name from customer attributes will be used. | | `maskedCardNumber` | `string \| undefined` | Optional | - | @@ -27,7 +27,7 @@ alias to credit_card_attributes | `billingState` | `string \| undefined` | Optional | (Optional, may be required by your product configuration or gateway settings) The credit card or bank account billing address state (i.e. MA). This value is merely passed through to the payment gateway. This must conform to the [ISO_3166-1](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) in order to be valid for tax locale purposes. | | `billingCountry` | `string \| undefined` | Optional | (Optional, may be required by your product configuration or gateway settings) The credit card or bank account billing address country, required in [ISO_3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format (i.e. “US”). This value is merely passed through to the payment gateway. Some gateways require country codes in a specific format. Please check your gateway’s documentation. If creating an ACH subscription, only US is supported at this time. | | `billingZip` | `string \| undefined` | Optional | (Optional, may be required by your product configuration or gateway settings) The credit card or bank account billing address zip code (i.e. 12345). This value is merely passed through to the payment gateway. | -| `currentVault` | [`CurrentVault \| undefined`](../../doc/models/current-vault.md) | Optional | (Optional, used only for Subscription Import) The vault that stores the payment profile with the provided vault_token. | +| `currentVault` | [`AllVaults \| undefined`](../../doc/models/all-vaults.md) | Optional | (Optional, used only for Subscription Import) The vault that stores the payment profile with the provided vault_token. | | `vaultToken` | `string \| undefined` | Optional | (Optional, used only for Subscription Import) The “token” provided by your vault storage for an already stored payment profile | | `customerVaultToken` | `string \| undefined` | Optional | (Optional, used only for Subscription Import) (only for Authorize.Net CIM storage or Square) The customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token | | `customerId` | `number \| undefined` | Optional | - | @@ -43,7 +43,7 @@ alias to credit_card_attributes { "chargify_token": "chargify_token8", "id": 80, - "payment_type": "payment_type0", + "payment_type": "credit_card", "first_name": "first_name0", "last_name": "last_name8" } diff --git a/doc/models/payment-profile-response.md b/doc/models/payment-profile-response.md index 2ab746ef..ac022105 100644 --- a/doc/models/payment-profile-response.md +++ b/doc/models/payment-profile-response.md @@ -9,21 +9,19 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `paymentProfile` | [`PaymentProfileResponsePaymentProfile`](../../doc/models/containers/payment-profile-response-payment-profile.md) | Required | This is a container for one-of cases. | +| `paymentProfile` | [`PaymentProfile`](../../doc/models/containers/payment-profile.md) | Required | - | ## Example (as JSON) ```json { "payment_profile": { - "masked_bank_routing_number": "masked_bank_routing_number8", - "masked_bank_account_number": "masked_bank_account_number8", - "verified": false, - "id": 188, - "first_name": "first_name6", - "last_name": "last_name4", - "customer_id": 226, - "current_vault": "authorizenet" + "payment_type": "apple_pay", + "id": 60, + "first_name": "first_name2", + "last_name": "last_name0", + "customer_id": 98, + "current_vault": "braintree_blue" } } ``` diff --git a/doc/models/payment-type.md b/doc/models/payment-type.md index c3be9765..8b72290f 100644 --- a/doc/models/payment-type.md +++ b/doc/models/payment-type.md @@ -9,7 +9,8 @@ | Name | | --- | -| `creditCard` | -| `bankAccount` | -| `paypalAccount` | +| `CreditCard` | +| `BankAccount` | +| `PaypalAccount` | +| `ApplePay` | diff --git a/doc/models/paypal-payment-profile.md b/doc/models/paypal-payment-profile.md new file mode 100644 index 00000000..4d08234a --- /dev/null +++ b/doc/models/paypal-payment-profile.md @@ -0,0 +1,42 @@ + +# Paypal Payment Profile + +## Structure + +`PaypalPaymentProfile` + +## Fields + +| Name | Type | Tags | Description | +| --- | --- | --- | --- | +| `id` | `number \| undefined` | Optional | The Chargify-assigned ID of the stored PayPal payment profile. | +| `firstName` | `string \| undefined` | Optional | The first name of the PayPal account holder | +| `lastName` | `string \| undefined` | Optional | The last name of the PayPal account holder | +| `customerId` | `number \| undefined` | Optional | The Chargify-assigned id for the customer record to which the PayPal account belongs | +| `currentVault` | [`PayPalVault \| undefined`](../../doc/models/pay-pal-vault.md) | Optional | The vault that stores the payment profile with the provided vault_token. | +| `vaultToken` | `string \| undefined` | Optional | The “token” provided by your vault storage for an already stored payment profile | +| `billingAddress` | `string \| null \| undefined` | Optional | The current billing street address for the PayPal account | +| `billingCity` | `string \| null \| undefined` | Optional | The current billing address city for the PayPal account | +| `billingState` | `string \| null \| undefined` | Optional | The current billing address state for the PayPal account | +| `billingZip` | `string \| null \| undefined` | Optional | The current billing address zip code for the PayPal account | +| `billingCountry` | `string \| null \| undefined` | Optional | The current billing address country for the PayPal account | +| `customerVaultToken` | `string \| null \| undefined` | Optional | - | +| `billingAddress2` | `string \| null \| undefined` | Optional | The current billing street address, second line, for the PayPal account | +| `paymentType` | [`PaymentType`](../../doc/models/payment-type.md) | Required | **Default**: `PaymentType.PaypalAccount` | +| `siteGatewaySettingId` | `number \| null \| undefined` | Optional | - | +| `gatewayHandle` | `string \| null \| undefined` | Optional | - | +| `paypalEmail` | `string \| undefined` | Optional | - | + +## Example (as JSON) + +```json +{ + "payment_type": "paypal_account", + "id": 10, + "first_name": "first_name0", + "last_name": "last_name8", + "customer_id": 48, + "current_vault": "moduslink" +} +``` + diff --git a/doc/models/prepaid-usage-component.md b/doc/models/prepaid-usage-component.md index 28f20545..efd18d7b 100644 --- a/doc/models/prepaid-usage-component.md +++ b/doc/models/prepaid-usage-component.md @@ -15,7 +15,7 @@ | `handle` | `string \| undefined` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | | `taxable` | `boolean \| undefined` | Optional | Boolean flag describing whether a component is taxable or not. | | `pricingScheme` | [`PricingScheme \| undefined`](../../doc/models/pricing-scheme.md) | Optional | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. | -| `prices` | [`Price[] \| undefined`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#general-price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | +| `prices` | [`Price[] \| undefined`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Component-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | | `upgradeCharge` | [`CreditType \| null \| undefined`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | | `downgradeCredit` | [`CreditType \| null \| undefined`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | | `pricePoints` | [`PrepaidComponentPricePoint[] \| undefined`](../../doc/models/prepaid-component-price-point.md) | Optional | - | @@ -27,7 +27,7 @@ | `rolloverPrepaidRemainder` | `boolean \| undefined` | Optional | Boolean which controls whether or not remaining units should be rolled over to the next period | | `renewPrepaidAllocation` | `boolean \| undefined` | Optional | Boolean which controls whether or not the allocated quantity should be renewed at the beginning of each period | | `expirationInterval` | `number \| undefined` | Optional | (only for prepaid usage components where rollover_prepaid_remainder is true) The number of `expiration_interval_unit`s after which rollover amounts should expire | -| `expirationIntervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | - | +| `expirationIntervalUnit` | [`ExpirationIntervalUnit \| null \| undefined`](../../doc/models/expiration-interval-unit.md) | Optional | - | | `displayOnHostedPage` | `boolean \| undefined` | Optional | - | | `allowFractionalQuantities` | `boolean \| undefined` | Optional | - | | `publicSignupPageIds` | `number[] \| undefined` | Optional | - | diff --git a/doc/models/prepayment-method.md b/doc/models/prepayment-method.md index b1c858fc..10b58a6e 100644 --- a/doc/models/prepayment-method.md +++ b/doc/models/prepayment-method.md @@ -9,11 +9,11 @@ | Name | | --- | -| `check` | -| `cash` | -| `moneyOrder` | -| `ach` | -| `paypalAccount` | -| `creditCard` | -| `other` | +| `Check` | +| `Cash` | +| `MoneyOrder` | +| `Ach` | +| `PaypalAccount` | +| `CreditCard` | +| `Other` | diff --git a/doc/models/price-point-type.md b/doc/models/price-point-type.md index dbed85a4..aa976681 100644 --- a/doc/models/price-point-type.md +++ b/doc/models/price-point-type.md @@ -15,7 +15,7 @@ Price point type. We expose the following types: | Name | | --- | -| `catalog` | -| `default` | -| `custom` | +| `Catalog` | +| `Default` | +| `Custom` | diff --git a/doc/models/pricing-scheme.md b/doc/models/pricing-scheme.md index 92b5dfce..2d4daff3 100644 --- a/doc/models/pricing-scheme.md +++ b/doc/models/pricing-scheme.md @@ -11,8 +11,8 @@ The identifier for the pricing scheme. See [Product Components](https://help.cha | Name | | --- | -| `stairstep` | -| `volume` | -| `perUnit` | -| `tiered` | +| `Stairstep` | +| `Volume` | +| `PerUnit` | +| `Tiered` | diff --git a/doc/models/product-price-point.md b/doc/models/product-price-point.md index b447d284..6d4b8d82 100644 --- a/doc/models/product-price-point.md +++ b/doc/models/product-price-point.md @@ -23,7 +23,7 @@ | `initialChargeInCents` | `bigint \| null \| undefined` | Optional | The product price point initial charge, in integer cents | | `initialChargeAfterTrial` | `boolean \| null \| undefined` | Optional | - | | `expirationInterval` | `number \| null \| undefined` | Optional | The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product price point would expire after 30 days | -| `expirationIntervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the expiration interval unit for this product price point, either month or day | +| `expirationIntervalUnit` | [`ExpirationIntervalUnit \| null \| undefined`](../../doc/models/expiration-interval-unit.md) | Optional | A string representing the expiration interval unit for this product price point, either month, day or never | | `productId` | `number \| undefined` | Optional | The product id this price point belongs to | | `archivedAt` | `string \| null \| undefined` | Optional | Timestamp indicating when this price point was archived | | `createdAt` | `string \| undefined` | Optional | Timestamp indicating when this price point was created | diff --git a/doc/models/product.md b/doc/models/product.md index aa0a42a2..b37ad787 100644 --- a/doc/models/product.md +++ b/doc/models/product.md @@ -16,7 +16,7 @@ | `accountingCode` | `string \| null \| undefined` | Optional | E.g. Internal ID or SKU Number | | `requestCreditCard` | `boolean \| undefined` | Optional | Deprecated value that can be ignored unless you have legacy hosted pages. For Public Signup Page users, please read this attribute from under the signup page. | | `expirationInterval` | `number \| null \| undefined` | Optional | A numerical interval for the length a subscription to this product will run before it expires. See the description of interval for a description of how this value is coupled with an interval unit to calculate the full interval | -| `expirationIntervalUnit` | [`ExtendedIntervalUnit \| null \| undefined`](../../doc/models/extended-interval-unit.md) | Optional | A string representing the expiration interval unit for this product, either month or day | +| `expirationIntervalUnit` | [`ExpirationIntervalUnit \| null \| undefined`](../../doc/models/expiration-interval-unit.md) | Optional | A string representing the expiration interval unit for this product, either month, day or never | | `createdAt` | `string \| undefined` | Optional | Timestamp indicating when this product was created | | `updatedAt` | `string \| undefined` | Optional | Timestamp indicating when this product was last updated | | `priceInCents` | `bigint \| undefined` | Optional | The product price, in integer cents | diff --git a/doc/models/proforma-invoice-discount-source-type.md b/doc/models/proforma-invoice-discount-source-type.md index 40e8be7c..4618f4f7 100644 --- a/doc/models/proforma-invoice-discount-source-type.md +++ b/doc/models/proforma-invoice-discount-source-type.md @@ -9,6 +9,6 @@ | Name | | --- | -| `coupon` | -| `referral` | +| `Coupon` | +| `Referral` | diff --git a/doc/models/proforma-invoice-role.md b/doc/models/proforma-invoice-role.md index d4a86ef2..21f1d26b 100644 --- a/doc/models/proforma-invoice-role.md +++ b/doc/models/proforma-invoice-role.md @@ -11,8 +11,8 @@ | Name | | --- | -| `unset` | -| `proforma` | -| `proformaAdhoc` | -| `proformaAutomatic` | +| `Unset` | +| `Proforma` | +| `ProformaAdhoc` | +| `ProformaAutomatic` | diff --git a/doc/models/proforma-invoice-status.md b/doc/models/proforma-invoice-status.md index 54f67a09..95854de9 100644 --- a/doc/models/proforma-invoice-status.md +++ b/doc/models/proforma-invoice-status.md @@ -9,7 +9,7 @@ | Name | | --- | -| `draft` | -| `voided` | -| `archived` | +| `Draft` | +| `Voided` | +| `Archived` | diff --git a/doc/models/proforma-invoice-tax-source-type.md b/doc/models/proforma-invoice-tax-source-type.md index ffc3432d..4bd4e3ee 100644 --- a/doc/models/proforma-invoice-tax-source-type.md +++ b/doc/models/proforma-invoice-tax-source-type.md @@ -9,6 +9,6 @@ | Name | | --- | -| `tax` | -| `avalara` | +| `Tax` | +| `Avalara` | diff --git a/doc/models/proforma-invoice.md b/doc/models/proforma-invoice.md index 5d651050..0846fb78 100644 --- a/doc/models/proforma-invoice.md +++ b/doc/models/proforma-invoice.md @@ -21,7 +21,7 @@ | `collectionMethod` | [`CollectionMethod \| undefined`](../../doc/models/collection-method.md) | Optional | The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For current Relationship Invoicing Architecture valid options are - `remittance`, `automatic`, `prepaid`. | | `paymentInstructions` | `string \| undefined` | Optional | - | | `currency` | `string \| undefined` | Optional | - | -| `consolidationLevel` | [`InvoiceConsolidationLevel \| undefined`](../../doc/models/invoice-consolidation-level.md) | Optional | Consolidation level of the invoice, which is applicable to invoice consolidation. It will hold one of the following values:

* "none": A normal invoice with no consolidation.
* "child": An invoice segment which has been combined into a consolidated invoice.
* "parent": A consolidated invoice, whose contents are composed of invoice segments.

"Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments.

See also the [invoice consolidation documentation](https://chargify.zendesk.com/hc/en-us/articles/4407746391835). | +| `consolidationLevel` | [`InvoiceConsolidationLevel \| undefined`](../../doc/models/invoice-consolidation-level.md) | Optional | Consolidation level of the invoice, which is applicable to invoice consolidation. It will hold one of the following values:

* "none": A normal invoice with no consolidation.
* "child": An invoice segment which has been combined into a consolidated invoice.
* "parent": A consolidated invoice, whose contents are composed of invoice segments.

"Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments.

See also the [invoice consolidation documentation](https://maxio.zendesk.com/hc/en-us/articles/24252269909389-Invoice-Consolidation). | | `productName` | `string \| undefined` | Optional | - | | `productFamilyName` | `string \| undefined` | Optional | - | | `role` | [`ProformaInvoiceRole \| undefined`](../../doc/models/proforma-invoice-role.md) | Optional | 'proforma' value is deprecated in favor of proforma_adhoc and proforma_automatic | diff --git a/doc/models/quantity-based-component.md b/doc/models/quantity-based-component.md index d25e8edd..f89e56fd 100644 --- a/doc/models/quantity-based-component.md +++ b/doc/models/quantity-based-component.md @@ -15,7 +15,7 @@ | `handle` | `string \| undefined` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | | `taxable` | `boolean \| undefined` | Optional | Boolean flag describing whether a component is taxable or not. | | `pricingScheme` | [`PricingScheme`](../../doc/models/pricing-scheme.md) | Required | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. | -| `prices` | [`Price[] \| undefined`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | +| `prices` | [`Price[] \| undefined`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Component-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | | `upgradeCharge` | [`CreditType \| null \| undefined`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | | `downgradeCredit` | [`CreditType \| null \| undefined`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | | `pricePoints` | [`ComponentPricePointItem[] \| undefined`](../../doc/models/component-price-point-item.md) | Optional | - | @@ -28,7 +28,7 @@ | `allowFractionalQuantities` | `boolean \| undefined` | Optional | - | | `publicSignupPageIds` | `number[] \| undefined` | Optional | - | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. | ## Example (as JSON) diff --git a/doc/models/reactivation-charge.md b/doc/models/reactivation-charge.md index 4c0826e7..a661edd3 100644 --- a/doc/models/reactivation-charge.md +++ b/doc/models/reactivation-charge.md @@ -11,7 +11,7 @@ You may choose how to handle the reactivation charge for that subscription: 1) ` | Name | | --- | -| `prorated` | -| `immediate` | -| `delayed` | +| `Prorated` | +| `Immediate` | +| `Delayed` | diff --git a/doc/models/recurring-scheme.md b/doc/models/recurring-scheme.md index 2bdb8cef..547307c3 100644 --- a/doc/models/recurring-scheme.md +++ b/doc/models/recurring-scheme.md @@ -9,7 +9,7 @@ | Name | | --- | -| `doNotRecur` | -| `recurIndefinitely` | -| `recurWithDuration` | +| `DoNotRecur` | +| `RecurIndefinitely` | +| `RecurWithDuration` | diff --git a/doc/models/refund-invoice-event-data.md b/doc/models/refund-invoice-event-data.md index a921b2b7..f797ce01 100644 --- a/doc/models/refund-invoice-event-data.md +++ b/doc/models/refund-invoice-event-data.md @@ -12,7 +12,7 @@ Example schema for an `refund_invoice` event | Name | Type | Tags | Description | | --- | --- | --- | --- | | `applyCredit` | `boolean` | Required | If true, credit was created and applied it to the invoice. | -| `consolidationLevel` | [`InvoiceConsolidationLevel \| undefined`](../../doc/models/invoice-consolidation-level.md) | Optional | Consolidation level of the invoice, which is applicable to invoice consolidation. It will hold one of the following values:

* "none": A normal invoice with no consolidation.
* "child": An invoice segment which has been combined into a consolidated invoice.
* "parent": A consolidated invoice, whose contents are composed of invoice segments.

"Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments.

See also the [invoice consolidation documentation](https://chargify.zendesk.com/hc/en-us/articles/4407746391835). | +| `consolidationLevel` | [`InvoiceConsolidationLevel \| undefined`](../../doc/models/invoice-consolidation-level.md) | Optional | Consolidation level of the invoice, which is applicable to invoice consolidation. It will hold one of the following values:

* "none": A normal invoice with no consolidation.
* "child": An invoice segment which has been combined into a consolidated invoice.
* "parent": A consolidated invoice, whose contents are composed of invoice segments.

"Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments.

See also the [invoice consolidation documentation](https://maxio.zendesk.com/hc/en-us/articles/24252269909389-Invoice-Consolidation). | | `creditNoteAttributes` | [`CreditNote`](../../doc/models/credit-note.md) | Required | - | | `memo` | `string \| undefined` | Optional | The refund memo. | | `originalAmount` | `string \| undefined` | Optional | The full, original amount of the refund. | diff --git a/doc/models/refund-invoice-event.md b/doc/models/refund-invoice-event.md index 3c415c6c..937c7865 100644 --- a/doc/models/refund-invoice-event.md +++ b/doc/models/refund-invoice-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/remove-payment-event.md b/doc/models/remove-payment-event.md index 2d1ba9c6..9d79aff1 100644 --- a/doc/models/remove-payment-event.md +++ b/doc/models/remove-payment-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/resent-invitation.md b/doc/models/resent-invitation.md index 8b9102d0..3d60fc66 100644 --- a/doc/models/resent-invitation.md +++ b/doc/models/resent-invitation.md @@ -13,11 +13,15 @@ | `lastAcceptedAt` | `string \| undefined` | Optional | - | | `sendInviteLinkText` | `string \| undefined` | Optional | - | | `uninvitedCount` | `number \| undefined` | Optional | - | +| `lastInviteSentAt` | `string \| undefined` | Optional | - | +| `lastInviteAcceptedAt` | `string \| undefined` | Optional | - | ## Example (as JSON) ```json { + "last_invite_sent_at": "01/01/2024 04:30:00", + "last_invite_accepted_at": "01/01/2024 04:35:00", "last_sent_at": "last_sent_at8", "last_accepted_at": "last_accepted_at8", "send_invite_link_text": "send_invite_link_text6", diff --git a/doc/models/resource-type.md b/doc/models/resource-type.md index 290f4774..c72afba5 100644 --- a/doc/models/resource-type.md +++ b/doc/models/resource-type.md @@ -9,6 +9,6 @@ | Name | | --- | -| `subscriptions` | -| `customers` | +| `Subscriptions` | +| `Customers` | diff --git a/doc/models/restriction-type.md b/doc/models/restriction-type.md index 2e898abb..c69ef31a 100644 --- a/doc/models/restriction-type.md +++ b/doc/models/restriction-type.md @@ -9,6 +9,6 @@ | Name | | --- | -| `component` | -| `product` | +| `Component` | +| `Product` | diff --git a/doc/models/resumption-charge.md b/doc/models/resumption-charge.md index 1a92486e..f3a3fd80 100644 --- a/doc/models/resumption-charge.md +++ b/doc/models/resumption-charge.md @@ -11,7 +11,7 @@ | Name | | --- | -| `prorated` | -| `immediate` | -| `delayed` | +| `Prorated` | +| `Immediate` | +| `Delayed` | diff --git a/doc/models/service-credit-type.md b/doc/models/service-credit-type.md index 4dfffc72..6d70a37f 100644 --- a/doc/models/service-credit-type.md +++ b/doc/models/service-credit-type.md @@ -11,6 +11,6 @@ The type of entry | Name | | --- | -| `credit` | -| `debit` | +| `Credit` | +| `Debit` | diff --git a/doc/models/snap-day.md b/doc/models/snap-day.md index 49750e06..4015f173 100644 --- a/doc/models/snap-day.md +++ b/doc/models/snap-day.md @@ -11,5 +11,5 @@ Use for subscriptions with product eligible for calendar billing only. Value can | Name | | --- | -| `end` | +| `End` | diff --git a/doc/models/sorting-direction.md b/doc/models/sorting-direction.md index ddfe5713..047e9eda 100644 --- a/doc/models/sorting-direction.md +++ b/doc/models/sorting-direction.md @@ -11,6 +11,6 @@ Used for sorting results. | Name | | --- | -| `asc` | -| `desc` | +| `Asc` | +| `Desc` | diff --git a/doc/models/subscription-component-subscription.md b/doc/models/subscription-component-subscription.md index c2aa9183..2d8d0fbc 100644 --- a/doc/models/subscription-component-subscription.md +++ b/doc/models/subscription-component-subscription.md @@ -11,7 +11,7 @@ An optional object, will be returned if provided `include=subscription` query pa | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `state` | [`SubscriptionState \| undefined`](../../doc/models/subscription-state.md) | Optional | The state of a subscription.

* **Live States**
* `active` - A normal, active subscription. It is not in a trial and is paid and up to date.
* `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
* `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.
* **Problem States**
* `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
* `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.
* `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) settings to have a Final Action of `mark the subscription unpaid`.
* **End of Life States**
* `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) process without payment. See the [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404559291021) documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.
* `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.
* `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)
* `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.
* `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.
* `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221) for more details.

See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773) for more info about subscription states and state transitions. | +| `state` | [`SubscriptionState \| undefined`](../../doc/models/subscription-state.md) | Optional | The state of a subscription.

* **Live States**
* `active` - A normal, active subscription. It is not in a trial and is paid and up to date.
* `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
* `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.
* **Problem States**
* `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
* `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.
* `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) settings to have a Final Action of `mark the subscription unpaid`.
* **End of Life States**
* `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.
* `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.
* `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)
* `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.
* `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.
* `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing) for more details.

See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscription-States) for more info about subscription states and state transitions. | | `updatedAt` | `string \| undefined` | Optional | - | ## Example (as JSON) diff --git a/doc/models/subscription-component.md b/doc/models/subscription-component.md index fa7c1e48..6e222ccf 100644 --- a/doc/models/subscription-component.md +++ b/doc/models/subscription-component.md @@ -40,7 +40,7 @@ | `historicUsages` | [`HistoricUsage[] \| undefined`](../../doc/models/historic-usage.md) | Optional | - | | `displayOnHostedPage` | `boolean \| undefined` | Optional | - | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of '30' coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | ## Example (as JSON) diff --git a/doc/models/subscription-custom-price.md b/doc/models/subscription-custom-price.md index 3dcff4fc..1a8ee0e8 100644 --- a/doc/models/subscription-custom-price.md +++ b/doc/models/subscription-custom-price.md @@ -15,14 +15,14 @@ | `handle` | `string \| undefined` | Optional | (Optional) | | `priceInCents` | [`SubscriptionCustomPricePriceInCents`](../../doc/models/containers/subscription-custom-price-price-in-cents.md) | Required | This is a container for one-of cases. | | `interval` | [`SubscriptionCustomPriceInterval`](../../doc/models/containers/subscription-custom-price-interval.md) | Required | This is a container for one-of cases. | -| `intervalUnit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Required | Required if using `custom_price` attribute. | +| `intervalUnit` | [`IntervalUnit \| null`](../../doc/models/interval-unit.md) | Required | Required if using `custom_price` attribute. | | `trialPriceInCents` | [`SubscriptionCustomPriceTrialPriceInCents \| undefined`](../../doc/models/containers/subscription-custom-price-trial-price-in-cents.md) | Optional | This is a container for one-of cases. | | `trialInterval` | [`SubscriptionCustomPriceTrialInterval \| undefined`](../../doc/models/containers/subscription-custom-price-trial-interval.md) | Optional | This is a container for one-of cases. | | `trialIntervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | (Optional) | | `initialChargeInCents` | [`SubscriptionCustomPriceInitialChargeInCents \| undefined`](../../doc/models/containers/subscription-custom-price-initial-charge-in-cents.md) | Optional | This is a container for one-of cases. | | `initialChargeAfterTrial` | `boolean \| undefined` | Optional | (Optional) | | `expirationInterval` | [`SubscriptionCustomPriceExpirationInterval \| undefined`](../../doc/models/containers/subscription-custom-price-expiration-interval.md) | Optional | This is a container for one-of cases. | -| `expirationIntervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | (Optional) | +| `expirationIntervalUnit` | [`ExpirationIntervalUnit \| null \| undefined`](../../doc/models/expiration-interval-unit.md) | Optional | (Optional) | | `taxIncluded` | `boolean \| undefined` | Optional | (Optional) | ## Example (as JSON) diff --git a/doc/models/subscription-date-field.md b/doc/models/subscription-date-field.md index 97e162a4..96ed6f37 100644 --- a/doc/models/subscription-date-field.md +++ b/doc/models/subscription-date-field.md @@ -9,13 +9,13 @@ | Name | | --- | -| `currentPeriodEndsAt` | -| `currentPeriodStartsAt` | -| `createdAt` | -| `activatedAt` | -| `canceledAt` | -| `expiresAt` | -| `trialStartedAt` | -| `trialEndedAt` | -| `updatedAt` | +| `CurrentPeriodEndsAt` | +| `CurrentPeriodStartsAt` | +| `CreatedAt` | +| `ActivatedAt` | +| `CanceledAt` | +| `ExpiresAt` | +| `TrialStartedAt` | +| `TrialEndedAt` | +| `UpdatedAt` | diff --git a/doc/models/subscription-group-bank-account.md b/doc/models/subscription-group-bank-account.md index 13145e62..180b130a 100644 --- a/doc/models/subscription-group-bank-account.md +++ b/doc/models/subscription-group-bank-account.md @@ -23,7 +23,7 @@ | `billingZip` | `string \| undefined` | Optional | - | | `billingCountry` | `string \| undefined` | Optional | - | | `chargifyToken` | `string \| undefined` | Optional | - | -| `currentVault` | [`BankAccountVault \| undefined`](../../doc/models/bank-account-vault.md) | Optional | The vault that stores the payment profile with the provided vault_token. | +| `currentVault` | [`BankAccountVault \| undefined`](../../doc/models/bank-account-vault.md) | Optional | The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. | | `gatewayHandle` | `string \| undefined` | Optional | - | ## Example (as JSON) diff --git a/doc/models/subscription-group-component-custom-price.md b/doc/models/subscription-group-component-custom-price.md index 72568ca5..ecf99cfa 100644 --- a/doc/models/subscription-group-component-custom-price.md +++ b/doc/models/subscription-group-component-custom-price.md @@ -29,6 +29,7 @@ Used in place of `price_point_id` to define a custom price point unique to the s ], "overage_pricing": [ { + "tax_included": false, "pricing_scheme": "stairstep", "interval": 230, "interval_unit": "day", diff --git a/doc/models/subscription-group-credit-card.md b/doc/models/subscription-group-credit-card.md index 4a942c05..6096d70a 100644 --- a/doc/models/subscription-group-credit-card.md +++ b/doc/models/subscription-group-credit-card.md @@ -14,7 +14,7 @@ | `expirationYear` | [`SubscriptionGroupCreditCardExpirationYear \| undefined`](../../doc/models/containers/subscription-group-credit-card-expiration-year.md) | Optional | This is a container for one-of cases. | | `chargifyToken` | `string \| undefined` | Optional | - | | `vaultToken` | `string \| undefined` | Optional | - | -| `currentVault` | [`CurrentVault \| undefined`](../../doc/models/current-vault.md) | Optional | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | +| `currentVault` | [`CreditCardVault \| undefined`](../../doc/models/credit-card-vault.md) | Optional | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | | `gatewayHandle` | `string \| undefined` | Optional | - | | `firstName` | `string \| undefined` | Optional | - | | `lastName` | `string \| undefined` | Optional | - | diff --git a/doc/models/subscription-group-include.md b/doc/models/subscription-group-include.md index c46b361f..a9b79d1a 100644 --- a/doc/models/subscription-group-include.md +++ b/doc/models/subscription-group-include.md @@ -9,5 +9,5 @@ | Name | | --- | -| `currentBillingAmountInCents` | +| `CurrentBillingAmountInCents` | diff --git a/doc/models/subscription-group-prepayment-method.md b/doc/models/subscription-group-prepayment-method.md index 5ee3a895..fb11c3df 100644 --- a/doc/models/subscription-group-prepayment-method.md +++ b/doc/models/subscription-group-prepayment-method.md @@ -9,10 +9,10 @@ | Name | | --- | -| `check` | -| `cash` | -| `moneyOrder` | -| `ach` | -| `paypalAccount` | -| `other` | +| `Check` | +| `Cash` | +| `MoneyOrder` | +| `Ach` | +| `PaypalAccount` | +| `Other` | diff --git a/doc/models/subscription-group-signup-component.md b/doc/models/subscription-group-signup-component.md index 50226a79..bc9f4a79 100644 --- a/doc/models/subscription-group-signup-component.md +++ b/doc/models/subscription-group-signup-component.md @@ -39,6 +39,7 @@ ], "overage_pricing": [ { + "tax_included": false, "pricing_scheme": "stairstep", "interval": 230, "interval_unit": "day", @@ -51,6 +52,7 @@ ] }, { + "tax_included": false, "pricing_scheme": "stairstep", "interval": 230, "interval_unit": "day", @@ -63,6 +65,7 @@ ] }, { + "tax_included": false, "pricing_scheme": "stairstep", "interval": 230, "interval_unit": "day", diff --git a/doc/models/subscription-group-signup-response.md b/doc/models/subscription-group-signup-response.md index 7bcb8c4c..1aede4ed 100644 --- a/doc/models/subscription-group-signup-response.md +++ b/doc/models/subscription-group-signup-response.md @@ -16,7 +16,7 @@ | `subscriptionIds` | `number[] \| undefined` | Optional | - | | `primarySubscriptionId` | `number \| undefined` | Optional | - | | `nextAssessmentAt` | `string \| undefined` | Optional | - | -| `state` | [`SubscriptionState \| undefined`](../../doc/models/subscription-state.md) | Optional | The state of a subscription.

* **Live States**
* `active` - A normal, active subscription. It is not in a trial and is paid and up to date.
* `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
* `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.
* **Problem States**
* `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
* `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.
* `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) settings to have a Final Action of `mark the subscription unpaid`.
* **End of Life States**
* `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) process without payment. See the [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404559291021) documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.
* `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.
* `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)
* `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.
* `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.
* `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221) for more details.

See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773) for more info about subscription states and state transitions. | +| `state` | [`SubscriptionState \| undefined`](../../doc/models/subscription-state.md) | Optional | The state of a subscription.

* **Live States**
* `active` - A normal, active subscription. It is not in a trial and is paid and up to date.
* `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
* `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.
* **Problem States**
* `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
* `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.
* `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) settings to have a Final Action of `mark the subscription unpaid`.
* **End of Life States**
* `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.
* `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.
* `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)
* `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.
* `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.
* `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing) for more details.

See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscription-States) for more info about subscription states and state transitions. | | `cancelAtEndOfPeriod` | `boolean \| undefined` | Optional | - | | `subscriptions` | [`SubscriptionGroupItem[] \| undefined`](../../doc/models/subscription-group-item.md) | Optional | - | | `paymentCollectionMethod` | [`CollectionMethod \| undefined`](../../doc/models/collection-method.md) | Optional | The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For current Relationship Invoicing Architecture valid options are - `remittance`, `automatic`, `prepaid`. | diff --git a/doc/models/subscription-groups-list-include.md b/doc/models/subscription-groups-list-include.md index e68218d3..fc6245e9 100644 --- a/doc/models/subscription-groups-list-include.md +++ b/doc/models/subscription-groups-list-include.md @@ -9,5 +9,5 @@ | Name | | --- | -| `accountBalances` | +| `AccountBalances` | diff --git a/doc/models/subscription-include.md b/doc/models/subscription-include.md index e12d7095..a5f953d1 100644 --- a/doc/models/subscription-include.md +++ b/doc/models/subscription-include.md @@ -9,6 +9,6 @@ | Name | | --- | -| `coupons` | -| `selfServicePageToken` | +| `Coupons` | +| `SelfServicePageToken` | diff --git a/doc/models/subscription-list-date-field.md b/doc/models/subscription-list-date-field.md index 66fa33e0..da66051e 100644 --- a/doc/models/subscription-list-date-field.md +++ b/doc/models/subscription-list-date-field.md @@ -9,7 +9,7 @@ | Name | | --- | -| `updatedAt` | +| `UpdatedAt` | ## Example diff --git a/doc/models/subscription-list-include.md b/doc/models/subscription-list-include.md index f322aab1..27359075 100644 --- a/doc/models/subscription-list-include.md +++ b/doc/models/subscription-list-include.md @@ -9,5 +9,5 @@ | Name | | --- | -| `selfServicePageToken` | +| `SelfServicePageToken` | diff --git a/doc/models/subscription-purge-type.md b/doc/models/subscription-purge-type.md index 19a8ee9b..e8d5857e 100644 --- a/doc/models/subscription-purge-type.md +++ b/doc/models/subscription-purge-type.md @@ -9,6 +9,6 @@ | Name | | --- | -| `customer` | -| `paymentProfile` | +| `Customer` | +| `PaymentProfile` | diff --git a/doc/models/subscription-sort.md b/doc/models/subscription-sort.md index 93adf4e5..cfae8370 100644 --- a/doc/models/subscription-sort.md +++ b/doc/models/subscription-sort.md @@ -9,10 +9,10 @@ | Name | | --- | -| `signupDate` | -| `periodStart` | -| `periodEnd` | -| `nextAssessment` | -| `updatedAt` | -| `createdAt` | +| `SignupDate` | +| `PeriodStart` | +| `PeriodEnd` | +| `NextAssessment` | +| `UpdatedAt` | +| `CreatedAt` | diff --git a/doc/models/subscription-state-filter.md b/doc/models/subscription-state-filter.md index 2fcfac7b..aaf21877 100644 --- a/doc/models/subscription-state-filter.md +++ b/doc/models/subscription-state-filter.md @@ -11,16 +11,16 @@ Allowed values for filtering by the current state of the subscription. | Name | | --- | -| `active` | -| `canceled` | -| `expired` | -| `expiredCards` | -| `onHold` | -| `pastDue` | -| `pendingCancellation` | -| `pendingRenewal` | -| `suspended` | -| `trialEnded` | -| `trialing` | -| `unpaid` | +| `Active` | +| `Canceled` | +| `Expired` | +| `ExpiredCards` | +| `OnHold` | +| `PastDue` | +| `PendingCancellation` | +| `PendingRenewal` | +| `Suspended` | +| `TrialEnded` | +| `Trialing` | +| `Unpaid` | diff --git a/doc/models/subscription-state.md b/doc/models/subscription-state.md index ebdfc4c1..3b99ac5e 100644 --- a/doc/models/subscription-state.md +++ b/doc/models/subscription-state.md @@ -12,17 +12,17 @@ The state of a subscription. * **Problem States** * `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers. * `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed. - * `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) settings to have a Final Action of `mark the subscription unpaid`. + * `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) settings to have a Final Action of `mark the subscription unpaid`. * **End of Life States** - * `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) process without payment. See the [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404559291021) documentation for info on how to restart a canceled subscription. + * `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) documentation for info on how to restart a canceled subscription. While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance. * `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period. * `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.) * `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time. * `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state. - * `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221) for more details. + * `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing) for more details. -See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773) for more info about subscription states and state transitions. +See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscription-States) for more info about subscription states and state transitions. ## Enumeration @@ -32,19 +32,19 @@ See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5 | Name | | --- | -| `pending` | -| `failedToCreate` | -| `trialing` | -| `assessing` | -| `active` | -| `softFailure` | -| `pastDue` | -| `suspended` | -| `canceled` | -| `expired` | -| `paused` | -| `unpaid` | -| `trialEnded` | -| `onHold` | -| `awaitingSignup` | +| `Pending` | +| `FailedToCreate` | +| `Trialing` | +| `Assessing` | +| `Active` | +| `SoftFailure` | +| `PastDue` | +| `Suspended` | +| `Canceled` | +| `Expired` | +| `Paused` | +| `Unpaid` | +| `TrialEnded` | +| `OnHold` | +| `AwaitingSignup` | diff --git a/doc/models/subscription.md b/doc/models/subscription.md index 96b17f43..dbe8bc18 100644 --- a/doc/models/subscription.md +++ b/doc/models/subscription.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `id` | `number \| undefined` | Optional | The subscription unique id within Chargify. | -| `state` | [`SubscriptionState \| undefined`](../../doc/models/subscription-state.md) | Optional | The state of a subscription.

* **Live States**
* `active` - A normal, active subscription. It is not in a trial and is paid and up to date.
* `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
* `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.
* **Problem States**
* `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
* `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.
* `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) settings to have a Final Action of `mark the subscription unpaid`.
* **End of Life States**
* `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) process without payment. See the [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404559291021) documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.
* `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.
* `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)
* `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.
* `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.
* `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221) for more details.

See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773) for more info about subscription states and state transitions. | +| `state` | [`SubscriptionState \| undefined`](../../doc/models/subscription-state.md) | Optional | The state of a subscription.

* **Live States**
* `active` - A normal, active subscription. It is not in a trial and is paid and up to date.
* `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.
* `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
* `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.
* **Problem States**
* `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
* `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.
* `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) settings to have a Final Action of `mark the subscription unpaid`.
* **End of Life States**
* `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.
* `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.
* `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)
* `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.
* `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.
* `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing) for more details.

See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscription-States) for more info about subscription states and state transitions. | | `balanceInCents` | `bigint \| undefined` | Optional | Gives the current outstanding subscription balance in the number of cents. | | `totalRevenueInCents` | `bigint \| undefined` | Optional | Gives the total revenue from the subscription in the number of cents. | | `productPriceInCents` | `bigint \| undefined` | Optional | (Added Nov 5 2013) The recurring amount of the product (and version),currently subscribed. NOTE: this may differ from the current price of,the product, if you’ve changed the price of the product but haven’t,moved this subscription to a newer version. | diff --git a/doc/models/tax-configuration-kind.md b/doc/models/tax-configuration-kind.md index a78bd27d..291cea72 100644 --- a/doc/models/tax-configuration-kind.md +++ b/doc/models/tax-configuration-kind.md @@ -9,8 +9,8 @@ | Name | | --- | -| `custom` | -| `enumManagedAvalara` | -| `enumLinkedAvalara` | -| `enumDigitalRiver` | +| `Custom` | +| `EnumManagedAvalara` | +| `EnumLinkedAvalara` | +| `EnumDigitalRiver` | diff --git a/doc/models/tax-configuration.md b/doc/models/tax-configuration.md index 00482e87..9e774834 100644 --- a/doc/models/tax-configuration.md +++ b/doc/models/tax-configuration.md @@ -11,7 +11,7 @@ | --- | --- | --- | --- | | `kind` | [`TaxConfigurationKind \| undefined`](../../doc/models/tax-configuration-kind.md) | Optional | **Default**: `TaxConfigurationKind.Custom` | | `destinationAddress` | [`TaxDestinationAddress \| undefined`](../../doc/models/tax-destination-address.md) | Optional | - | -| `fullyConfigured` | `boolean \| undefined` | Optional | Returns `true` when Chargify has been properly configured to charge tax using the specified tax system. More details about taxes: https://maxio-chargify.zendesk.com/hc/en-us/articles/5405488905869-Taxes-Introduction
**Default**: `false` | +| `fullyConfigured` | `boolean \| undefined` | Optional | Returns `true` when Chargify has been properly configured to charge tax using the specified tax system. More details about taxes: https://maxio.zendesk.com/hc/en-us/articles/24287012608909-Taxes-Overview
**Default**: `false` | ## Example (as JSON) diff --git a/doc/models/tax-destination-address.md b/doc/models/tax-destination-address.md index c784dbac..891b350f 100644 --- a/doc/models/tax-destination-address.md +++ b/doc/models/tax-destination-address.md @@ -9,8 +9,8 @@ | Name | | --- | -| `shippingThenBilling` | -| `billingThenShipping` | -| `shippingOnly` | -| `billingOnly` | +| `ShippingThenBilling` | +| `BillingThenShipping` | +| `ShippingOnly` | +| `BillingOnly` | diff --git a/doc/models/update-component-price-point.md b/doc/models/update-component-price-point.md index 165c9cdf..df25a69a 100644 --- a/doc/models/update-component-price-point.md +++ b/doc/models/update-component-price-point.md @@ -15,7 +15,7 @@ | `useSiteExchangeRate` | `boolean \| undefined` | Optional | Whether to use the site level exchange rate or define your own prices for each currency if you have multiple currencies defined on the site. | | `taxIncluded` | `boolean \| undefined` | Optional | Whether or not the price point includes tax | | `interval` | `number \| undefined` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | -| `intervalUnit` | [`IntervalUnit \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | +| `intervalUnit` | [`IntervalUnit \| null \| undefined`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. | | `prices` | [`UpdatePrice[] \| undefined`](../../doc/models/update-price.md) | Optional | - | ## Example (as JSON) diff --git a/doc/models/update-customer.md b/doc/models/update-customer.md index 121dd1f8..804cfbbc 100644 --- a/doc/models/update-customer.md +++ b/doc/models/update-customer.md @@ -28,6 +28,7 @@ | `taxExemptReason` | `string \| undefined` | Optional | - | | `parentId` | `number \| null \| undefined` | Optional | - | | `verified` | `boolean \| null \| undefined` | Optional | Is the customer verified to use ACH as a payment method. Available only on Authorize.Net gateway | +| `salesforceId` | `string \| null \| undefined` | Optional | The Salesforce ID of the customer | ## Example (as JSON) diff --git a/doc/models/update-payment-profile.md b/doc/models/update-payment-profile.md index ce5fe856..bc39aeb2 100644 --- a/doc/models/update-payment-profile.md +++ b/doc/models/update-payment-profile.md @@ -15,7 +15,7 @@ | `cardType` | [`CardType \| undefined`](../../doc/models/card-type.md) | Optional | The type of card used. | | `expirationMonth` | `string \| undefined` | Optional | (Optional when performing an Import via vault_token, required otherwise) The 1- or 2-digit credit card expiration month, as an integer or string, i.e. 5 | | `expirationYear` | `string \| undefined` | Optional | (Optional when performing a Import via vault_token, required otherwise) The 4-digit credit card expiration year, as an integer or string, i.e. 2012 | -| `currentVault` | [`CurrentVault \| undefined`](../../doc/models/current-vault.md) | Optional | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | +| `currentVault` | [`AllVaults \| undefined`](../../doc/models/all-vaults.md) | Optional | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | | `billingAddress` | `string \| undefined` | Optional | The credit card or bank account billing street address (i.e. 123 Main St.). This value is merely passed through to the payment gateway. | | `billingCity` | `string \| undefined` | Optional | The credit card or bank account billing address city (i.e. “Boston”). This value is merely passed through to the payment gateway. | | `billingState` | `string \| undefined` | Optional | The credit card or bank account billing address state (i.e. MA). This value is merely passed through to the payment gateway. This must conform to the [ISO_3166-1](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) in order to be valid for tax locale purposes. | diff --git a/doc/models/update-subscription-component.md b/doc/models/update-subscription-component.md index 51ca45d6..5344d00f 100644 --- a/doc/models/update-subscription-component.md +++ b/doc/models/update-subscription-component.md @@ -18,6 +18,7 @@ { "component_id": 244, "custom_price": { + "tax_included": false, "pricing_scheme": "stairstep", "interval": 66, "interval_unit": "day", diff --git a/doc/models/void-invoice-event.md b/doc/models/void-invoice-event.md index b80287a7..0761dc41 100644 --- a/doc/models/void-invoice-event.md +++ b/doc/models/void-invoice-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/void-remainder-event.md b/doc/models/void-remainder-event.md index 3be37903..8389501c 100644 --- a/doc/models/void-remainder-event.md +++ b/doc/models/void-remainder-event.md @@ -25,6 +25,7 @@ "issue_date": "2024-01-01", "due_date": "2024-01-01", "paid_date": "2024-01-01", + "public_url_expires_on": "2024-01-21", "id": 166, "uid": "uid6", "site_id": 92, diff --git a/doc/models/webhook-order.md b/doc/models/webhook-order.md index a0073612..18ecc708 100644 --- a/doc/models/webhook-order.md +++ b/doc/models/webhook-order.md @@ -9,6 +9,6 @@ | Name | | --- | -| `newestFirst` | -| `oldestFirst` | +| `NewestFirst` | +| `OldestFirst` | diff --git a/doc/models/webhook-status.md b/doc/models/webhook-status.md index 8256ad6c..70a637ba 100644 --- a/doc/models/webhook-status.md +++ b/doc/models/webhook-status.md @@ -9,8 +9,8 @@ | Name | | --- | -| `successful` | -| `failed` | -| `pending` | -| `paused` | +| `Successful` | +| `Failed` | +| `Pending` | +| `Paused` | diff --git a/doc/models/webhook-subscription.md b/doc/models/webhook-subscription.md index c3cf28c8..3847d799 100644 --- a/doc/models/webhook-subscription.md +++ b/doc/models/webhook-subscription.md @@ -9,39 +9,39 @@ | Name | | --- | -| `billingDateChange` | -| `componentAllocationChange` | -| `customerCreate` | -| `customerUpdate` | -| `dunningStepReached` | -| `expiringCard` | -| `expirationDateChange` | -| `invoiceIssued` | -| `meteredUsage` | -| `paymentFailure` | -| `paymentSuccess` | -| `directDebitPaymentPending` | -| `directDebitPaymentPaidOut` | -| `directDebitPaymentRejected` | -| `prepaidSubscriptionBalanceChanged` | -| `prepaidUsage` | -| `refundFailure` | -| `refundSuccess` | -| `renewalFailure` | -| `renewalSuccess` | -| `signupFailure` | -| `signupSuccess` | -| `statementClosed` | -| `statementSettled` | -| `subscriptionCardUpdate` | -| `subscriptionGroupCardUpdate` | -| `subscriptionProductChange` | -| `subscriptionStateChange` | -| `trialEndNotice` | -| `upcomingRenewalNotice` | -| `upgradeDowngradeFailure` | -| `upgradeDowngradeSuccess` | -| `pendingCancellationChange` | -| `subscriptionPrepaymentAccountBalanceChanged` | -| `subscriptionServiceCreditAccountBalanceChanged` | +| `BillingDateChange` | +| `ComponentAllocationChange` | +| `CustomerCreate` | +| `CustomerUpdate` | +| `DunningStepReached` | +| `ExpiringCard` | +| `ExpirationDateChange` | +| `InvoiceIssued` | +| `MeteredUsage` | +| `PaymentFailure` | +| `PaymentSuccess` | +| `DirectDebitPaymentPending` | +| `DirectDebitPaymentPaidOut` | +| `DirectDebitPaymentRejected` | +| `PrepaidSubscriptionBalanceChanged` | +| `PrepaidUsage` | +| `RefundFailure` | +| `RefundSuccess` | +| `RenewalFailure` | +| `RenewalSuccess` | +| `SignupFailure` | +| `SignupSuccess` | +| `StatementClosed` | +| `StatementSettled` | +| `SubscriptionCardUpdate` | +| `SubscriptionGroupCardUpdate` | +| `SubscriptionProductChange` | +| `SubscriptionStateChange` | +| `TrialEndNotice` | +| `UpcomingRenewalNotice` | +| `UpgradeDowngradeFailure` | +| `UpgradeDowngradeSuccess` | +| `PendingCancellationChange` | +| `SubscriptionPrepaymentAccountBalanceChanged` | +| `SubscriptionServiceCreditAccountBalanceChanged` | diff --git a/e2e/src/componentsController.spec.ts b/e2e/src/componentsController.spec.ts index 1eb2eaae..2d770acd 100644 --- a/e2e/src/componentsController.spec.ts +++ b/e2e/src/componentsController.spec.ts @@ -49,7 +49,7 @@ describe('Components Controller', () => { ); const createComponentReponse = - await componentsController.createMeteredComponent(productFamilyId, { + await componentsController.createMeteredComponent(productFamilyId.toString(), { ...componentPayload, }); diff --git a/e2e/src/couponsController.spec.ts b/e2e/src/couponsController.spec.ts index 8f73941c..dc5e3367 100644 --- a/e2e/src/couponsController.spec.ts +++ b/e2e/src/couponsController.spec.ts @@ -706,7 +706,7 @@ describe('Coupons Controller', () => { await couponsController.listCouponSubcodes({ couponId }); expect(listCouponSubcodesResponse.statusCode).toBe(200); - expect(listCouponSubcodesResponse.result.codes).toEqual(subcodes); + expect(listCouponSubcodesResponse.result.codes?.sort()).toEqual(subcodes.sort()); }); test('should return error when couponId is not in the sytstem.', async () => { diff --git a/e2e/src/utils/components.ts b/e2e/src/utils/components.ts index 7a13a2d6..a8703a6f 100644 --- a/e2e/src/utils/components.ts +++ b/e2e/src/utils/components.ts @@ -21,7 +21,7 @@ export async function createComponent({ unitPrice: 1, }; const response = await componentsController.createMeteredComponent( - productFamilyId, + productFamilyId.toString(), { meteredComponent, } diff --git a/jest.config.js b/jest.config.js index 45a2c189..091b875d 100644 --- a/jest.config.js +++ b/jest.config.js @@ -1,9 +1,7 @@ module.exports = { testEnvironment: 'node', preset: 'ts-jest', - globals: { - 'ts-jest': { - tsConfig: 'tsconfig.base.json', - }, + transform: { + '^.+\\.tsx?$': ['ts-jest', { tsconfig: 'tsconfig.base.json' }], }, }; diff --git a/package.json b/package.json index 0edf394c..a58f8db5 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "4.0.0", + "version": "5.0.0", "license": "MIT", "sideEffects": false, "main": "dist/cjs/index.js", @@ -14,9 +14,9 @@ }, "scripts": { "build": "rm -rf dist & tsc -p tsconfig.esm.json & tsc -p tsconfig.cjs.json", - "test": "jest --coverage --passWithNoTests", - "lint": "eslint --ignore-path .eslintignore --ext .js,.ts .", - "prepare": "rm -rf dist & tsc -p tsconfig.esm.json & tsc -p tsconfig.cjs.json" + "prepare": "rm -rf dist & tsc -p tsconfig.esm.json & tsc -p tsconfig.cjs.json", + "lint": "eslint **/*.ts --ignore-path .eslintignore", + "lint:fix": "eslint **/*.ts --ignore-path .eslintignore --fix" }, "peerDependencies": {}, "prettier": { @@ -43,10 +43,10 @@ "typescript": "^4.9.5" }, "dependencies": { - "@apimatic/authentication-adapters": "^0.5.0", - "@apimatic/axios-client-adapter": "^0.3.0", - "@apimatic/core": "^0.10.0", - "@apimatic/schema": "^0.7.0" + "@apimatic/authentication-adapters": "^0.5.4", + "@apimatic/axios-client-adapter": "^0.3.4", + "@apimatic/core": "^0.10.12", + "@apimatic/schema": "^0.7.12" }, "repository": { "type": "git", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 0db02871..d662c874 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -9,17 +9,17 @@ importers: .: dependencies: '@apimatic/authentication-adapters': - specifier: ^0.5.0 - version: 0.5.3 + specifier: ^0.5.4 + version: 0.5.4 '@apimatic/axios-client-adapter': - specifier: ^0.3.0 - version: 0.3.3 + specifier: ^0.3.4 + version: 0.3.4 '@apimatic/core': - specifier: ^0.10.0 - version: 0.10.10 + specifier: ^0.10.12 + version: 0.10.12 '@apimatic/schema': - specifier: ^0.7.0 - version: 0.7.11 + specifier: ^0.7.12 + version: 0.7.12 devDependencies: '@types/jest': specifier: ^29.4.0 @@ -102,27 +102,27 @@ packages: '@jridgewell/trace-mapping': 0.3.25 dev: true - /@apimatic/authentication-adapters@0.5.3: - resolution: {integrity: sha512-Ld2cHQuwdAMzE0jNzOsUin9kU6QFyXMZcPw4ZoCPi29Vp4I1qWtSbs602p1P4cSv8Yxf47JinaiT6OSMgCrO5g==} + /@apimatic/authentication-adapters@0.5.4: + resolution: {integrity: sha512-UP4+LfvLQJjgtKaGr+hgQogM3JJGb9llEX8v9OVUp0xmiIVI8zt0m69nz/vk4GaNe4U6AvS3D4x0YiE5JtLVkg==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: - '@apimatic/core-interfaces': 0.2.5 + '@apimatic/core-interfaces': 0.2.6 '@apimatic/http-headers': 0.3.2 '@apimatic/http-query': 0.3.2 tslib: 2.6.3 dev: false - /@apimatic/axios-client-adapter@0.3.3: - resolution: {integrity: sha512-sQmT2Kbs8Lq4Bz/TLOBjH+CNd1QfjTDMbmwyxFpRSzusta6cAl7EcaR2JcCiOeuu2J1fr61tTRUFMwqlDliJqg==} + /@apimatic/axios-client-adapter@0.3.4: + resolution: {integrity: sha512-vRluB6E7AHnGRZp/ntPcvdj01RrxUj2ylzDR6ejsT/xbXf0SOw2awSDOEq1ZsglzakNvzbuGaWIBY+e2yq8e/Q==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: '@apimatic/convert-to-stream': 0.1.2 - '@apimatic/core-interfaces': 0.2.5 + '@apimatic/core-interfaces': 0.2.6 '@apimatic/file-wrapper': 0.3.2 '@apimatic/http-headers': 0.3.2 '@apimatic/http-query': 0.3.2 '@apimatic/json-bigint': 1.2.0 - '@apimatic/schema': 0.7.11 + '@apimatic/schema': 0.7.12 axios: 1.7.2 detect-browser: 5.3.0 detect-node: 2.1.0 @@ -144,25 +144,25 @@ packages: engines: {node: '>=14.15.0 || >=16.0.0'} dev: false - /@apimatic/core-interfaces@0.2.5: - resolution: {integrity: sha512-73NLoa1OG5RHP+9f76/bhOAYmkhay0lGDlsffmwU2W1zQ16JB5U6y5lpjnHCWku7VN5MfXYK2UXaPJWO8+xG5g==} + /@apimatic/core-interfaces@0.2.6: + resolution: {integrity: sha512-XbqyftDB4GO3rVOablFt7RnF03gLdctUgLT0flDP5JI3E4r+Cn2O66nFufWfSFhI/Vr0vJbVjjDG2xzZ2bHBjQ==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: '@apimatic/file-wrapper': 0.3.2 tslib: 2.6.3 dev: false - /@apimatic/core@0.10.10: - resolution: {integrity: sha512-z6BGkUDasJtO1eQJPyl0Bv1rnF+8kXtxYO38voWKh2eBbU73kGLffTSbL4cqf1HTB9HSan1XyRxFowLpUYSGiA==} + /@apimatic/core@0.10.12: + resolution: {integrity: sha512-PcOkX5SykmhORfHVQsWvGE8rFgCYA7gRoTaTX5kYXDHQLXOZoo/lIoo5Hc4FLqQkgMma9/bsqvvG8ls1d/suhA==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: '@apimatic/convert-to-stream': 0.0.2 - '@apimatic/core-interfaces': 0.2.5 + '@apimatic/core-interfaces': 0.2.6 '@apimatic/file-wrapper': 0.3.2 '@apimatic/http-headers': 0.3.2 '@apimatic/http-query': 0.3.2 '@apimatic/json-bigint': 1.2.0 - '@apimatic/schema': 0.7.11 + '@apimatic/schema': 0.7.12 detect-browser: 5.3.0 detect-node: 2.1.0 form-data: 3.0.1 @@ -199,8 +199,8 @@ packages: resolution: {integrity: sha512-+bmVzYMdZu0Ya5L+my4FXFUih54OvQA/qlZsFOYdOoostyUuB27UDrVWQs/WVCmS0ADdo5vTU0eeTrrBkHoySw==} dev: false - /@apimatic/schema@0.7.11: - resolution: {integrity: sha512-lsCngEepI7We27bVcRNU1rWvq2300iVeZ2go5WCLbnGlIy6xmmx4Nw4TACWMe9ZRFyvlIMMFvBSxzV61orYwjA==} + /@apimatic/schema@0.7.12: + resolution: {integrity: sha512-JiIabKJuEKAF5QGFPwx2kG9vfTbQW7OLKxhRXbcIv8VvaH1DX/AdAfsDq3/+qCTmu6LpeNJmLWs8fwh8YRcsaQ==} engines: {node: '>=14.15.0 || >=16.0.0'} dependencies: tslib: 2.6.3 diff --git a/src/authProvider.ts b/src/authProvider.ts index 831311fe..4f07be32 100644 --- a/src/authProvider.ts +++ b/src/authProvider.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/authentication.ts b/src/authentication.ts index ba6264da..abd40235 100644 --- a/src/authentication.ts +++ b/src/authentication.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/client.ts b/src/client.ts index 3f7e8cbc..07327989 100644 --- a/src/client.ts +++ b/src/client.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -51,7 +51,7 @@ export class Client implements ClientInterface { ? this._config.httpClientOptions.timeout : this._config.timeout; this._userAgent = updateUserAgent( - 'AB SDK TypeScript:4.0.0 on OS {os-info}' + 'AB SDK TypeScript:5.0.0 on OS {os-info}' ); this._requestBuilderFactory = createRequestHandlerFactory( (server) => getBaseUri(server, this._config), @@ -92,9 +92,9 @@ function createHttpClientAdapter(client: HttpClient): HttpClientInterface { function getBaseUri(server: Server = 'default', config: Configuration): string { if (config.environment === Environment.Production) { if (server === 'default') { - return pathTemplate`https://${new SkipEncode(config.subdomain)}.${ - new SkipEncode(config.domain) - }`; + return pathTemplate`https://${new SkipEncode( + config.subdomain + )}.${new SkipEncode(config.domain)}`; } } if (config.environment === Environment.Environment2) { diff --git a/src/clientAdapter.ts b/src/clientAdapter.ts index 22734e64..3d0b0112 100644 --- a/src/clientAdapter.ts +++ b/src/clientAdapter.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/clientInterface.ts b/src/clientInterface.ts index 0bc6b094..736db3d3 100644 --- a/src/clientInterface.ts +++ b/src/clientInterface.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/configuration.ts b/src/configuration.ts index 6d3f8169..21fa2011 100644 --- a/src/configuration.ts +++ b/src/configuration.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/controllers/aPIExportsController.ts b/src/controllers/aPIExportsController.ts index e888dab8..17a95964 100644 --- a/src/controllers/aPIExportsController.ts +++ b/src/controllers/aPIExportsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/controllers/advanceInvoiceController.ts b/src/controllers/advanceInvoiceController.ts index 63ceaac9..048c5aed 100644 --- a/src/controllers/advanceInvoiceController.ts +++ b/src/controllers/advanceInvoiceController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -22,10 +22,9 @@ import { ErrorListResponseError } from '../errors/errorListResponseError'; export class AdvanceInvoiceController extends BaseController { /** * Generate an invoice in advance for a subscription's next renewal date. [Please see our docs](https: - * //maxio-chargify.zendesk.com/hc/en-us/articles/5404811062541-Issue-Invoice-In-Advance) for more - * information on advance invoices, including eligibility on generating one; for the most part, they - * function like any other invoice, except they are issued early and have special behavior upon being - * voided. + * //maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invoice-In-Advance) for more information + * on advance invoices, including eligibility on generating one; for the most part, they function like + * any other invoice, except they are issued early and have special behavior upon being voided. * A subscription may only have one advance invoice per billing period. Attempting to issue an advance * invoice when one already exists will return an error. * That said, regeneration of the invoice may be forced with the params `force: true`, which will void diff --git a/src/controllers/baseController.ts b/src/controllers/baseController.ts index ab6bdd31..05f4ff17 100644 --- a/src/controllers/baseController.ts +++ b/src/controllers/baseController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/controllers/billingPortalController.ts b/src/controllers/billingPortalController.ts index 2cd8cc77..87b5aca1 100644 --- a/src/controllers/billingPortalController.ts +++ b/src/controllers/billingPortalController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -32,8 +32,8 @@ export class BillingPortalController extends BaseController { /** * ## Billing Portal Documentation * - * Full documentation on how the Billing Portal operates within the Chargify UI can be located - * [here](https://chargify.zendesk.com/hc/en-us/articles/4407648972443). + * Full documentation on how the Billing Portal operates within the Advanced Billing UI can be located + * [here](https://maxio.zendesk.com/hc/en-us/articles/24252412965133-Billing-Portal-Overview). * * This documentation is focused on how the to configure the Billing Portal Settings, as well as * Subscriber Interaction and Merchant Management of the Billing Portal. @@ -49,12 +49,12 @@ export class BillingPortalController extends BaseController { * * If you need to provide your customer their Management URL through other means, you can retrieve it * via the API. Because the URL is cryptographically signed with a timestamp, it is not possible for - * merchants to generate the URL without requesting it from Chargify. + * merchants to generate the URL without requesting it from Advanced Billing. * * In order to prevent abuse & overuse, we ask that you request a new URL only when absolutely * necessary. Management URLs are good for 65 days, so you should re-use a previously generated one as * much as possible. If you use the URL frequently (such as to display on your website), please **do - * not** make an API request to Chargify every time. + * not** make an API request to Advanced Billing every time. * * @param customerId The Chargify id of the customer * @param autoInvite When set to 1, an Invitation email will be sent to the Customer. When set to 0, diff --git a/src/controllers/componentPricePointsController.ts b/src/controllers/componentPricePointsController.ts index b4d08c0d..3f6a6ec1 100644 --- a/src/controllers/componentPricePointsController.ts +++ b/src/controllers/componentPricePointsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -92,13 +92,14 @@ export class ComponentPricePointsController extends BaseController { * Sets a new default price point for the component. This new default will apply to all new * subscriptions going forward - existing subscriptions will remain on their current price point. * - * See [Price Points Documentation](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#price- - * points) for more information on price points and moving subscriptions between price points. + * See [Price Points Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261191737101-Price- + * Points-Components) for more information on price points and moving subscriptions between price + * points. * * Note: Custom price points are not able to be set as the default for a component. * - * @param componentId The Chargify id of the component to which the price point belongs - * @param pricePointId The Chargify id of the price point + * @param componentId The Advanced Billing id of the component to which the price point belongs + * @param pricePointId The Advanced Billing id of the price point * @return Response from the API call */ async promoteComponentPricePointToDefault( @@ -119,7 +120,7 @@ export class ComponentPricePointsController extends BaseController { /** * This endpoint can be used to create a new price point for an existing component. * - * @param componentId The Chargify id of the component + * @param componentId The Advanced Billing id of the component * @param body * @return Response from the API call */ @@ -153,7 +154,7 @@ export class ComponentPricePointsController extends BaseController { * current exchange rate. If the flag is set to false, it will return all of the defined prices for * each currency. * - * @param componentId The Chargify id of the component + * @param componentId The Advanced Billing id of the component * @param currencyPrices Include an array of currency price data * @param page Result records are organized in pages. By default, the first page of * results is displayed. The page parameter specifies a page number of @@ -204,8 +205,8 @@ export class ComponentPricePointsController extends BaseController { /** * Use this endpoint to create multiple component price points in one request. * - * @param componentId The Chargify id of the component for which you - * want to fetch price points. + * @param componentId The Advanced Billing id of the component for + * which you want to fetch price points. * @param body * @return Response from the API call */ @@ -343,8 +344,8 @@ export class ComponentPricePointsController extends BaseController { /** * Use this endpoint to unarchive a component price point. * - * @param componentId The Chargify id of the component to which the price point belongs - * @param pricePointId The Chargify id of the price point + * @param componentId The Advanced Billing id of the component to which the price point belongs + * @param pricePointId The Advanced Billing id of the price point * @return Response from the API call */ async unarchiveComponentPricePoint( @@ -372,7 +373,7 @@ export class ComponentPricePointsController extends BaseController { * * Note: Currency Prices are not able to be created for custom price points. * - * @param pricePointId The Chargify id of the price point + * @param pricePointId The Advanced Billing id of the price point * @param body * @return Response from the API call */ @@ -407,7 +408,7 @@ export class ComponentPricePointsController extends BaseController { * * Note: Currency Prices are not able to be updated for custom price points. * - * @param pricePointId The Chargify id of the price point + * @param pricePointId The Advanced Billing id of the price point * @param body * @return Response from the API call */ diff --git a/src/controllers/componentsController.ts b/src/controllers/componentsController.ts index 78c559ff..33fb1564 100644 --- a/src/controllers/componentsController.ts +++ b/src/controllers/componentsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -57,22 +57,22 @@ export class ComponentsController extends BaseController { * the start of every billing period. If you want to bill for a quantity of something that does not * change unless you change it, then you want quantity components, instead. * - * For more information on components, please see our documentation [here](https://maxio-chargify. - * zendesk.com/hc/en-us/articles/5405020625677). + * For more information on components, please see our documentation [here](https://maxio.zendesk. + * com/hc/en-us/articles/24261141522189-Components-Overview). * - * @param productFamilyId The Chargify id of the product family to which the - * component belongs + * @param productFamilyId Either the product family's id or its handle prefixed + * with `handle:` * @param body * @return Response from the API call */ async createMeteredComponent( - productFamilyId: number, + productFamilyId: string, body?: CreateMeteredComponent, requestOptions?: RequestOptions ): Promise> { const req = this.createRequest('POST'); const mapped = req.prepareArgs({ - productFamilyId: [productFamilyId, number()], + productFamilyId: [productFamilyId, string()], body: [body, optional(createMeteredComponentSchema)], }); req.header('Content-Type', 'application/json'); @@ -108,22 +108,22 @@ export class ComponentsController extends BaseController { * The allocated quantity for one-time quantity-based components immediately gets reset back to zero * after the allocation is made. * - * For more information on components, please see our documentation [here](https://maxio-chargify. - * zendesk.com/hc/en-us/articles/5405020625677). + * For more information on components, please see our documentation [here](https://maxio.zendesk. + * com/hc/en-us/articles/24261141522189-Components-Overview). * - * @param productFamilyId The Chargify id of the product family to which - * the component belongs + * @param productFamilyId Either the product family's id or its handle + * prefixed with `handle:` * @param body * @return Response from the API call */ async createQuantityBasedComponent( - productFamilyId: number, + productFamilyId: string, body?: CreateQuantityBasedComponent, requestOptions?: RequestOptions ): Promise> { const req = this.createRequest('POST'); const mapped = req.prepareArgs({ - productFamilyId: [productFamilyId, number()], + productFamilyId: [productFamilyId, string()], body: [body, optional(createQuantityBasedComponentSchema)], }); req.header('Content-Type', 'application/json'); @@ -147,22 +147,22 @@ export class ComponentsController extends BaseController { * On/off components are used for any flat fee, recurring add on (think $99/month for tech support or a * flat add on shipping fee). * - * For more information on components, please see our documentation [here](https://maxio-chargify. - * zendesk.com/hc/en-us/articles/5405020625677). + * For more information on components, please see our documentation [here](https://maxio.zendesk. + * com/hc/en-us/articles/24261141522189-Components-Overview). * - * @param productFamilyId The Chargify id of the product family to which the - * component belongs + * @param productFamilyId Either the product family's id or its handle prefixed + * with `handle:` * @param body * @return Response from the API call */ async createOnOffComponent( - productFamilyId: number, + productFamilyId: string, body?: CreateOnOffComponent, requestOptions?: RequestOptions ): Promise> { const req = this.createRequest('POST'); const mapped = req.prepareArgs({ - productFamilyId: [productFamilyId, number()], + productFamilyId: [productFamilyId, string()], body: [body, optional(createOnOffComponentSchema)], }); req.header('Content-Type', 'application/json'); @@ -188,22 +188,22 @@ export class ComponentsController extends BaseController { * charge at the end of the period for the amount of units used, prepaid components are charged for at * the time of purchase, and we subsequently keep track of the usage against the amount purchased. * - * For more information on components, please see our documentation [here](https://maxio-chargify. - * zendesk.com/hc/en-us/articles/5405020625677). + * For more information on components, please see our documentation [here](https://maxio.zendesk. + * com/hc/en-us/articles/24261141522189-Components-Overview). * - * @param productFamilyId The Chargify id of the product family to which the - * component belongs + * @param productFamilyId Either the product family's id or its handle prefixed + * with `handle:` * @param body * @return Response from the API call */ async createPrepaidUsageComponent( - productFamilyId: number, + productFamilyId: string, body?: CreatePrepaidComponent, requestOptions?: RequestOptions ): Promise> { const req = this.createRequest('POST'); const mapped = req.prepareArgs({ - productFamilyId: [productFamilyId, number()], + productFamilyId: [productFamilyId, string()], body: [body, optional(createPrepaidComponentSchema)], }); req.header('Content-Type', 'application/json'); @@ -233,22 +233,22 @@ export class ComponentsController extends BaseController { * So, instead of reporting usage directly for each component (as you would with metered components), * the usage is derived from analysis of your events. * - * For more information on components, please see our documentation [here](https://maxio-chargify. - * zendesk.com/hc/en-us/articles/5405020625677). + * For more information on components, please see our documentation [here](https://maxio.zendesk. + * com/hc/en-us/articles/24261141522189-Components-Overview). * - * @param productFamilyId The Chargify id of the product family to which the - * component belongs + * @param productFamilyId Either the product family's id or its handle prefixed with + * `handle:` * @param body * @return Response from the API call */ async createEventBasedComponent( - productFamilyId: number, + productFamilyId: string, body?: CreateEBBComponent, requestOptions?: RequestOptions ): Promise> { const req = this.createRequest('POST'); const mapped = req.prepareArgs({ - productFamilyId: [productFamilyId, number()], + productFamilyId: [productFamilyId, string()], body: [body, optional(createEBBComponentSchema)], }); req.header('Content-Type', 'application/json'); @@ -289,9 +289,9 @@ export class ComponentsController extends BaseController { * You may read the component by either the component's id or handle. When using the handle, it must be * prefixed with `handle:`. * - * @param productFamilyId The Chargify id of the product family to which the component belongs - * @param componentId Either the Chargify id of the component or the handle for the component - * prefixed with `handle:` + * @param productFamilyId The Advanced Billing id of the product family to which the component belongs + * @param componentId Either the Advanced Billing id of the component or the handle for the + * component prefixed with `handle:` * @return Response from the API call */ async readComponent( @@ -315,10 +315,10 @@ export class ComponentsController extends BaseController { * You may read the component by either the component's id or handle. When using the handle, it must be * prefixed with `handle:`. * - * @param productFamilyId The Chargify id of the product family to which the - * component belongs - * @param componentId Either the Chargify id of the component or the handle - * for the component prefixed with `handle:` + * @param productFamilyId The Advanced Billing id of the product family to which + * the component belongs + * @param componentId Either the Advanced Billing id of the component or the + * handle for the component prefixed with `handle:` * @param body * @return Response from the API call */ @@ -351,9 +351,9 @@ export class ComponentsController extends BaseController { * Sending a DELETE request to this endpoint will archive the component. All current subscribers will * be unffected; their subscription/purchase will continue to be charged as usual. * - * @param productFamilyId The Chargify id of the product family to which the component belongs - * @param componentId Either the Chargify id of the component or the handle for the component - * prefixed with `handle:` + * @param productFamilyId The Advanced Billing id of the product family to which the component belongs + * @param componentId Either the Advanced Billing id of the component or the handle for the + * component prefixed with `handle:` * @return Response from the API call */ async archiveComponent( @@ -502,7 +502,7 @@ export class ComponentsController extends BaseController { /** * This request will return a list of components for a particular product family. * - * @param productFamilyId The Chargify id of the product family + * @param productFamilyId The Advanced Billing id of the product family * @param includeArchived Include archived items. * @param page Result records are organized in pages. By default, the * first page of results is displayed. The page parameter diff --git a/src/controllers/couponsController.ts b/src/controllers/couponsController.ts index d97b6cec..bc887d76 100644 --- a/src/controllers/couponsController.ts +++ b/src/controllers/couponsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -38,13 +38,13 @@ export class CouponsController extends BaseController { /** * ## Coupons Documentation * - * Coupons can be administered in the Chargify application or created via API. Please view our section - * on [creating coupons](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404742830733) for more - * information. + * Coupons can be administered in the Advanced Billing application or created via API. Please view our + * section on [creating coupons](https://maxio.zendesk.com/hc/en-us/articles/24261212433165-Creating- + * Editing-Deleting-Coupons) for more information. * - * Additionally, for documentation on how to apply a coupon to a subscription within the Chargify UI, - * please see our documentation [here](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404761012877). + * Additionally, for documentation on how to apply a coupon to a subscription within the Advanced + * Billing UI, please see our documentation [here](https://maxio.zendesk.com/hc/en- + * us/articles/24261259337101-Coupons-and-Subscriptions). * * ## Create Coupon * @@ -58,8 +58,8 @@ export class CouponsController extends BaseController { * hashes of `restricted_products` and/or `restricted_components` in the format: * `{ "": boolean_value }` * - * @param productFamilyId The Chargify id of the product family to which the coupon - * belongs + * @param productFamilyId The Advanced Billing id of the product family to which + * the coupon belongs * @param body * @return Response from the API call */ @@ -93,8 +93,8 @@ export class CouponsController extends BaseController { * exchange rate. If the flag is set to false, it will return all of the defined prices for each * currency. * - * @param productFamilyId The Chargify id of the product family to which the coupon - * belongs + * @param productFamilyId The Advanced Billing id of the product family to which the + * coupon belongs * @param page Result records are organized in pages. By default, the first * page of results is displayed. The page parameter specifies a * page number of results to fetch. You can start navigating @@ -156,7 +156,7 @@ export class CouponsController extends BaseController { * the default product family in your site, then you will need to specify (either in the url or as a * query string param) the product family id. * - * @param productFamilyId The Chargify id of the product family to which the coupon belongs + * @param productFamilyId The Advanced Billing id of the product family to which the coupon belongs * @param code The code of the coupon * @return Response from the API call */ @@ -178,7 +178,7 @@ export class CouponsController extends BaseController { /** * You can retrieve the Coupon via the API with the Show method. You must identify the Coupon in this - * call by the ID parameter that Chargify assigns. + * call by the ID parameter that Advanced Billing assigns. * If instead you would like to find a Coupon using a Coupon code, see the Coupon Find method. * * When fetching a coupon, if you have defined multiple currencies at the site level, you can @@ -189,8 +189,8 @@ export class CouponsController extends BaseController { * exchange rate. If the flag is set to false, it will return all of the defined prices for each * currency. * - * @param productFamilyId The Chargify id of the product family to which the coupon belongs - * @param couponId The Chargify id of the coupon + * @param productFamilyId The Advanced Billing id of the product family to which the coupon belongs + * @param couponId The Advanced Billing id of the coupon * @return Response from the API call */ async readCoupon( @@ -217,9 +217,9 @@ export class CouponsController extends BaseController { * hashes of `restricted_products` and/or `restricted_components` in the format: * `{ "": boolean_value }` * - * @param productFamilyId The Chargify id of the product family to which the coupon - * belongs - * @param couponId The Chargify id of the coupon + * @param productFamilyId The Advanced Billing id of the product family to which + * the coupon belongs + * @param couponId The Advanced Billing id of the coupon * @param body * @return Response from the API call */ @@ -248,8 +248,8 @@ export class CouponsController extends BaseController { * functional on existing Subscriptions that are using it. * The `archived_at` date and time will be assigned. * - * @param productFamilyId The Chargify id of the product family to which the coupon belongs - * @param couponId The Chargify id of the coupon + * @param productFamilyId The Advanced Billing id of the product family to which the coupon belongs + * @param couponId The Advanced Billing id of the coupon * @return Response from the API call */ async archiveCoupon( @@ -326,8 +326,8 @@ export class CouponsController extends BaseController { /** * This request will provide details about the coupon usage as an array of data hashes, one per product. * - * @param productFamilyId The Chargify id of the product family to which the coupon belongs - * @param couponId The Chargify id of the coupon + * @param productFamilyId The Advanced Billing id of the product family to which the coupon belongs + * @param couponId The Advanced Billing id of the coupon * @return Response from the API call */ async readCouponUsage( @@ -378,7 +378,7 @@ export class CouponsController extends BaseController { * ``` * * @param code The code of the coupon - * @param productFamilyId The Chargify id of the product family to which the coupon belongs + * @param productFamilyId The Advanced Billing id of the product family to which the coupon belongs * @return Response from the API call */ async validateCoupon( @@ -406,7 +406,7 @@ export class CouponsController extends BaseController { * Currency pricing for coupons must mirror the setup of the primary coupon pricing - if the primary * coupon is percentage based, you will not be able to define pricing in non-primary currencies. * - * @param couponId The Chargify id of the coupon + * @param couponId The Advanced Billing id of the coupon * @param body * @return Response from the API call */ @@ -453,12 +453,12 @@ export class CouponsController extends BaseController { * * ## Coupon Subcodes Documentation * - * Full documentation on how to create coupon subcodes in the Chargify UI can be located [here](https: - * //chargify.zendesk.com/hc/en-us/articles/4407755909531#coupon-codes). + * Full documentation on how to create coupon subcodes in the Advanced Billing UI can be located + * [here](https://maxio.zendesk.com/hc/en-us/articles/24261208729229-Coupon-Codes). * - * Additionally, for documentation on how to apply a coupon to a Subscription within the Chargify UI, - * please see our documentation [here](https://chargify.zendesk.com/hc/en- - * us/articles/4407884887835#coupon). + * Additionally, for documentation on how to apply a coupon to a Subscription within the Advanced + * Billing UI, please see our documentation [here](https://maxio.zendesk.com/hc/en- + * us/articles/24261259337101-Coupons-and-Subscriptions). * * ## Create Coupon Subcode * @@ -477,7 +477,7 @@ export class CouponsController extends BaseController { * So, if the coupon subcode is `20%OFF`, the URL to delete this coupon subcode would be: `https: * //.chargify.com/coupons/567/codes/20%25OFF.` * - * @param couponId The Chargify id of the coupon + * @param couponId The Advanced Billing id of the coupon * @param body * @return Response from the API call */ @@ -501,7 +501,7 @@ export class CouponsController extends BaseController { /** * This request allows you to request the subcodes that are attached to a coupon. * - * @param couponId The Chargify id of the coupon + * @param couponId The Advanced Billing id of the coupon * @param page Result records are organized in pages. By default, the first page of results is * displayed. The page parameter specifies a page number of results to fetch. You can * start navigating through the pages to consume the results. You do this by passing in a @@ -553,7 +553,7 @@ export class CouponsController extends BaseController { * * + Any subcodes not created because they are invalid. * - * @param couponId The Chargify id of the coupon + * @param couponId The Advanced Billing id of the coupon * @param body * @return Response from the API call */ @@ -601,7 +601,7 @@ export class CouponsController extends BaseController { * Or if the coupon subcode is 20%OFF, the URL to delete this coupon subcode would be: @https: * //.chargify.com/coupons/567/codes/20%25OFF. * - * @param couponId The Chargify id of the coupon to which the subcode belongs + * @param couponId The Advanced Billing id of the coupon to which the subcode belongs * @param subcode The subcode of the coupon * @return Response from the API call */ diff --git a/src/controllers/customFieldsController.ts b/src/controllers/customFieldsController.ts index 3268e944..34e259af 100644 --- a/src/controllers/customFieldsController.ts +++ b/src/controllers/customFieldsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -46,20 +46,20 @@ export class CustomFieldsController extends BaseController { /** * ## Custom Fields: Metafield Intro * - * **Chargify refers to Custom Fields in the API documentation as metafields and metadata.** Within the - * Chargify UI, metadata and metafields are grouped together under the umbrella of "Custom Fields." All - * of our UI-based documentation that references custom fields will not cite the terminology metafields - * or metadata. + * **Advanced Billing refers to Custom Fields in the API documentation as metafields and metadata.** + * Within the Advanced Billing UI, metadata and metafields are grouped together under the umbrella of + * "Custom Fields." All of our UI-based documentation that references custom fields will not cite the + * terminology metafields or metadata. * * + **Metafield is the custom field** * + **Metadata is the data populating the custom field.** * - * Chargify Metafields are used to add meaningful attributes to subscription and customer resources. - * Full documentation on how to create Custom Fields in the Chargify UI can be located [here](https: - * //maxio-chargify.zendesk.com/hc/en-us/articles/5405332553613-Custom-Fields-Reference). For + * Advanced Billing Metafields are used to add meaningful attributes to subscription and customer + * resources. Full documentation on how to create Custom Fields in the Advanced Billing UI can be + * located [here](https://maxio.zendesk.com/hc/en-us/sections/24266118312589-Custom-Fields). For * additional documentation on how to record data within custom fields, please see our subscription- - * based documentation [here.](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404434903181- - * Subscription-Summary#custom-fields) + * based documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24251701302925-Subscription- + * Summary-Custom-Fields-Tab). * * Metafield are the place where you will set up your resource to accept additional data. It is scoped * to the site instead of a specific customer or subscription. Think of it as the key, and Metadata as @@ -226,19 +226,20 @@ export class CustomFieldsController extends BaseController { /** * ## Custom Fields: Metadata Intro * - * **Chargify refers to Custom Fields in the API documentation as metafields and metadata.** Within the - * Chargify UI, metadata and metafields are grouped together under the umbrella of "Custom Fields." All - * of our UI-based documentation that references custom fields will not cite the terminology metafields - * or metadata. + * **Advanced Billing refers to Custom Fields in the API documentation as metafields and metadata.** + * Within the Advanced Billing UI, metadata and metafields are grouped together under the umbrella of + * "Custom Fields." All of our UI-based documentation that references custom fields will not cite the + * terminology metafields or metadata. * * + **Metafield is the custom field** * + **Metadata is the data populating the custom field.** * - * Chargify Metafields are used to add meaningful attributes to subscription and customer resources. - * Full documentation on how to create Custom Fields in the Chargify UI can be located [here](https: - * //chargify.zendesk.com/hc/en-us/articles/4407659856411). For additional documentation on how to - * record data within custom fields, please see our subscription-based documentation [here.](https: - * //chargify.zendesk.com/hc/en-us/articles/4407884887835#custom-fields) + * Advanced Billing Metafields are used to add meaningful attributes to subscription and customer + * resources. Full documentation on how to create Custom Fields in the Advanced Billing UI can be + * located [here](https://maxio.zendesk.com/hc/en-us/articles/24266164865677-Custom-Fields-Overview). + * For additional documentation on how to record data within custom fields, please see our subscription- + * based documentation [here.](https://maxio.zendesk.com/hc/en-us/articles/24251701302925-Subscription- + * Summary-Custom-Fields-Tab) * * Metadata is associated to a customer or subscription, and corresponds to a Metafield. When creating * a new metadata object for a given record, **if the metafield is not present it will be created**. @@ -258,8 +259,8 @@ export class CustomFieldsController extends BaseController { * Please pay special attention to the resource you use when creating metadata. * * @param resourceType the resource type to which the metafields belong - * @param resourceId The Chargify id of the customer or the subscription for - * which the metadata applies + * @param resourceId The Advanced Billing id of the customer or the subscription + * for which the metadata applies * @param body * @return Response from the API call */ @@ -297,8 +298,8 @@ export class CustomFieldsController extends BaseController { * This endpoint will also display the current stats of your metadata to use as a tool for pagination. * * @param resourceType the resource type to which the metafields belong - * @param resourceId The Chargify id of the customer or the subscription for which the metadata - * applies + * @param resourceId The Advanced Billing id of the customer or the subscription for which the + * metadata applies * @param page Result records are organized in pages. By default, the first page of results * is displayed. The page parameter specifies a page number of results to fetch. * You can start navigating through the pages to consume the results. You do @@ -342,8 +343,8 @@ export class CustomFieldsController extends BaseController { * This method allows you to update the existing metadata associated with a subscription or customer. * * @param resourceType the resource type to which the metafields belong - * @param resourceId The Chargify id of the customer or the subscription for - * which the metadata applies + * @param resourceId The Advanced Billing id of the customer or the subscription + * for which the metadata applies * @param body * @return Response from the API call */ @@ -399,8 +400,8 @@ export class CustomFieldsController extends BaseController { * of `true`. * * @param resourceType the resource type to which the metafields belong - * @param resourceId The Chargify id of the customer or the subscription for which the metadata - * applies + * @param resourceId The Advanced Billing id of the customer or the subscription for which the + * metadata applies * @param name Name of field to be removed. * @param names Names of fields to be removed. Use in query: `names[]=field1&names[]=my- * field&names[]=another-field`. diff --git a/src/controllers/customersController.ts b/src/controllers/customersController.ts index ccc16aea..e31feca1 100644 --- a/src/controllers/customersController.ts +++ b/src/controllers/customersController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -40,23 +40,23 @@ export class CustomersController extends BaseController { * If provided, the `reference` value must be unique. It represents a unique identifier for the * customer from your own app, i.e. the customer’s ID. This allows you to retrieve a given customer via * a piece of shared information. Alternatively, you may choose to leave `reference` blank, and store - * Chargify’s unique ID for the customer, which is in the `id` attribute. + * Advanced Billing’s unique ID for the customer, which is in the `id` attribute. * - * Full documentation on how to locate, create and edit Customers in the Chargify UI can be located - * [here](https://chargify.zendesk.com/hc/en-us/articles/4407659914267). + * Full documentation on how to locate, create and edit Customers in the Advanced Billing UI can be + * located [here](https://maxio.zendesk.com/hc/en-us/articles/24252190590093-Customer-Details). * * ## Required Country Format * - * Chargify requires that you use the ISO Standard Country codes when formatting country attribute of - * the customer. + * Advanced Billing requires that you use the ISO Standard Country codes when formatting country + * attribute of the customer. * * Countries should be formatted as 2 characters. For more information, please see the following * wikipedia article on [ISO_3166-1.](http://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) * * ## Required State Format * - * Chargify requires that you use the ISO Standard State codes when formatting state attribute of the - * customer. + * Advanced Billing requires that you use the ISO Standard State codes when formatting state attribute + * of the customer. * * + US States (2 characters): [ISO_3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) * @@ -66,10 +66,10 @@ export class CustomersController extends BaseController { * * ## Locale * - * Chargify allows you to attribute a language/region to your customer to deliver invoices in any - * required language. - * For more: [Customer Locale](https://chargify.zendesk.com/hc/en-us/articles/4407870384283#customer- - * locale) + * Advanced Billing allows you to attribute a language/region to your customer to deliver invoices in + * any required language. + * For more: [Customer Locale](https://maxio.zendesk.com/hc/en-us/articles/24286672013709-Customer- + * Locale) * * @param body * @return Response from the API call @@ -105,7 +105,7 @@ export class CustomersController extends BaseController { * Common use cases are: * * + Search by an email - * + Search by a Chargify ID + * + Search by an Advanced Billing ID * + Search by an organization * + Search by a reference value from your application * + Search by a first or last name @@ -196,9 +196,9 @@ export class CustomersController extends BaseController { } /** - * This method allows to retrieve the Customer properties by Chargify-generated Customer ID. + * This method allows to retrieve the Customer properties by Advanced Billing-generated Customer ID. * - * @param id The Chargify id of the customer + * @param id The Advanced Billing id of the customer * @return Response from the API call */ async readCustomer( @@ -215,7 +215,7 @@ export class CustomersController extends BaseController { /** * This method allows to update the Customer. * - * @param id The Chargify id of the customer + * @param id The Advanced Billing id of the customer * @param body * @return Response from the API call */ @@ -246,7 +246,7 @@ export class CustomersController extends BaseController { /** * This method allows you to delete the Customer. * - * @param id The Chargify id of the customer + * @param id The Advanced Billing id of the customer * @return Response from the API call */ async deleteCustomer( diff --git a/src/controllers/eventsBasedBillingSegmentsController.ts b/src/controllers/eventsBasedBillingSegmentsController.ts index b6cce240..37eb4697 100644 --- a/src/controllers/eventsBasedBillingSegmentsController.ts +++ b/src/controllers/eventsBasedBillingSegmentsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/controllers/eventsController.ts b/src/controllers/eventsController.ts index 7d07e8c8..2aa60c06 100644 --- a/src/controllers/eventsController.ts +++ b/src/controllers/eventsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -20,13 +20,13 @@ export class EventsController extends BaseController { /** * ## Events Intro * - * Chargify Events include various activity that happens around a Site. This information is + * Advanced Billing Events include various activity that happens around a Site. This information is * **especially** useful to track down issues that arise when subscriptions are not created due to * errors. * - * Within the Chargify UI, "Events" are referred to as "Site Activity". Full documentation on how to - * record view Events / Site Activty in the Chargify UI can be located [here](https://chargify.zendesk. - * com/hc/en-us/articles/4407864698139). + * Within the Advanced Billing UI, "Events" are referred to as "Site Activity". Full documentation on + * how to record view Events / Site Activty in the Advanced Billing UI can be located [here](https: + * //maxio.zendesk.com/hc/en-us/articles/24250671733517-Site-Activity). * * ## List Events for a Site * diff --git a/src/controllers/insightsController.ts b/src/controllers/insightsController.ts index b6815dda..7af79579 100644 --- a/src/controllers/insightsController.ts +++ b/src/controllers/insightsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -80,8 +80,8 @@ export class InsightsController extends BaseController { * * ## Understanding MRR movements * - * This endpoint will aid in accessing your site's [MRR Report](https://chargify.zendesk.com/hc/en- - * us/articles/4407838249627) data. + * This endpoint will aid in accessing your site's [MRR Report](https://maxio.zendesk.com/hc/en- + * us/articles/24285894587021-MRR-Analytics) data. * * Whenever a subscription event occurs that causes your site's MRR to change (such as a signup or * upgrade), we record an MRR movement. These records are accessible via the MRR Movements endpoint. @@ -91,9 +91,9 @@ export class InsightsController extends BaseController { * * ### Plan & Usage Breakouts * - * In the MRR Report UI, we support a setting to [include or exclude](https://chargify.zendesk. - * com/hc/en-us/articles/4407838249627#displaying-component-based-metered-usage-in-mrr) usage revenue. - * In the MRR APIs, responses include `plan` and `usage` breakouts. + * In the MRR Report UI, we support a setting to [include or exclude](https://maxio.zendesk.com/hc/en- + * us/articles/24285894587021-MRR-Analytics#displaying-component-based-metered-usage-in-mrr) usage + * revenue. In the MRR APIs, responses include `plan` and `usage` breakouts. * * Plan includes revenue from: * * Products diff --git a/src/controllers/invoicesController.ts b/src/controllers/invoicesController.ts index 416fbb5d..971e31ba 100644 --- a/src/controllers/invoicesController.ts +++ b/src/controllers/invoicesController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -476,10 +476,10 @@ export class InvoicesController extends BaseController { * } * ``` * - * Note that Chargify will attempt to fully pay the invoice's `due_amount` from the Subscription's - * Service Credit account. At this time, partial payments from a Service Credit Account are only - * allowed for consolidated invoices (subscription groups). Therefore, for normal invoices the Service - * Credit account balance must be greater than or equal to the invoice's `due_amount`. + * Note that Advanced Billing will attempt to fully pay the invoice's `due_amount` from the + * Subscription's Service Credit account. At this time, partial payments from a Service Credit Account + * are only allowed for consolidated invoices (subscription groups). Therefore, for normal invoices the + * Service Credit account balance must be greater than or equal to the invoice's `due_amount`. * * @param uid The unique identifier for the invoice, this does not * refer to the public facing invoice number. @@ -569,7 +569,7 @@ export class InvoicesController extends BaseController { * `discounts`, `taxes`, `applications`, or `refunds`. To include these arrays, pass the specific field * as a key in the query with a value set to `true`. * - * @param subscriptionId The subscription's Chargify id + * @param subscriptionId The subscription's Advanced Billing id * @param page Result records are organized in pages. By default, the first page of results is * displayed. The page parameter specifies a page number of results to fetch. You * can start navigating through the pages to consume the results. You do this by diff --git a/src/controllers/offersController.ts b/src/controllers/offersController.ts index 40a97ab6..04c366ad 100644 --- a/src/controllers/offersController.ts +++ b/src/controllers/offersController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -20,7 +20,7 @@ import { ErrorArrayMapResponseError } from '../errors/errorArrayMapResponseError export class OffersController extends BaseController { /** - * Create an offer within your Chargify site by sending a POST request. + * Create an offer within your Advanced Billing site by sending a POST request. * * ## Documentation * @@ -29,8 +29,8 @@ export class OffersController extends BaseController { * * Once an offer is defined it can be used as an alternative to the product when creating subscriptions. * - * Full documentation on how to use offers in the Chargify UI can be located [here](https://chargify. - * zendesk.com/hc/en-us/articles/4407753852059). + * Full documentation on how to use offers in the Advanced Billing UI can be located [here](https: + * //maxio.zendesk.com/hc/en-us/articles/24261295098637-Offers-Overview). * * ## Using a Product Price Point * diff --git a/src/controllers/paymentProfilesController.ts b/src/controllers/paymentProfilesController.ts index da4589d6..a1860653 100644 --- a/src/controllers/paymentProfilesController.ts +++ b/src/controllers/paymentProfilesController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -40,10 +40,10 @@ export class PaymentProfilesController extends BaseController { * Use this endpoint to create a payment profile for a customer. * * Payment Profiles house the credit card, ACH (Authorize.Net or Stripe only,) or PayPal (Braintree - * only,) data for a customer. The payment information is attached to the customer within Chargify, as - * opposed to the Subscription itself. + * only,) data for a customer. The payment information is attached to the customer within Advanced + * Billing, as opposed to the Subscription itself. * - * You must include a customer_id so that Chargify will attach it to the customer entry. If no + * You must include a customer_id so that Advanced Billing will attach it to the customer entry. If no * customer_id is included the API will return a 404. * * ## Create a Payment Profile for ACH usage @@ -73,15 +73,15 @@ export class PaymentProfilesController extends BaseController { * * ## Payment Profile Documentation * - * Full documentation on how Payment Profiles operate within Chargify can be located under the + * Full documentation on how Payment Profiles operate within Advanced Billing can be located under the * following links: * - * + [Subscriber Payment Details](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405212558349- - * Customers-Reference#customers-reference-0-0) - * + [Self Service Pages](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404759627021) (Allows - * credit card updates by Subscriber) - * + [Public Signup Pages payment settings](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405267754381-Individual-Page-Settings#credit-card-settings) + * + [Subscriber Payment Details](https://maxio.zendesk.com/hc/en-us/articles/24251599929613- + * Subscription-Summary-Payment-Details-Tab) + * + [Self Service Pages](https://maxio.zendesk.com/hc/en-us/articles/24261425318541-Self-Service- + * Pages) (Allows credit card updates by Subscriber) + * + [Public Signup Pages payment settings](https://maxio.zendesk.com/hc/en-us/articles/24261368332557- + * Individual-Page-Settings) * * ## Create a Payment Profile with a Chargify.js token * @@ -124,8 +124,8 @@ export class PaymentProfilesController extends BaseController { * * For more information on GoCardless, please view the following resources: * - * + [Full documentation on GoCardless](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404501889677) + * + [Full documentation on GoCardless](https://maxio.zendesk.com/hc/en-us/articles/24176159136909- + * GoCardless) * * + [Using Chargify.js with GoCardless - minimal example](https://developers.chargify. * com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-direct-debit-gocardless- @@ -178,8 +178,8 @@ export class PaymentProfilesController extends BaseController { * * If the customer, bank account, and mandate already exist in GoCardless, a payment profile can be * created by using the IDs. In order to create masked versions of `bank_account_number` and - * `bank_routing_number` that are used to display within Chargify Admin UI, you can pass the last four - * digits for this fields which then will be saved in this form `XXXX[four-provided-digits]`. + * `bank_routing_number` that are used to display within Advanced Billing Admin UI, you can pass the + * last four digits for this fields which then will be saved in this form `XXXX[four-provided-digits]`. * * ```json * { @@ -205,8 +205,8 @@ export class PaymentProfilesController extends BaseController { * * For more information on Stripe SEPA Direct Debit, please view the following resources: * - * + [Full documentation on Stripe SEPA Direct Debit](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) + * + [Full documentation on Stripe SEPA Direct Debit](https://maxio.zendesk.com/hc/en- + * us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) * * + [Using Chargify.js with Stripe Direct Debit - minimal example](https://developers.chargify. * com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-sepa-or-becs-direct-debit- @@ -241,8 +241,8 @@ export class PaymentProfilesController extends BaseController { * * For more information on Stripe BECS Direct Debit, please view the following resources: * - * + [Full documentation on Stripe BECS Direct Debit](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) + * + [Full documentation on Stripe BECS Direct Debit](https://maxio.zendesk.com/hc/en- + * us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) * * + [Using Chargify.js with Stripe BECS Direct Debit - minimal example](https://developers.chargify. * com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-sepa-or-becs-direct-debit- @@ -279,8 +279,8 @@ export class PaymentProfilesController extends BaseController { * Contact the support team to enable this payment method. * For more information on Stripe BACS Direct Debit, please view the following resources: * - * + [Full documentation on Stripe BACS Direct Debit](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) + * + [Full documentation on Stripe BACS Direct Debit](https://maxio.zendesk.com/hc/en- + * us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) * * ### Stripe BACS Direct Debit Payment Profiles * @@ -307,9 +307,10 @@ export class PaymentProfilesController extends BaseController { * ## 3D Secure - Checkout * * It may happen that a payment needs 3D Secure Authentication when the payment profile is created; - * this is referred to in our help docs as a [post-authentication flow](https://maxio-chargify.zendesk. - * com/hc/en-us/articles/5405177432077#psd2-flows-pre-authentication-and-post-authentication). The - * server returns `422 Unprocessable Entity` in this case with the following response: + * this is referred to in our help docs as a [post-authentication flow](https://maxio.zendesk.com/hc/en- + * us/articles/24176278996493-Testing-Implementing-3D-Secure#psd2-flows-pre-authentication-and-post- + * authentication). The server returns `422 Unprocessable Entity` in this case with the following + * response: * * ```json * { @@ -381,7 +382,7 @@ export class PaymentProfilesController extends BaseController { * created in your current vault. If the customer, bank * account, and mandate already exist in your vault, follow * the Import example to link the payment profile into - * Chargify. + * Advanced Billing. * @return Response from the API call */ async createPaymentProfile( @@ -535,9 +536,9 @@ export class PaymentProfilesController extends BaseController { * card number and CVV. * * - If you are using **Authorize.net**, **Cybersource**, **Forte**, **Braintree Blue** or **Stripe**, - * Chargify will ignore the credit card number and CVV when processing an update via the API, and - * attempt a partial update instead. If you wish to change the card number on a payment profile, you - * will need to create a new payment profile for the given customer. + * Advanced Billing will ignore the credit card number and CVV when processing an update via the API, + * and attempt a partial update instead. If you wish to change the card number on a payment profile, + * you will need to create a new payment profile for the given customer. * * - A Payment Profile cannot be updated with the attributes of another type of Payment Profile. For * example, if the payment profile you are attempting to update is a credit card, you cannot pass in @@ -762,16 +763,16 @@ export class PaymentProfilesController extends BaseController { } /** - * One Time Tokens aka Chargify Tokens house the credit card or ACH (Authorize.Net or Stripe only) data - * for a customer. + * One Time Tokens aka Advanced Billing Tokens house the credit card or ACH (Authorize.Net or Stripe + * only) data for a customer. * * You can use One Time Tokens while creating a subscription or payment profile instead of passing all * bank account or credit card data directly to a given API endpoint. * - * To obtain a One Time Token you have to use [chargify.js](https://developers.chargify. + * To obtain a One Time Token you have to use [Chargify.js](https://developers.chargify. * com/docs/developer-docs/ZG9jOjE0NjAzNDI0-overview). * - * @param chargifyToken Chargify Token + * @param chargifyToken Advanced Billing Token * @return Response from the API call */ async readOneTimeToken( diff --git a/src/controllers/productFamiliesController.ts b/src/controllers/productFamiliesController.ts index 9b31d084..6fef6b07 100644 --- a/src/controllers/productFamiliesController.ts +++ b/src/controllers/productFamiliesController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -136,11 +136,11 @@ export class ProductFamiliesController extends BaseController { } /** - * This method will create a Product Family within your Chargify site. Create a Product Family to act - * as a container for your products, components and coupons. + * This method will create a Product Family within your Advanced Billing site. Create a Product Family + * to act as a container for your products, components and coupons. * - * Full documentation on how Product Families operate within the Chargify UI can be located - * [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405369633421). + * Full documentation on how Product Families operate within the Advanced Billing UI can be located + * [here](https://maxio.zendesk.com/hc/en-us/articles/24261098936205-Product-Families). * * @param body * @return Response from the API call @@ -227,7 +227,7 @@ export class ProductFamiliesController extends BaseController { * * The product family can be specified either with the id number, or with the `handle:my-family` format. * - * @param id The Chargify id of the product family + * @param id The Advanced Billing id of the product family * @return Response from the API call */ async readProductFamily( diff --git a/src/controllers/productPricePointsController.ts b/src/controllers/productPricePointsController.ts index 9be13b04..cdb756e3 100644 --- a/src/controllers/productPricePointsController.ts +++ b/src/controllers/productPricePointsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -99,7 +99,8 @@ import { ProductPricePointErrorResponseError } from '../errors/productPricePoint export class ProductPricePointsController extends BaseController { /** - * [Product Price Point Documentation](https://chargify.zendesk.com/hc/en-us/articles/4407755824155) + * [Product Price Point Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261111947789- + * Product-Price-Points) * * @param productId The id or handle of the product. When using the * handle, it must be prefixed with `handle:` @@ -306,8 +307,8 @@ export class ProductPricePointsController extends BaseController { /** * Use this endpoint to unarchive an archived product price point. * - * @param productId The Chargify id of the product to which the price point belongs - * @param pricePointId The Chargify id of the product price point + * @param productId The Advanced Billing id of the product to which the price point belongs + * @param pricePointId The Advanced Billing id of the product price point * @return Response from the API call */ async unarchiveProductPricePoint( @@ -330,8 +331,8 @@ export class ProductPricePointsController extends BaseController { * * Note: Custom product price points are not able to be set as the default for a product. * - * @param productId The Chargify id of the product to which the price point belongs - * @param pricePointId The Chargify id of the product price point + * @param productId The Advanced Billing id of the product to which the price point belongs + * @param pricePointId The Advanced Billing id of the product price point * @return Response from the API call */ async promoteProductPricePointToDefault( @@ -352,8 +353,8 @@ export class ProductPricePointsController extends BaseController { /** * Use this endpoint to create multiple product price points in one request. * - * @param productId The Chargify id of the product to which the - * price points belong + * @param productId The Advanced Billing id of the product to which + * the price points belong * @param body * @return Response from the API call */ @@ -393,8 +394,8 @@ export class ProductPricePointsController extends BaseController { * * Note: Currency Prices are not able to be created for custom product price points. * - * @param productPricePointId The Chargify id of the product price - * point + * @param productPricePointId The Advanced Billing id of the product + * price point * @param body * @return Response from the API call */ @@ -431,7 +432,8 @@ export class ProductPricePointsController extends BaseController { * * Note: Currency Prices are not able to be updated for custom product price points. * - * @param productPricePointId The Chargify id of the product price point + * @param productPricePointId The Advanced Billing id of the product price + * point * @param body * @return Response from the API call */ diff --git a/src/controllers/productsController.ts b/src/controllers/productsController.ts index b1dd9160..4c28d14e 100644 --- a/src/controllers/productsController.ts +++ b/src/controllers/productsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -28,11 +28,12 @@ import { ErrorListResponseError } from '../errors/errorListResponseError'; export class ProductsController extends BaseController { /** - * Use this method to create a product within your Chargify site. + * Use this method to create a product within your Advanced Billing site. * - * + [Products Documentation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405561405709) - * + [Changing a Subscription's Product](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404225334669-Product-Changes-Migrations) + * + [Products Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261090117645-Products- + * Overview) + * + [Changing a Subscription's Product](https://maxio.zendesk.com/hc/en-us/articles/24252069837581- + * Product-Changes-and-Migrations) * * @param productFamilyId Either the product family's id or its handle * prefixed with `handle:` @@ -63,9 +64,10 @@ export class ProductsController extends BaseController { } /** - * This endpoint allows you to read the current details of a product that you've created in Chargify. + * This endpoint allows you to read the current details of a product that you've created in Advanced + * Billing. * - * @param productId The Chargify id of the product + * @param productId The Advanced Billing id of the product * @return Response from the API call */ async readProduct( @@ -93,7 +95,7 @@ export class ProductsController extends BaseController { * point for this product. If you should like to update an existing product price point, that must be * done separately. * - * @param productId The Chargify id of the product + * @param productId The Advanced Billing id of the product * @param body * @return Response from the API call */ @@ -127,7 +129,7 @@ export class ProductsController extends BaseController { * This will restrict the option to chose the product for purchase via the Billing Portal, as well as * disable Public Signup Pages for the product. * - * @param productId The Chargify id of the product + * @param productId The Advanced Billing id of the product * @return Response from the API call */ async archiveProduct( diff --git a/src/controllers/proformaInvoicesController.ts b/src/controllers/proformaInvoicesController.ts index 3dade780..5278da28 100644 --- a/src/controllers/proformaInvoicesController.ts +++ b/src/controllers/proformaInvoicesController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/controllers/reasonCodesController.ts b/src/controllers/reasonCodesController.ts index b2b6f016..f6236421 100644 --- a/src/controllers/reasonCodesController.ts +++ b/src/controllers/reasonCodesController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -33,16 +33,15 @@ export class ReasonCodesController extends BaseController { * ReasonCodes are a way to gain a high level view of why your customers are cancelling the subcription * to your product or service. * - * Add a set of churn reason codes to be displayed in-app and/or the Chargify Billing Portal. As your + * Add a set of churn reason codes to be displayed in-app and/or the Maxio Billing Portal. As your * subscribers decide to cancel their subscription, learn why they decided to cancel. * * ## Reason Code Documentation * - * Full documentation on how Reason Codes operate within Chargify can be located under the following - * links. + * Full documentation on how Reason Codes operate within Advanced Billing can be located under the + * following links. * - * [Churn Reason Codes](https://chargify.zendesk.com/hc/en-us/articles/4407896775579#churn-reason- - * codes) + * [Churn Reason Codes](https://maxio.zendesk.com/hc/en-us/articles/24286647554701-Churn-Reason-Codes) * * ## Create Reason Code * @@ -110,7 +109,7 @@ export class ReasonCodesController extends BaseController { * This method gives a merchant the option to retrieve a list of a particular code for a given Site by * providing the unique numerical ID of the code. * - * @param reasonCodeId The Chargify id of the reason code + * @param reasonCodeId The Advanced Billing id of the reason code * @return Response from the API call */ async readReasonCode( @@ -128,7 +127,7 @@ export class ReasonCodesController extends BaseController { /** * This method gives a merchant the option to update an existing reason code for a given site. * - * @param reasonCodeId The Chargify id of the reason code + * @param reasonCodeId The Advanced Billing id of the reason code * @param body * @return Response from the API call */ @@ -154,7 +153,7 @@ export class ReasonCodesController extends BaseController { * This method gives a merchant the option to delete one reason code from the Churn Reason Codes. This * code will be immediately removed. This action is not reversable. * - * @param reasonCodeId The Chargify id of the reason code + * @param reasonCodeId The Advanced Billing id of the reason code * @return Response from the API call */ async deleteReasonCode( diff --git a/src/controllers/referralCodesController.ts b/src/controllers/referralCodesController.ts index 5edd72dd..e3ad844c 100644 --- a/src/controllers/referralCodesController.ts +++ b/src/controllers/referralCodesController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -20,8 +20,8 @@ export class ReferralCodesController extends BaseController { * * ## Referrals Documentation * - * Full documentation on how to use the referrals feature in the Chargify UI can be located - * [here](https://chargify.zendesk.com/hc/en-us/articles/4407802831643). + * Full documentation on how to use the referrals feature in the Advanced Billing UI can be located + * [here](https://maxio.zendesk.com/hc/en-us/sections/24286965611405-Referrals). * * ## Server Response * diff --git a/src/controllers/salesCommissionsController.ts b/src/controllers/salesCommissionsController.ts index 5c3dd355..c2ee84e2 100644 --- a/src/controllers/salesCommissionsController.ts +++ b/src/controllers/salesCommissionsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -32,7 +32,7 @@ export class SalesCommissionsController extends BaseController { * * Access to the Sales Commission API endpoints is available to users with financial access, where the * seller has the Advanced Analytics component enabled. For further information on getting access to - * Advanced Analytics please contact Chargify support. + * Advanced Analytics please contact Maxio support. * * > Note: The request is at seller level, it means `<>` variable will be replaced by `app` * @@ -99,7 +99,7 @@ export class SalesCommissionsController extends BaseController { * * Access to the Sales Commission API endpoints is available to users with financial access, where the * seller has the Advanced Analytics component enabled. For further information on getting access to - * Advanced Analytics please contact Chargify support. + * Advanced Analytics please contact Maxio support. * * > Note: The request is at seller level, it means `<>` variable will be replaced by `app` * @@ -166,12 +166,12 @@ export class SalesCommissionsController extends BaseController { * * Access to the Sales Commission API endpoints is available to users with financial access, where the * seller has the Advanced Analytics component enabled. For further information on getting access to - * Advanced Analytics please contact Chargify support. + * Advanced Analytics please contact Maxio support. * * > Note: The request is at seller level, it means `<>` variable will be replaced by `app` * * @param sellerId The Chargify id of your seller account - * @param salesRepId The Chargify id of sales rep. + * @param salesRepId The Advanced Billing id of sales rep. * @param authorization For authorization use user API key. See details [here](https://developers. * chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api- * authentication). diff --git a/src/controllers/sitesController.ts b/src/controllers/sitesController.ts index d63dae52..0a32210d 100644 --- a/src/controllers/sitesController.ts +++ b/src/controllers/sitesController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -18,11 +18,11 @@ export class SitesController extends BaseController { /** * This endpoint allows you to fetch some site data. * - * Full documentation on Sites in the Chargify UI can be located [here](https://chargify.zendesk. - * com/hc/en-us/articles/4407870738587). + * Full documentation on Sites in the Advanced Billing UI can be located [here](https://maxio.zendesk. + * com/hc/en-us/sections/24250550707085-Sites). * - * Specifically, the [Clearing Site Data](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405428327309) section is extremely relevant to this endpoint documentation. + * Specifically, the [Clearing Site Data](https://maxio.zendesk.com/hc/en-us/articles/24250617028365- + * Clearing-Site-Data) section is extremely relevant to this endpoint documentation. * * #### Relationship invoicing enabled * If site has RI enabled then you will see more settings like: @@ -31,7 +31,8 @@ export class SitesController extends BaseController { * "whopays_enabled": true, * "whopays_default_payer": "self" * You can read more about these settings here: - * [Who Pays & Customer Hierarchy](https://chargify.zendesk.com/hc/en-us/articles/4407746683291) + * [Who Pays & Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer- + * Hierarchies-WhoPays) * * @return Response from the API call */ diff --git a/src/controllers/subscriptionComponentsController.ts b/src/controllers/subscriptionComponentsController.ts index 8fe52873..945b5c8f 100644 --- a/src/controllers/subscriptionComponentsController.ts +++ b/src/controllers/subscriptionComponentsController.ts @@ -1,10 +1,14 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { ApiResponse, commaPrefix, RequestOptions } from '../core'; +import { + ActivateEventBasedComponent, + activateEventBasedComponentSchema, +} from '../models/activateEventBasedComponent'; import { AllocateComponents, allocateComponentsSchema, @@ -101,8 +105,8 @@ export class SubscriptionComponentsController extends BaseController { * This request will list information regarding a specific component owned by a subscription. * * @param subscriptionId The Chargify id of the subscription - * @param componentId The Chargify id of the component. Alternatively, the component's handle prefixed - * by `handle:` + * @param componentId The Advanced Billing id of the component. Alternatively, the component's handle + * prefixed by `handle:` * @return Response from the API call */ async readSubscriptionComponent( @@ -321,10 +325,10 @@ export class SubscriptionComponentsController extends BaseController { * * ## Allocations Documentation * - * Full documentation on how to record Allocations in the Chargify UI can be located [here](https: - * //maxio-chargify.zendesk.com/hc/en-us/articles/5404527849997). It is focused on how allocations - * operate within the Chargify UI.It goes into greater detail on how the user interface will react when - * recording allocations. + * Full documentation on how to record Allocations in the Advanced Billing UI can be located + * [here](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview). + * It is focused on how allocations operate within the Advanced Billing UI.It goes into greater detail + * on how the user interface will react when recording allocations. * * This documentation also goes into greater detail on how proration is taken into consideration when * applying component allocations. @@ -339,8 +343,8 @@ export class SubscriptionComponentsController extends BaseController { * component type always generate charges immediately without proration. * * For background information on prorated components and upgrade/downgrade schemes, see [Setting - * Component Allocations.](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404527849997#proration- - * upgrades-vs-downgrades). + * Component Allocations.](https://maxio.zendesk.com/hc/en-us/articles/24251906165133-Component- + * Allocations-Proration). * See the tables below for valid values. * * | upgrade_charge | Definition                                                        | @@ -367,23 +371,23 @@ export class SubscriptionComponentsController extends BaseController { * ### Order of Resolution for upgrade_charge and downgrade_credit * * 1. Per allocation in API call (within a single allocation of the `allocations` array) - * 2. [Component-level default value](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404527849997-Component-Allocations#component-allocations-0-0) + * 2. [Component-level default value](https://maxio.zendesk.com/hc/en-us/articles/24251883961485- + * Component-Allocations-Overview) * 3. Allocation API call top level (outside of the `allocations` array) - * 4. [Site-level default value](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404527849997#proration-schemes) + * 4. [Site-level default value](https://maxio.zendesk.com/hc/en-us/articles/24251906165133-Component- + * Allocations-Proration#proration-schemes) * * ### Order of Resolution for accrue charge * * 1. Allocation API call top level (outside of the `allocations` array) - * 2. [Site-level default value](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404527849997#proration-schemes) + * 2. [Site-level default value](https://maxio.zendesk.com/hc/en-us/articles/24251906165133-Component- + * Allocations-Proration#proration-schemes) * * **NOTE: Proration uses the current price of the component as well as the current tax rates. Changes * to either may cause the prorated charge/credit to be wrong.** * * @param subscriptionId The Chargify id of the subscription - * @param componentId The Chargify id of the component + * @param componentId The Advanced Billing id of the component * @param body * @return Response from the API call */ @@ -420,9 +424,9 @@ export class SubscriptionComponentsController extends BaseController { * When a subscription's on/off component has been toggled to on (`1`) or off (`0`), usage will be * logged in this response. * - * ## Querying data via Chargify gem + * ## Querying data via Advanced Billing gem * - * You can also query the current quantity via the [official Chargify Gem.](http://github. + * You can also query the current quantity via the [official Advanced Billing Gem.](http://github. * com/chargify/chargify_api_ares) * * ```# First way @@ -437,7 +441,7 @@ export class SubscriptionComponentsController extends BaseController { * ``` * * @param subscriptionId The Chargify id of the subscription - * @param componentId The Chargify id of the component + * @param componentId The Advanced Billing id of the component * @param page Result records are organized in pages. By default, the first page of results is * displayed. The page parameter specifies a page number of results to fetch. You * can start navigating through the pages to consume the results. You do this by @@ -510,9 +514,9 @@ export class SubscriptionComponentsController extends BaseController { } /** - * Chargify offers the ability to preview a potential subscription's **quantity-based** or **on/off** - * component allocation in the middle of the current billing period. This is useful if you want users - * to be able to see the effect of a component operation before actually doing it. + * Advanced Billing offers the ability to preview a potential subscription's **quantity-based** or + * **on/off** component allocation in the middle of the current billing period. This is useful if you + * want users to be able to see the effect of a component operation before actually doing it. * * ## Fine-grained Component Control: Use with multiple `upgrade_charge`s or `downgrade_credits` * @@ -569,8 +573,8 @@ export class SubscriptionComponentsController extends BaseController { * subscription's current period beginning date. * * @param subscriptionId The Chargify id of the subscription - * @param componentId The Chargify id of the component - * @param allocationId The Chargify id of the allocation + * @param componentId The Advanced Billing id of the component + * @param allocationId The Advanced Billing id of the allocation * @param body * @return Response from the API call */ @@ -621,8 +625,8 @@ export class SubscriptionComponentsController extends BaseController { * issued along with a Credit Note. * * @param subscriptionId The Chargify id of the subscription - * @param componentId The Chargify id of the component - * @param allocationId The Chargify id of the allocation + * @param componentId The Advanced Billing id of the component + * @param allocationId The Advanced Billing id of the allocation * @param body * @return Response from the API call */ @@ -657,22 +661,23 @@ export class SubscriptionComponentsController extends BaseController { /** * ## Documentation * - * Full documentation on how to create Components in the Chargify UI can be located [here](https: - * //maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677#creating-components). Additionally, for - * information on how to record component usage against a subscription, please see the following - * resources: + * Full documentation on how to create Components in the Advanced Billing UI can be located + * [here](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive- + * Components). Additionally, for information on how to record component usage against a subscription, + * please see the following resources: * - * + [Recording Metered Component Usage](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404527849997#reporting-metered-component-usage) - * + [Reporting Prepaid Component Status](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404527849997#reporting-prepaid-component-status) + * + [Recording Metered Component Usage](https://maxio.zendesk.com/hc/en-us/articles/24251890500109- + * Reporting-Component-Allocations#reporting-metered-component-usage) + * + [Reporting Prepaid Component Status](https://maxio.zendesk.com/hc/en-us/articles/24251890500109- + * Reporting-Component-Allocations#reporting-prepaid-component-status) * - * You may choose to report metered or prepaid usage to Chargify as often as you wish. You may report - * usage as it happens. You may also report usage periodically, such as each night or once per billing - * period. If usage events occur in your system very frequently (on the order of thousands of times an - * hour), it is best to accumulate usage into batches on your side, and then report those batches less - * frequently, such as daily. This will ensure you remain below any API throttling limits. If your use - * case requires higher rates of usage reporting, we recommend utilizing Events Based Components. + * You may choose to report metered or prepaid usage to Advanced Billing as often as you wish. You may + * report usage as it happens. You may also report usage periodically, such as each night or once per + * billing period. If usage events occur in your system very frequently (on the order of thousands of + * times an hour), it is best to accumulate usage into batches on your side, and then report those + * batches less frequently, such as daily. This will ensure you remain below any API throttling limits. + * If your use case requires higher rates of usage reporting, we recommend utilizing Events Based + * Components. * * ## Create Usage for Subscription * @@ -682,8 +687,8 @@ export class SubscriptionComponentsController extends BaseController { * * ## Price Point ID usage * - * If you are using price points, for metered and prepaid usage components, Chargify gives you the - * option to specify a price point in your request. + * If you are using price points, for metered and prepaid usage components, Advanced Billing gives you + * the option to specify a price point in your request. * * You do not need to specify a price point ID. If a price point is not included, the default price * point for the component will be used when the usage is recorded. @@ -731,8 +736,8 @@ export class SubscriptionComponentsController extends BaseController { * to record that a subscriber has sent both an SMS Message and an Email, send an API call for each. * * @param subscriptionId The Chargify id of the subscription - * @param componentId Either the Chargify id for the component or the component's - * handle prefixed by `handle:` + * @param componentId Either the Advanced Billing id for the component or the + * component's handle prefixed by `handle:` * @param body * @return Response from the API call */ @@ -784,8 +789,8 @@ export class SubscriptionComponentsController extends BaseController { * the unique identifier for the component you are working with. * * @param subscriptionId The Chargify id of the subscription - * @param componentId Either the Chargify id for the component or the component's - * handle prefixed by `handle:` + * @param componentId Either the Advanced Billing id for the component or the + * component's handle prefixed by `handle:` * @param sinceId Returns usages with an id greater than or equal to the one * specified * @param maxId Returns usages with an id less than or equal to the one @@ -856,30 +861,35 @@ export class SubscriptionComponentsController extends BaseController { * In order to bill your subscribers on your Events data under the Events-Based Billing feature, the * components must be activated for the subscriber. * - * Learn more about the role of activation in the [Events-Based Billing docs](https://chargify.zendesk. - * com/hc/en-us/articles/4407720810907#activating-components-for-subscribers). + * Learn more about the role of activation in the [Events-Based Billing docs](https://maxio.zendesk. + * com/hc/en-us/articles/24260323329805-Events-Based-Billing-Overview). * * Use this endpoint to activate an event-based component for a single subscription. Activating an - * event-based component causes Chargify to bill for events when the subscription is renewed. + * event-based component causes Advanced Billing to bill for events when the subscription is renewed. * * *Note: it is possible to stream events for a subscription at any time, regardless of component * activation status. The activation status only determines if the subscription should be billed for * event-based component usage at renewal.* * - * @param subscriptionId The Chargify id of the subscription - * @param componentId The Chargify id of the component + * @param subscriptionId The Advanced Billing id of the subscription + * @param componentId The Advanced Billing id of the component + * @param body * @return Response from the API call */ async activateEventBasedComponent( subscriptionId: number, componentId: number, + body?: ActivateEventBasedComponent, requestOptions?: RequestOptions ): Promise> { const req = this.createRequest('POST'); const mapped = req.prepareArgs({ subscriptionId: [subscriptionId, number()], componentId: [componentId, number()], + body: [body, optional(activateEventBasedComponentSchema)], }); + req.header('Content-Type', 'application/json'); + req.json(mapped.body); req.appendTemplatePath`/event_based_billing/subscriptions/${mapped.subscriptionId}/components/${mapped.componentId}/activate.json`; req.authenticate([{ basicAuth: true }]); return req.call(requestOptions); @@ -887,10 +897,10 @@ export class SubscriptionComponentsController extends BaseController { /** * Use this endpoint to deactivate an event-based component for a single subscription. Deactivating the - * event-based component causes Chargify to ignore related events at subscription renewal. + * event-based component causes Advanced Billing to ignore related events at subscription renewal. * - * @param subscriptionId The Chargify id of the subscription - * @param componentId The Chargify id of the component + * @param subscriptionId The Advanced Billing id of the subscription + * @param componentId The Advanced Billing id of the component * @return Response from the API call */ async deactivateEventBasedComponent( @@ -912,22 +922,22 @@ export class SubscriptionComponentsController extends BaseController { * ## Documentation * * Events-Based Billing is an evolved form of metered billing that is based on data-rich events - * streamed in real-time from your system to Chargify. + * streamed in real-time from your system to Advanced Billing. * * These events can then be transformed, enriched, or analyzed to form the computed totals of usage * charges billed to your customers. * - * This API allows you to stream events into the Chargify data ingestion engine. + * This API allows you to stream events into the Advanced Billing data ingestion engine. * - * Learn more about the feature in general in the [Events-Based Billing help docs](https://chargify. - * zendesk.com/hc/en-us/articles/4407720613403). + * Learn more about the feature in general in the [Events-Based Billing help docs](https://maxio. + * zendesk.com/hc/en-us/articles/24260323329805-Events-Based-Billing-Overview). * * ## Record Event * * Use this endpoint to record a single event. * - * *Note: this endpoint differs from the standard Chargify endpoints in that the URL subdomain will be - * `events` and your site subdomain will be included in the URL path. For example:* + * *Note: this endpoint differs from the standard Chargify API endpoints in that the URL subdomain will + * be `events` and your site subdomain will be included in the URL path. For example:* * * ``` * https://events.chargify.com/my-site-subdomain/events/my-stream-api-handle @@ -935,8 +945,8 @@ export class SubscriptionComponentsController extends BaseController { * * @param subdomain Your site's subdomain * @param apiHandle Identifies the Stream for which the event should be published. - * @param storeUid If you've attached your own Keen project as a Chargify event data-store, - * use this parameter to indicate the data-store. + * @param storeUid If you've attached your own Keen project as an Advanced Billing event data- + * store, use this parameter to indicate the data-store. * @param body * @return Response from the API call */ @@ -965,7 +975,7 @@ export class SubscriptionComponentsController extends BaseController { /** * Use this endpoint to record a collection of events. * - * *Note: this endpoint differs from the standard Chargify endpoints in that the subdomain will be + * *Note: this endpoint differs from the standard Chargify API endpoints in that the subdomain will be * `events` and your site subdomain will be included in the URL path.* * * A maximum of 1000 events can be published in a single request. A 422 will be returned if this limit @@ -973,8 +983,8 @@ export class SubscriptionComponentsController extends BaseController { * * @param subdomain Your site's subdomain * @param apiHandle Identifies the Stream for which the events should be published. - * @param storeUid If you've attached your own Keen project as a Chargify event data-store, use - * this parameter to indicate the data-store. + * @param storeUid If you've attached your own Keen project as an Advanced Billing event data- + * store, use this parameter to indicate the data-store. * @param body * @return Response from the API call */ diff --git a/src/controllers/subscriptionGroupInvoiceAccountController.ts b/src/controllers/subscriptionGroupInvoiceAccountController.ts index fb53126e..30efe975 100644 --- a/src/controllers/subscriptionGroupInvoiceAccountController.ts +++ b/src/controllers/subscriptionGroupInvoiceAccountController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/controllers/subscriptionGroupStatusController.ts b/src/controllers/subscriptionGroupStatusController.ts index 3541224e..7e3c80c4 100644 --- a/src/controllers/subscriptionGroupStatusController.ts +++ b/src/controllers/subscriptionGroupStatusController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/controllers/subscriptionGroupsController.ts b/src/controllers/subscriptionGroupsController.ts index e11510d1..ef9095c9 100644 --- a/src/controllers/subscriptionGroupsController.ts +++ b/src/controllers/subscriptionGroupsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -267,7 +267,8 @@ export class SubscriptionGroupsController extends BaseController { * * If the subscription is not in a group endpoint will return 404 code. * - * @param subscriptionId The Chargify id of the subscription associated with the subscription group + * @param subscriptionId The Advanced Billing id of the subscription associated with the subscription + * group * @return Response from the API call */ async findSubscriptionGroup( @@ -285,10 +286,10 @@ export class SubscriptionGroupsController extends BaseController { } /** - * For sites making use of the [Relationship Billing](https://chargify.zendesk.com/hc/en- - * us/articles/4407737494171) and [Customer Hierarchy](https://chargify.zendesk.com/hc/en- - * us/articles/4407746683291) features, it is possible to add existing subscriptions to subscription - * groups. + * For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en- + * us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https: + * //maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays#customer- + * hierarchies) features, it is possible to add existing subscriptions to subscription groups. * * Passing `group` parameters with a `target` containing a `type` and optional `id` is all that's * needed. When the `target` parameter specifies a `"customer"` or `"subscription"` that is already @@ -335,10 +336,10 @@ export class SubscriptionGroupsController extends BaseController { } /** - * For sites making use of the [Relationship Billing](https://chargify.zendesk.com/hc/en- - * us/articles/4407737494171) and [Customer Hierarchy](https://chargify.zendesk.com/hc/en- - * us/articles/4407746683291) features, it is possible to remove existing subscription from - * subscription group. + * For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en- + * us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https: + * //maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays#customer- + * hierarchies) features, it is possible to remove existing subscription from subscription group. * * @param subscriptionId The Chargify id of the subscription * @return Response from the API call diff --git a/src/controllers/subscriptionInvoiceAccountController.ts b/src/controllers/subscriptionInvoiceAccountController.ts index 7239568d..9fddc4a9 100644 --- a/src/controllers/subscriptionInvoiceAccountController.ts +++ b/src/controllers/subscriptionInvoiceAccountController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/controllers/subscriptionNotesController.ts b/src/controllers/subscriptionNotesController.ts index 36ba45b4..181c153e 100644 --- a/src/controllers/subscriptionNotesController.ts +++ b/src/controllers/subscriptionNotesController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -26,8 +26,8 @@ export class SubscriptionNotesController extends BaseController { * * If you have structured data such as birth date, color, etc., consider using Metadata instead. * - * Full documentation on how to use Notes in the Chargify UI can be located [here](https://maxio- - * chargify.zendesk.com/hc/en-us/articles/5404434903181-Subscription-Summary#notes). + * Full documentation on how to use Notes in the Advanced Billing UI can be located [here](https: + * //maxio.zendesk.com/hc/en-us/articles/24251712214413-Subscription-Summary-Overview). * * @param subscriptionId The Chargify id of the subscription * @param body @@ -99,7 +99,7 @@ export class SubscriptionNotesController extends BaseController { * note attached to a subscription. * * @param subscriptionId The Chargify id of the subscription - * @param noteId The Chargify id of the note + * @param noteId The Advanced Billing id of the note * @return Response from the API call */ async readSubscriptionNote( @@ -121,7 +121,7 @@ export class SubscriptionNotesController extends BaseController { * Use the following method to update a note for a Subscription. * * @param subscriptionId The Chargify id of the subscription - * @param noteId The Chargify id of the note + * @param noteId The Advanced Billing id of the note * @param body * @return Response from the API call */ @@ -148,7 +148,7 @@ export class SubscriptionNotesController extends BaseController { * Use the following method to delete a note for a Subscription. * * @param subscriptionId The Chargify id of the subscription - * @param noteId The Chargify id of the note + * @param noteId The Advanced Billing id of the note * @return Response from the API call */ async deleteSubscriptionNote( diff --git a/src/controllers/subscriptionProductsController.ts b/src/controllers/subscriptionProductsController.ts index 45810ca5..5bb6aec1 100644 --- a/src/controllers/subscriptionProductsController.ts +++ b/src/controllers/subscriptionProductsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -44,8 +44,9 @@ export class SubscriptionProductsController extends BaseController { * * ## Migrations Documentation * - * Full documentation on how to record Migrations in the Chargify UI can be located [here](https: - * //chargify.zendesk.com/hc/en-us/articles/4407898373531). + * Full documentation on how to record Migrations in the Advanced Billing UI can be located + * [here](https://maxio.zendesk.com/hc/en-us/articles/24181589372429-Data-Migration-to-Advanced- + * Billing). * * ## Failed Migrations * @@ -55,10 +56,10 @@ export class SubscriptionProductsController extends BaseController { * ## Migration 3D Secure - Stripe * * It may happen that a payment needs 3D Secure Authentication when the subscription is migrated to a - * new product; this is referred to in our help docs as a [post-authentication flow](https://maxio- - * chargify.zendesk.com/hc/en-us/articles/5405177432077#psd2-flows-pre-authentication-and-post- - * authentication). The server returns `422 Unprocessable Entity` in this case with the following - * response: + * new product; this is referred to in our help docs as a [post-authentication flow](https://maxio. + * zendesk.com/hc/en-us/articles/24176278996493-Testing-Implementing-3D-Secure#psd2-flows-pre- + * authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case + * with the following response: * * ```json * { diff --git a/src/controllers/subscriptionStatusController.ts b/src/controllers/subscriptionStatusController.ts index bd37a8b8..fb1b551b 100644 --- a/src/controllers/subscriptionStatusController.ts +++ b/src/controllers/subscriptionStatusController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -41,8 +41,8 @@ import { ErrorListResponseError } from '../errors/errorListResponseError'; export class SubscriptionStatusController extends BaseController { /** - * Chargify offers the ability to retry collecting the balance due on a past due Subscription without - * waiting for the next scheduled attempt. + * Advanced Billing offers the ability to retry collecting the balance due on a past due Subscription + * without waiting for the next scheduled attempt. * * ## Successful Reactivation * @@ -219,13 +219,13 @@ export class SubscriptionStatusController extends BaseController { } /** - * Chargify offers the ability to reactivate a previously canceled subscription. For details on how the - * reactivation works, and how to reactivate subscriptions through the application, see - * [reactivation](https://chargify.zendesk.com/hc/en-us/articles/4407898737691). + * Advanced Billing offers the ability to reactivate a previously canceled subscription. For details on + * how the reactivation works, and how to reactivate subscriptions through the application, see + * [reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming). * * **Please note: The term - * "resume" is used also during another process in Chargify. This occurs when an on-hold subscription - * is "resumed". This returns the subscription to an active state.** + * "resume" is used also during another process in Advanced Billing. This occurs when an on-hold + * subscription is "resumed". This returns the subscription to an active state.** * * + The response returns the subscription object in the `active` or `trialing` state. * + The `canceled_at` and `cancellation_message` fields do not have values. @@ -246,10 +246,10 @@ export class SubscriptionStatusController extends BaseController { * is then canceled on June 15. * * If a reactivation with `resume: true` were attempted _before_ what would have been the next billing - * date of July 1st, then Chargify would resume the subscription. + * date of July 1st, then Advanced Billing would resume the subscription. * * If a reactivation with `resume: true` were attempted _after_ what would have been the next billing - * date of July 1st, then Chargify would not resume the subscription, and instead it would be + * date of July 1st, then Advanced Billing would not resume the subscription, and instead it would be * reactivated with a new billing period. * * | Canceled | Reactivation | Resumable? | @@ -418,8 +418,8 @@ export class SubscriptionStatusController extends BaseController { } /** - * Chargify offers the ability to cancel a subscription at the end of the current billing period. This - * period is set by its current product. + * Advanced Billing offers the ability to cancel a subscription at the end of the current billing + * period. This period is set by its current product. * * Requesting to cancel the subscription at the end of the period sets the `cancel_at_end_of_period` * flag to true. @@ -500,8 +500,8 @@ export class SubscriptionStatusController extends BaseController { * snapshot of how much your customer will be charged on their next renewal. * * The "Next Billing" amount and "Next Billing" date are already represented in the UI on each - * Subscriber's Summary. For more information, please see our documentation [here](https://chargify. - * zendesk.com/hc/en-us/articles/4407884887835#next-billing). + * Subscriber's Summary. For more information, please see our documentation [here](https://maxio. + * zendesk.com/hc/en-us/articles/24252493695757-Subscriber-Interface-Overview). * * ## Optional Component Fields * diff --git a/src/controllers/subscriptionsController.ts b/src/controllers/subscriptionsController.ts index 6ddf28fb..d60c82da 100644 --- a/src/controllers/subscriptionsController.ts +++ b/src/controllers/subscriptionsController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -84,30 +84,30 @@ import { SubscriptionRemoveCouponErrorsError } from '../errors/subscriptionRemov export class SubscriptionsController extends BaseController { /** - * Full documentation on how subscriptions operate within Chargify can be located under the following - * topics: - * - * + [Subscriptions Reference](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405577172749- - * Subscription-Introduction) - * + [Subscriptions Actions](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405510556557- - * Actions) - * + [Subscription Cancellation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405510556557- - * Actions#initiate-cancellation) - * + [Subscription Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404559291021- + * Full documentation on how subscriptions operate within Advanced Billing can be located under the + * following topics: + * + * + [Subscriptions Reference](https://maxio.zendesk.com/hc/en-us/articles/24251526991757-Subscription- + * Overview) + * + [Subscriptions Actions](https://maxio.zendesk.com/hc/en-us/articles/24251983024653-Subscription- + * Actions-Overview) + * + [Subscription Cancellation](https://maxio.zendesk.com/hc/en-us/articles/24251957778829-Cancel- + * Subscriptions) + * + [Subscription Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629- * Reactivating-and-Resuming) - * + [Subscription Import](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404863655821-Imports) + * + [Subscription Import](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Imports) * * When creating a subscription, you must specify a product and a customer. Credit card details may be * required, depending on the options for the Product being subscribed ([see Product Options](https: - * //maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221#payment-method-settings)). + * //maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing)). * * The product may be specified by `product_id` or by `product_handle` (API Handle). In similar fashion, * to pass a particular product price point, you may either use `product_price_point_handle` or * `product_price_point_id`. * - * An existing customer may be specified by a `customer_id` (ID within Chargify) or a - * `customer_reference` (unique value within your app that you have shared with Chargify via the - * reference attribute on a customer). You may also pass in an existing payment profile for that + * An existing customer may be specified by a `customer_id` (ID within Advanced Billing) or a + * `customer_reference` (unique value within your app that you have shared with Advanced Billing via + * the reference attribute on a customer). You may also pass in an existing payment profile for that * customer with `payment_profile_id`. A new customer may be created by providing `customer_attributes`. * * Credit card details may be required, depending on the options for the product being subscribed. The @@ -120,24 +120,24 @@ export class SubscriptionsController extends BaseController { * * ## Taxable Subscriptions * - * If your intent is to charge your subscribers tax via [Avalara Taxes](https://maxio-chargify.zendesk. - * com/hc/en-us/articles/5405275711885-Avalara-VAT-Tax) or [Custom Taxes](https://maxio-chargify. - * zendesk.com/hc/en-us/articles/5405069041549-Custom-Taxes), there are a few considerations to be made - * regarding collecting subscription data. + * If your intent is to charge your subscribers tax via [Avalara Taxes](https://maxio.zendesk.com/hc/en- + * us/articles/24287043035661-Avalara-VAT-Tax) or [Custom Taxes](https://maxio.zendesk.com/hc/en- + * us/articles/24287044212749-Custom-Taxes), there are a few considerations to be made regarding + * collecting subscription data. * For subscribers to be eligible to be taxed, the following information for the `customer` object or * `payment_profile` object must by supplied: * - * + A subscription to a [taxable product](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405246782221-Product-Editing#tax-settings) - * + [Full valid billing or shipping address](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405356114317#full-address-required-for-taxable-subscriptions) to identify the tax - * locale - * + The portion of the address that houses the [state information](https://maxio-chargify.zendesk. - * com/hc/en-us/articles/5405356114317#required-state-format-for-taxable-subscriptions) of either - * adddress must adhere to the ISO standard of a 2-3 character limit/format. - * + The portion of the address that houses the [country information](https://maxio-chargify.zendesk. - * com/hc/en-us/articles/5405356114317#required-country-format-for-taxable-subscriptions) must adhere - * to the ISO standard of a 2 character limit/format. + * + A subscription to a [taxable product](https://maxio.zendesk.com/hc/en-us/articles/24261076617869- + * Product-Editing#tax-settings) + * + [Full valid billing or shipping address](https://maxio.zendesk.com/hc/en- + * us/articles/24287008131853-Advanced-Billing-Managed-Sales-Tax#full-address-required-for-taxable- + * subscriptions) to identify the tax locale + * + The portion of the address that houses the [state information](https://maxio.zendesk.com/hc/en- + * us/articles/24287008131853-Advanced-Billing-Managed-Sales-Tax#required-state-format-for-taxable- + * subscriptions) of either adddress must adhere to the ISO standard of a 2-3 character limit/format. + * + The portion of the address that houses the [country information](https://maxio.zendesk.com/hc/en- + * us/articles/24287008131853-Advanced-Billing-Managed-Sales-Tax#required-country-format-for-taxable- + * subscriptions) must adhere to the ISO standard of a 2 character limit/format. * * ## Subscription Request Examples * @@ -148,9 +148,9 @@ export class SubscriptionsController extends BaseController { * you are using a secure `chargify_token` generated by Chargify.js. * * The second section, "Passing Payment Information", will focus on passing payment information into - * Chargify. Please be aware that collecting and sending Chargify raw card details requires PCI - * compliance on your end; these examples are provided as guidance. If your business is not PCI - * compliant, we recommend using Chargify.js to collect credit cards or bank accounts. + * Advanced Billing. Please be aware that collecting and sending Advanced Billing raw card details + * requires PCI compliance on your end; these examples are provided as guidance. If your business + * is not PCI compliant, we recommend using Chargify.js to collect credit cards or bank accounts. * * # Subscription Customization * @@ -210,7 +210,7 @@ export class SubscriptionsController extends BaseController { * * ## Subscription with Chargify.js token * - * The `chargify_token` can be obtained using [chargify.js](https://developers.chargify. + * The `chargify_token` can be obtained using [Chargify.js](https://developers.chargify. * com/docs/developer-docs/ZG9jOjE0NjAzNDI0-overview). The token represents payment profile attributes * that were provided by the customer in their browser and stored at the payment gateway. * @@ -239,7 +239,7 @@ export class SubscriptionsController extends BaseController { * * If you already have a customer and card stored in your payment gateway, you may create a * subscription with a `vault_token`. Providing the last_four, card type and expiration date will - * allow the card to be displayed properly in the Chargify UI. + * allow the card to be displayed properly in the Advanced Billing UI. * * ```json * { @@ -382,8 +382,8 @@ export class SubscriptionsController extends BaseController { * * + [Payment Profiles via API for GoCardless](https://developers.chargify.com/docs/api- * docs/1f10a4f170405-create-payment-profile#gocardless) - * + [Full documentation on GoCardless](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404501889677) + * + [Full documentation on GoCardless](https://maxio.zendesk.com/hc/en-us/articles/24176159136909- + * GoCardless) * * + [Using Chargify.js with GoCardless - minimal example](https://developers.chargify. * com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-direct-debit-gocardless- @@ -448,8 +448,8 @@ export class SubscriptionsController extends BaseController { * * + [Payment Profiles via API for Stripe SEPA Direct Debit](https://developers.chargify.com/docs/api- * docs/1f10a4f170405-create-payment-profile#sepa-direct-debit) - * + [Full documentation on Stripe Direct Debit](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) + * + [Full documentation on Stripe Direct Debit](https://maxio.zendesk.com/hc/en- + * us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) * * + [Using Chargify.js with Stripe SEPA or BECS Direct Debit - minimal example](https://developers. * chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-sepa-or-becs-direct- @@ -484,8 +484,8 @@ export class SubscriptionsController extends BaseController { * * + [Payment Profiles via API for Stripe BECS Direct * Debit]($e/Payment%20Profiles/createPaymentProfile) - * + [Full documentation on Stripe Direct Debit](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) + * + [Full documentation on Stripe Direct Debit](https://maxio.zendesk.com/hc/en- + * us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) * * + [Using Chargify.js with Stripe SEPA, BECS or BACS Direct Debit - minimal example](page:development- * tools/chargify-js/examples#minimal-example-with-sepa-becs-or-bacs-direct-debit-stripe-gateway) @@ -519,8 +519,8 @@ export class SubscriptionsController extends BaseController { * * + [Payment Profiles via API for Stripe BACS Direct * Debit]($e/Payment%20Profiles/createPaymentProfile) - * + [Full documentation on Stripe Direct Debit](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit) + * + [Full documentation on Stripe Direct Debit](https://maxio.zendesk.com/hc/en- + * us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) * * + [Using Chargify.js with Stripe SEPA, BECS or BACS Direct Debit - minimal example](page:development- * tools/chargify-js/examples#minimal-example-with-sepa-becs-or-bacs-direct-debit-stripe-gateway) @@ -555,9 +555,10 @@ export class SubscriptionsController extends BaseController { * ## 3D Secure - Stripe * * It may happen that a payment needs 3D Secure Authentication when the subscription is created; this - * is referred to in our help docs as a [post-authentication flow](https://maxio-chargify.zendesk. - * com/hc/en-us/articles/5405177432077#psd2-flows-pre-authentication-and-post-authentication). The - * server returns `422 Unprocessable Entity` in this case with the following response: + * is referred to in our help docs as a [post-authentication flow](https://maxio.zendesk.com/hc/en- + * us/articles/24176278996493-Testing-Implementing-3D-Secure#psd2-flows-pre-authentication-and-post- + * authentication). The server returns `422 Unprocessable Entity` in this case with the following + * response: * * ```json * { @@ -603,9 +604,10 @@ export class SubscriptionsController extends BaseController { * ## 3D Secure - Checkout * * It may happen that a payment needs 3D Secure Authentication when the subscription is created; this - * is referred to in our help docs as a [post-authentication flow](https://maxio-chargify.zendesk. - * com/hc/en-us/articles/5405177432077#psd2-flows-pre-authentication-and-post-authentication). The - * server returns `422 Unprocessable Entity` in this case with the following response: + * is referred to in our help docs as a [post-authentication flow](https://maxio.zendesk.com/hc/en- + * us/articles/24176278996493-Testing-Implementing-3D-Secure#psd2-flows-pre-authentication-and-post- + * authentication). The server returns `422 Unprocessable Entity` in this case with the following + * response: * * ```json * { @@ -672,7 +674,7 @@ export class SubscriptionsController extends BaseController { * Subscriptions can be “imported” via the API to handle the following scenarios: * * + You already have existing subscriptions with specific start and renewal dates that you would like - * to import to Chargify + * to import to Advanced Billing * + You already have credit cards stored in your provider’s vault and you would like to create * subscriptions using those tokens * @@ -680,14 +682,14 @@ export class SubscriptionsController extends BaseController { * can create Subscriptions via the API just like you normally would, but using a few special * attributes. * - * Full documentation on how import Subscriptions using the **import tool** in the Chargify UI can be - * located [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404863655821#imports-0-0). + * Full documentation on how import Subscriptions using the **import tool** in the Advanced Billing UI + * can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Imports). * * ### Important Notices and Disclaimers regarding Imports * * Before performing a bulk import of subscriptions via the API, we suggest reading the [Subscriptions - * Import](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404863655821#important-notices-and- - * disclaimers) instructions to understand the repurcussions of a large import. + * Import](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Imports) instructions to + * understand the repurcussions of a large import. * * ### Subscription Input Attributes * @@ -711,8 +713,8 @@ export class SubscriptionsController extends BaseController { * ### Stripe ACH Imports * * If the bank account has already been verified, currently you will need to create the customer, - * create the payment profile in Chargify - setting verified=true, then create a subscription using the - * customer_id and payment_profile_id. + * create the payment profile in Advanced Billing - setting verified=true, then create a subscription + * using the customer_id and payment_profile_id. * * ### Webhooks During Import * @@ -787,11 +789,11 @@ export class SubscriptionsController extends BaseController { * * ### Subscription in a Customer Hierarchy * - * For sites making use of the [Relationship Billing](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405078794253-Introduction-to-Invoices) and [Customer Hierarchy](https://maxio-chargify. - * zendesk.com/hc/en-us/articles/5404900384141) features, it is possible to create subscriptions within - * a customer hierarchy. This can be achieved through the API by passing group parameters in the - * **Create Subscription** request. + * For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en- + * us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https: + * //maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays) features, it is + * possible to create subscriptions within a customer hierarchy. This can be achieved through the API + * by passing group parameters in the **Create Subscription** request. * * + The `group` parameters are optional and consist of the required `target` and optional `billing` * parameters. @@ -824,13 +826,14 @@ export class SubscriptionsController extends BaseController { * * ### Subscription in a Subscription Group * - * For sites making use of [Relationship Billing](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405078794253-Introduction-to-Invoices) it may be desireable to create a subscription as - * part of a [subscription group](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405577356173) - * in order to rely on [invoice consolidation](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404980119949). This can be achieved through the API by passing group parameters in the - * Create Subscription request. The `group` parameters are optional and consist of the required - * `target` and optional `billing` parameters. + * For sites making use of [Relationship Billing](https://maxio.zendesk.com/hc/en- + * us/articles/24252287829645-Advanced-Billing-Invoices-Overview) it may be desireable to create a + * subscription as part of a [subscription group](https://maxio.zendesk.com/hc/en- + * us/articles/24252172565005-Subscription-Groups-Overview) in order to rely on [invoice + * consolidation](https://maxio.zendesk.com/hc/en-us/articles/24252269909389-Invoice-Consolidation). + * This can be achieved through the API by passing group parameters in the Create Subscription request. + * The `group` parameters are optional and consist of the required `target` and optional `billing` + * parameters. * * The `target` parameters specify an existing subscription with which the newly created subscription * should be grouped. If the target subscription is already part of a group, the new subscription will @@ -1080,7 +1083,7 @@ export class SubscriptionsController extends BaseController { req.query('end_date', mapped.endDate); req.query('start_datetime', mapped.startDatetime); req.query('end_datetime', mapped.endDatetime); - req.query(mapped.metadata); + req.query('metadata', mapped.metadata); req.query('direction', mapped.direction); req.query('sort', mapped.sort); req.query('include', mapped.include, unindexedPrefix); @@ -1220,15 +1223,16 @@ export class SubscriptionsController extends BaseController { * automatically. Some of the fields can be set via the normal Subscriptions Update API, but others can * only be set using this endpoint. * - * This endpoint is provided for cases where you need to “align” Chargify data with data that happened - * in your system, perhaps before you started using Chargify. For example, you may choose to import - * your historical subscription data, and would like the activation and cancellation dates in Chargify - * to match your existing historical dates. Chargify does not backfill historical events (i.e. from the - * Events API), but some static data can be changed via this API. + * This endpoint is provided for cases where you need to “align” Advanced Billing data with data that + * happened in your system, perhaps before you started using Advanced Billing. For example, you may + * choose to import your historical subscription data, and would like the activation and cancellation + * dates in Advanced Billing to match your existing historical dates. Advanced Billing does not + * backfill historical events (i.e. from the Events API), but some static data can be changed via this + * API. * * Why are some fields only settable from this endpoint, and not the normal subscription create and * update endpoints? Because we want users of this endpoint to be aware that these fields are usually - * managed by Chargify, and using this API means **you are stepping out on your own.** + * managed by Advanced Billing, and using this API means **you are stepping out on your own.** * * Changing these fields will not affect any other attributes. For example, adding an expiration date * will not affect the next assessment date on the subscription. @@ -1364,8 +1368,8 @@ export class SubscriptionsController extends BaseController { * subscription creation. * * The "Next Billing" amount and "Next Billing" date are represented in each Subscriber's Summary. For - * more information, please see our documentation [here](https://chargify.zendesk.com/hc/en- - * us/articles/4407884887835#next-billing). + * more information, please see our documentation [here](https://maxio.zendesk.com/hc/en- + * us/articles/24252493695757-Subscriber-Interface-Overview). * * ## Side effects * @@ -1383,15 +1387,14 @@ export class SubscriptionsController extends BaseController { * tax * * For more information about creating taxable previews, please see our documentation guide on how to - * create [taxable subscriptions.](https://chargify.zendesk.com/hc/en- - * us/articles/4407904217755#creating-taxable-subscriptions) + * create [taxable subscriptions.](https://maxio.zendesk.com/hc/en-us/sections/24287012349325-Taxes) * * You do **not** need to include a card number to generate tax information when you are previewing a * subscription. However, please note that when you actually want to create the subscription, you must - * include the credit card information if you want the billing address to be stored in Chargify. The - * billing address and the credit card information are stored together within the payment profile - * object. Also, you may not send a billing address to Chargify without payment profile information, as - * the address is stored on the card. + * include the credit card information if you want the billing address to be stored in Advanced Billing. + * The billing address and the credit card information are stored together within the payment profile + * object. Also, you may not send a billing address to Advanced Billing without payment profile + * information, as the address is stored on the card. * * You can pass shipping and billing addresses and still decide not to calculate taxes. To do that, * pass `skip_billing_manifest_taxes: true` attribute. @@ -1421,8 +1424,8 @@ export class SubscriptionsController extends BaseController { /** * An existing subscription can accommodate multiple discounts/coupon codes. This is only applicable if * each coupon is stackable. For more information on stackable coupons, we recommend reviewing our - * [coupon documentation.](https://chargify.zendesk.com/hc/en-us/articles/4407755909531#stackable- - * coupons) + * [coupon documentation.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and- + * Subscriptions#stackability-rules) * * ## Query Parameters vs Request Body Parameters * @@ -1468,8 +1471,8 @@ export class SubscriptionsController extends BaseController { * Use this endpoint to remove a coupon from an existing subscription. * * For more information on the expected behaviour of removing a coupon from a subscription, please see - * our documentation [here.](https://chargify.zendesk.com/hc/en-us/articles/4407896488987#removing-a- - * coupon) + * our documentation [here.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and- + * Subscriptions#removing-a-coupon) * * @param subscriptionId The Chargify id of the subscription * @param couponCode The coupon code @@ -1498,21 +1501,21 @@ export class SubscriptionsController extends BaseController { } /** - * Chargify offers the ability to activate awaiting signup and trialing subscriptions. This feature is - * only available on the Relationship Invoicing architecture. Subscriptions in a group may not be - * activated immediately. + * Advanced Billing offers the ability to activate awaiting signup and trialing subscriptions. This + * feature is only available on the Relationship Invoicing architecture. Subscriptions in a group may + * not be activated immediately. * * For details on how the activation works, and how to activate subscriptions through the application, * see [activation](#). * * The `revert_on_failure` parameter controls the behavior upon activation failure. - * - If set to `true` and something goes wrong i.e. payment fails, then Chargify will not change the - * subscription's state. The subscription’s billing period will also remain the same. - * - If set to `false` and something goes wrong i.e. payment fails, then Chargify will continue through - * with the activation and enter an end of life state. For trialing subscriptions, that will either be - * trial ended (if the trial is no obligation), past due (if the trial has an obligation), or canceled - * (if the site has no dunning strategy, or has a strategy that says to cancel immediately). For - * awaiting signup subscriptions, that will always be canceled. + * - If set to `true` and something goes wrong i.e. payment fails, then Advanced Billing will not + * change the subscription's state. The subscription’s billing period will also remain the same. + * - If set to `false` and something goes wrong i.e. payment fails, then Advanced Billing will continue + * through with the activation and enter an end of life state. For trialing subscriptions, that will + * either be trial ended (if the trial is no obligation), past due (if the trial has an obligation), or + * canceled (if the site has no dunning strategy, or has a strategy that says to cancel immediately). + * For awaiting signup subscriptions, that will always be canceled. * * The default activation failure behavior can be configured per activation attempt, or you may set a * default value under Config > Settings > Subscription Activation Settings. @@ -1547,8 +1550,8 @@ export class SubscriptionsController extends BaseController { * * ### Activate Trialing subscription * - * You can read more about the behavior of trialing subscriptions [here](https://maxio-chargify.zendesk. - * com/hc/en-us/articles/5404494617357#trialing-subscriptions-0-0). + * You can read more about the behavior of trialing subscriptions [here](https://maxio.zendesk. + * com/hc/en-us/articles/24252155721869-Trialing-Subscriptions). * When the `revert_on_failure` parameter is set to `true`, the subscription's state will remain as * Trialing, we will void the invoice from activation and return any prepayments and credits applied to * the invoice back to the subscription. diff --git a/src/controllers/webhooksController.ts b/src/controllers/webhooksController.ts index eb30bb6f..cf9ccefe 100644 --- a/src/controllers/webhooksController.ts +++ b/src/controllers/webhooksController.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -49,18 +49,18 @@ export class WebhooksController extends BaseController { * groups of webhooks. Webhooks will be sent on endpoints specified by you. Endpoints can be added via * API or Web UI. There is also an option to enable / disable webhooks via API request. * - * We recommend that you review Chargify's webhook documentation located in our help site. The - * following resources will help guide you on how to use webhooks in Chargify, in addition to these - * webhook endpoints: + * We recommend that you review Advanced Billing's webhook documentation located in our help site. The + * following resources will help guide you on how to use webhooks in Advanced Billing, in addition to + * these webhook endpoints: * - * + [Adding/editing new webhooks](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5404448450317#configure-webhook-url) - * + [Webhooks introduction and delivery information](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405568068365#webhooks-introduction-0-0) - * + [Main webhook overview](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405357509645- - * Webhooks-Reference#webhooks-reference-0-0) - * + [Available webhooks and payloads](https://maxio-chargify.zendesk.com/hc/en- - * us/articles/5405357509645-Webhooks-Reference#events) + * + [Adding/editing new webhooks](https://maxio.zendesk.com/hc/en-us/articles/24286723085197- + * Webhooks#configure-webhook-url) + * + [Webhooks introduction and delivery information](https://maxio.zendesk.com/hc/en- + * us/articles/24266143173901-Webhooks-Overview) + * + [Main webhook reference](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks- + * Reference) + * + [Available webhooks and payloads](https://maxio.zendesk.com/hc/en-us/articles/24266136649869- + * Webhooks-Reference#events) * * ## List Webhooks for a Site * @@ -82,7 +82,7 @@ export class WebhooksController extends BaseController { * value is 20. The maximum allowed values is 200; any per_page value over 200 * will be changed to 200. Use in query `per_page=200`. * @param order The order in which the Webhooks are returned. - * @param subscription The Chargify id of a subscription you'd like to filter for + * @param subscription The Advanced Billing id of a subscription you'd like to filter for * @return Response from the API call */ async listWebhooks( @@ -174,8 +174,7 @@ export class WebhooksController extends BaseController { * (events) to it. * * You can check available events here. - * [Event keys](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405357509645-Webhooks- - * Reference#example-payloads) + * [Event keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-Reference#events) * * @param body * @return Response from the API call @@ -217,8 +216,8 @@ export class WebhooksController extends BaseController { * You can update an Endpoint via the API with a PUT request to the resource endpoint. * * You can change the `url` of your endpoint which consumes webhooks or list of `webhook_subscriptions`. - * Check available [Event keys](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404448450317- - * Webhooks#configure-webhook-url). + * Check available [Event keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks- + * Reference#events). * * Always send a complete list of events which you want subscribe/watch. * Sending an PUT request for existing endpoint with empty list of `webhook_subscriptions` will end @@ -227,8 +226,8 @@ export class WebhooksController extends BaseController { * If you want unsubscribe from specific event, just send a list of `webhook_subscriptions` without the * specific event key. * - * @param endpointId The Chargify id for the endpoint that should be - * updated + * @param endpointId The Advanced Billing id for the endpoint that should + * be updated * @param body * @return Response from the API call */ diff --git a/src/core.ts b/src/core.ts index ce390d58..7b1d325e 100644 --- a/src/core.ts +++ b/src/core.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/defaultConfiguration.ts b/src/defaultConfiguration.ts index 1d3f7d49..887871e7 100644 --- a/src/defaultConfiguration.ts +++ b/src/defaultConfiguration.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/componentAllocationError.ts b/src/errors/componentAllocationError.ts index d4abad9b..dc21fa3c 100644 --- a/src/errors/componentAllocationError.ts +++ b/src/errors/componentAllocationError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/componentPricePointError.ts b/src/errors/componentPricePointError.ts index 452cdc11..594432a6 100644 --- a/src/errors/componentPricePointError.ts +++ b/src/errors/componentPricePointError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/customerErrorResponseError.ts b/src/errors/customerErrorResponseError.ts index 1b65dcfd..4d98769f 100644 --- a/src/errors/customerErrorResponseError.ts +++ b/src/errors/customerErrorResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/errorArrayMapResponseError.ts b/src/errors/errorArrayMapResponseError.ts index e0250020..b0ab4b6e 100644 --- a/src/errors/errorArrayMapResponseError.ts +++ b/src/errors/errorArrayMapResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/errorListResponseError.ts b/src/errors/errorListResponseError.ts index 11d840c2..1c2303a7 100644 --- a/src/errors/errorListResponseError.ts +++ b/src/errors/errorListResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/errorStringMapResponseError.ts b/src/errors/errorStringMapResponseError.ts index 3f755b64..8dea5658 100644 --- a/src/errors/errorStringMapResponseError.ts +++ b/src/errors/errorStringMapResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/eventBasedBillingListSegmentsErrorsError.ts b/src/errors/eventBasedBillingListSegmentsErrorsError.ts index 82719daa..23c4b2e4 100644 --- a/src/errors/eventBasedBillingListSegmentsErrorsError.ts +++ b/src/errors/eventBasedBillingListSegmentsErrorsError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/eventBasedBillingSegmentError.ts b/src/errors/eventBasedBillingSegmentError.ts index afcdb30b..1ab8afda 100644 --- a/src/errors/eventBasedBillingSegmentError.ts +++ b/src/errors/eventBasedBillingSegmentError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/eventBasedBillingSegmentErrorsError.ts b/src/errors/eventBasedBillingSegmentErrorsError.ts index 4b7d212a..966debbd 100644 --- a/src/errors/eventBasedBillingSegmentErrorsError.ts +++ b/src/errors/eventBasedBillingSegmentErrorsError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/productPricePointErrorResponseError.ts b/src/errors/productPricePointErrorResponseError.ts index c65bd996..a22b53be 100644 --- a/src/errors/productPricePointErrorResponseError.ts +++ b/src/errors/productPricePointErrorResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/proformaBadRequestErrorResponseError.ts b/src/errors/proformaBadRequestErrorResponseError.ts index aa83d758..9cea97ae 100644 --- a/src/errors/proformaBadRequestErrorResponseError.ts +++ b/src/errors/proformaBadRequestErrorResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/refundPrepaymentBaseErrorsResponseError.ts b/src/errors/refundPrepaymentBaseErrorsResponseError.ts index a6413c1d..8fee6485 100644 --- a/src/errors/refundPrepaymentBaseErrorsResponseError.ts +++ b/src/errors/refundPrepaymentBaseErrorsResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/singleErrorResponseError.ts b/src/errors/singleErrorResponseError.ts index 071c5261..c39f5525 100644 --- a/src/errors/singleErrorResponseError.ts +++ b/src/errors/singleErrorResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/singleStringErrorResponseError.ts b/src/errors/singleStringErrorResponseError.ts index df913767..16c79d60 100644 --- a/src/errors/singleStringErrorResponseError.ts +++ b/src/errors/singleStringErrorResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/subscriptionAddCouponError.ts b/src/errors/subscriptionAddCouponError.ts index acc8ecbb..02c93db9 100644 --- a/src/errors/subscriptionAddCouponError.ts +++ b/src/errors/subscriptionAddCouponError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/subscriptionComponentAllocationError.ts b/src/errors/subscriptionComponentAllocationError.ts index 3afefeed..adf03345 100644 --- a/src/errors/subscriptionComponentAllocationError.ts +++ b/src/errors/subscriptionComponentAllocationError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/subscriptionGroupCreateErrorResponseError.ts b/src/errors/subscriptionGroupCreateErrorResponseError.ts index c8cb2c44..eb06533a 100644 --- a/src/errors/subscriptionGroupCreateErrorResponseError.ts +++ b/src/errors/subscriptionGroupCreateErrorResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/subscriptionGroupSignupErrorResponseError.ts b/src/errors/subscriptionGroupSignupErrorResponseError.ts index 0d815aaa..e7f57af7 100644 --- a/src/errors/subscriptionGroupSignupErrorResponseError.ts +++ b/src/errors/subscriptionGroupSignupErrorResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/subscriptionGroupUpdateErrorResponseError.ts b/src/errors/subscriptionGroupUpdateErrorResponseError.ts index a1ea2327..c8c5be48 100644 --- a/src/errors/subscriptionGroupUpdateErrorResponseError.ts +++ b/src/errors/subscriptionGroupUpdateErrorResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/subscriptionRemoveCouponErrorsError.ts b/src/errors/subscriptionRemoveCouponErrorsError.ts index bb768cf3..abd12216 100644 --- a/src/errors/subscriptionRemoveCouponErrorsError.ts +++ b/src/errors/subscriptionRemoveCouponErrorsError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/subscriptionsMrrErrorResponseError.ts b/src/errors/subscriptionsMrrErrorResponseError.ts index e6a9ccd3..896d7e13 100644 --- a/src/errors/subscriptionsMrrErrorResponseError.ts +++ b/src/errors/subscriptionsMrrErrorResponseError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/errors/tooManyManagementLinkRequestsError.ts b/src/errors/tooManyManagementLinkRequestsError.ts index 0eb3a8b0..c1b511ea 100644 --- a/src/errors/tooManyManagementLinkRequestsError.ts +++ b/src/errors/tooManyManagementLinkRequestsError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/index.ts b/src/index.ts index 0f5d1474..16ea03b2 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -74,6 +74,7 @@ export * from './errors/tooManyManagementLinkRequestsError'; export type { AccountBalance } from './models/accountBalance'; export type { AccountBalances } from './models/accountBalances'; export type { ACHAgreement } from './models/aCHAgreement'; +export type { ActivateEventBasedComponent } from './models/activateEventBasedComponent'; export type { ActivateSubscriptionRequest } from './models/activateSubscriptionRequest'; export type { AddCouponsRequest } from './models/addCouponsRequest'; export type { AddressChange } from './models/addressChange'; @@ -90,6 +91,9 @@ export { AllocationPreviewLineItemKind } from './models/allocationPreviewLineIte export type { AllocationPreviewResponse } from './models/allocationPreviewResponse'; export type { AllocationResponse } from './models/allocationResponse'; export type { AllocationSettings } from './models/allocationSettings'; +export { AllVaults } from './models/allVaults'; +export type { ApplePayPaymentProfile } from './models/applePayPaymentProfile'; +export { ApplePayVault } from './models/applePayVault'; export type { AppliedCreditNoteData } from './models/appliedCreditNoteData'; export type { ApplyCreditNoteEvent } from './models/applyCreditNoteEvent'; export type { ApplyCreditNoteEventData } from './models/applyCreditNoteEventData'; @@ -242,6 +246,7 @@ export type { CreateUsageRequest } from './models/createUsageRequest'; export type { CreditAccountBalanceChanged } from './models/creditAccountBalanceChanged'; export type { CreditCardAttributes } from './models/creditCardAttributes'; export type { CreditCardPaymentProfile } from './models/creditCardPaymentProfile'; +export { CreditCardVault } from './models/creditCardVault'; export type { CreditNote } from './models/creditNote'; export type { CreditNoteApplication } from './models/creditNoteApplication'; export type { CreditNoteLineItem } from './models/creditNoteLineItem'; @@ -252,7 +257,6 @@ export { CreditType } from './models/creditType'; export type { CurrencyPrice } from './models/currencyPrice'; export { CurrencyPriceRole } from './models/currencyPriceRole'; export type { CurrencyPricesResponse } from './models/currencyPricesResponse'; -export { CurrentVault } from './models/currentVault'; export type { Customer } from './models/customer'; export type { CustomerAttributes } from './models/customerAttributes'; export type { CustomerChange } from './models/customerChange'; @@ -286,7 +290,7 @@ export type { Event } from './models/event'; export type { EventBasedBillingSegmentError } from './models/eventBasedBillingSegmentError'; export type { EventResponse } from './models/eventResponse'; export { EventType } from './models/eventType'; -export { ExtendedIntervalUnit } from './models/extendedIntervalUnit'; +export { ExpirationIntervalUnit } from './models/expirationIntervalUnit'; export { FailedPaymentAction } from './models/failedPaymentAction'; export type { FailedPaymentEvent } from './models/failedPaymentEvent'; export type { FailedPaymentEventData } from './models/failedPaymentEventData'; @@ -433,6 +437,8 @@ export type { PaymentProfileAttributes } from './models/paymentProfileAttributes export type { PaymentProfileResponse } from './models/paymentProfileResponse'; export type { PaymentRelatedEvents } from './models/paymentRelatedEvents'; export { PaymentType } from './models/paymentType'; +export type { PaypalPaymentProfile } from './models/paypalPaymentProfile'; +export { PayPalVault } from './models/payPalVault'; export type { PendingCancellationChange } from './models/pendingCancellationChange'; export type { PortalManagementLink } from './models/portalManagementLink'; export type { PrepaidComponentPricePoint } from './models/prepaidComponentPricePoint'; @@ -695,9 +701,9 @@ export * from './models/containers/listUsagesInputComponentId'; export * from './models/containers/metafieldEnum'; export * from './models/containers/meteredComponentUnitPrice'; export * from './models/containers/onOffComponentUnitPrice'; +export * from './models/containers/paymentProfile'; export * from './models/containers/paymentProfileAttributesExpirationMonth'; export * from './models/containers/paymentProfileAttributesExpirationYear'; -export * from './models/containers/paymentProfileResponsePaymentProfile'; export * from './models/containers/prepaidUsageComponentUnitPrice'; export * from './models/containers/priceEndingQuantity'; export * from './models/containers/priceStartingQuantity'; diff --git a/src/models/aCHAgreement.ts b/src/models/aCHAgreement.ts index 52d1f92c..fb913879 100644 --- a/src/models/aCHAgreement.ts +++ b/src/models/aCHAgreement.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/accountBalance.ts b/src/models/accountBalance.ts index ae055dbe..c892177d 100644 --- a/src/models/accountBalance.ts +++ b/src/models/accountBalance.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/accountBalances.ts b/src/models/accountBalances.ts index 6fd10cb9..c2a1d49e 100644 --- a/src/models/accountBalances.ts +++ b/src/models/accountBalances.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/activateEventBasedComponent.ts b/src/models/activateEventBasedComponent.ts new file mode 100644 index 00000000..2fb47c27 --- /dev/null +++ b/src/models/activateEventBasedComponent.ts @@ -0,0 +1,36 @@ +/** + * AdvancedBilling + * + * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). + */ + +import { expandoObject, lazy, number, optional, Schema } from '../schema'; +import { BillingSchedule, billingScheduleSchema } from './billingSchedule'; +import { + ComponentCustomPrice, + componentCustomPriceSchema, +} from './componentCustomPrice'; + +export interface ActivateEventBasedComponent { + /** The Chargify id of the price point */ + pricePointId?: number; + /** This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. Please note this only works for site with Multifrequency enabled */ + billingSchedule?: BillingSchedule; + /** Create or update custom pricing unique to the subscription. Used in place of `price_point_id`. */ + customPrice?: ComponentCustomPrice; + [key: string]: unknown; +} + +export const activateEventBasedComponentSchema: Schema = expandoObject( + { + pricePointId: ['price_point_id', optional(number())], + billingSchedule: [ + 'billing_schedule', + optional(lazy(() => billingScheduleSchema)), + ], + customPrice: [ + 'custom_price', + optional(lazy(() => componentCustomPriceSchema)), + ], + } +); diff --git a/src/models/activateSubscriptionRequest.ts b/src/models/activateSubscriptionRequest.ts index a6b44b75..fdcad3ba 100644 --- a/src/models/activateSubscriptionRequest.ts +++ b/src/models/activateSubscriptionRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/addCouponsRequest.ts b/src/models/addCouponsRequest.ts index f0dc5707..c3efe75b 100644 --- a/src/models/addCouponsRequest.ts +++ b/src/models/addCouponsRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/addSubscriptionToAGroup.ts b/src/models/addSubscriptionToAGroup.ts index c3c4e1a5..8428fff6 100644 --- a/src/models/addSubscriptionToAGroup.ts +++ b/src/models/addSubscriptionToAGroup.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/addressChange.ts b/src/models/addressChange.ts index eebb8373..14d7997d 100644 --- a/src/models/addressChange.ts +++ b/src/models/addressChange.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/agreementAcceptance.ts b/src/models/agreementAcceptance.ts index 45c70fb6..24e64648 100644 --- a/src/models/agreementAcceptance.ts +++ b/src/models/agreementAcceptance.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/currentVault.ts b/src/models/allVaults.ts similarity index 70% rename from src/models/currentVault.ts rename to src/models/allVaults.ts index 1421eb7f..b841dc65 100644 --- a/src/models/currentVault.ts +++ b/src/models/allVaults.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -7,41 +7,46 @@ import { Schema, stringEnum } from '../schema'; /** - * Enum for CurrentVault + * Enum for AllVaults */ -export enum CurrentVault { +export enum AllVaults { Adyen = 'adyen', Authorizenet = 'authorizenet', - Avalara = 'avalara', Beanstream = 'beanstream', BlueSnap = 'blue_snap', Bogus = 'bogus', + Braintree1 = 'braintree1', BraintreeBlue = 'braintree_blue', Checkout = 'checkout', Cybersource = 'cybersource', Elavon = 'elavon', Eway = 'eway', + EwayRapid = 'eway_rapid', EwayRapidStd = 'eway_rapid_std', Firstdata = 'firstdata', Forte = 'forte', Gocardless = 'gocardless', Litle = 'litle', MaxioPayments = 'maxio_payments', + Maxp = 'maxp', Moduslink = 'moduslink', Moneris = 'moneris', Nmi = 'nmi', Orbital = 'orbital', PaymentExpress = 'payment_express', + Paymill = 'paymill', + Paypal = 'paypal', + PaypalComplete = 'paypal_complete', Pin = 'pin', Square = 'square', + Stripe = 'stripe', StripeConnect = 'stripe_connect', TrustCommerce = 'trust_commerce', Unipaas = 'unipaas', + Wirecard = 'wirecard', } /** - * Schema for CurrentVault + * Schema for AllVaults */ -export const currentVaultSchema: Schema = stringEnum( - CurrentVault -); +export const allVaultsSchema: Schema = stringEnum(AllVaults); diff --git a/src/models/allocateComponents.ts b/src/models/allocateComponents.ts index 5f45f5ad..40d10b0b 100644 --- a/src/models/allocateComponents.ts +++ b/src/models/allocateComponents.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/allocation.ts b/src/models/allocation.ts index abef33e3..49a5ac12 100644 --- a/src/models/allocation.ts +++ b/src/models/allocation.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -59,7 +59,7 @@ export interface Allocation { /** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; previousPricePointId?: number; /** If the change in cost is an upgrade, this determines if the charge should accrue to the next renewal or if capture should be attempted immediately. */ accrueCharge?: boolean; @@ -104,7 +104,7 @@ export const allocationSchema: Schema = expandoObject({ pricePointName: ['price_point_name', optional(string())], pricePointHandle: ['price_point_handle', optional(string())], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], previousPricePointId: ['previous_price_point_id', optional(number())], accrueCharge: ['accrue_charge', optional(boolean())], initiateDunning: ['initiate_dunning', optional(boolean())], diff --git a/src/models/allocationExpirationDate.ts b/src/models/allocationExpirationDate.ts index 58f3cfdc..087519bd 100644 --- a/src/models/allocationExpirationDate.ts +++ b/src/models/allocationExpirationDate.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/allocationPreview.ts b/src/models/allocationPreview.ts index 4f105c2e..cec3d353 100644 --- a/src/models/allocationPreview.ts +++ b/src/models/allocationPreview.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/allocationPreviewDirection.ts b/src/models/allocationPreviewDirection.ts index 03bc67d1..5d59fdc6 100644 --- a/src/models/allocationPreviewDirection.ts +++ b/src/models/allocationPreviewDirection.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/allocationPreviewItem.ts b/src/models/allocationPreviewItem.ts index d9e682dc..eea113d2 100644 --- a/src/models/allocationPreviewItem.ts +++ b/src/models/allocationPreviewItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -48,7 +48,7 @@ export interface AllocationPreviewItem { /** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; previousPricePointId?: number; pricePointHandle?: string; pricePointName?: string; @@ -77,7 +77,7 @@ export const allocationPreviewItemSchema: Schema = expand downgradeCredit: ['downgrade_credit', optional(nullable(creditTypeSchema))], pricePointId: ['price_point_id', optional(number())], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], previousPricePointId: ['previous_price_point_id', optional(number())], pricePointHandle: ['price_point_handle', optional(string())], pricePointName: ['price_point_name', optional(string())], diff --git a/src/models/allocationPreviewLineItem.ts b/src/models/allocationPreviewLineItem.ts index 0285b24d..10bedd93 100644 --- a/src/models/allocationPreviewLineItem.ts +++ b/src/models/allocationPreviewLineItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/allocationPreviewLineItemKind.ts b/src/models/allocationPreviewLineItemKind.ts index a2edd3c0..8ebb9822 100644 --- a/src/models/allocationPreviewLineItemKind.ts +++ b/src/models/allocationPreviewLineItemKind.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/allocationPreviewResponse.ts b/src/models/allocationPreviewResponse.ts index b360cdb8..45ee7957 100644 --- a/src/models/allocationPreviewResponse.ts +++ b/src/models/allocationPreviewResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/allocationResponse.ts b/src/models/allocationResponse.ts index 57f2acdd..7bbdff70 100644 --- a/src/models/allocationResponse.ts +++ b/src/models/allocationResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/allocationSettings.ts b/src/models/allocationSettings.ts index 5c00cd21..b9f9f6cb 100644 --- a/src/models/allocationSettings.ts +++ b/src/models/allocationSettings.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/applePayPaymentProfile.ts b/src/models/applePayPaymentProfile.ts new file mode 100644 index 00000000..55cc8790 --- /dev/null +++ b/src/models/applePayPaymentProfile.ts @@ -0,0 +1,72 @@ +/** + * AdvancedBilling + * + * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). + */ + +import { + expandoObject, + nullable, + number, + optional, + Schema, + string, +} from '../schema'; +import { ApplePayVault, applePayVaultSchema } from './applePayVault'; +import { PaymentType, paymentTypeSchema } from './paymentType'; + +export interface ApplePayPaymentProfile { + /** The Chargify-assigned ID of the Apple Pay payment profile. */ + id?: number; + /** The first name of the Apple Pay account holder */ + firstName?: string; + /** The last name of the Apple Pay account holder */ + lastName?: string; + /** The Chargify-assigned id for the customer record to which the Apple Pay account belongs */ + customerId?: number; + /** The vault that stores the payment profile with the provided vault_token. */ + currentVault?: ApplePayVault; + /** The “token” provided by your vault storage for an already stored payment profile */ + vaultToken?: string; + /** The current billing street address for the Apple Pay account */ + billingAddress?: string | null; + /** The current billing address city for the Apple Pay account */ + billingCity?: string | null; + /** The current billing address state for the Apple Pay account */ + billingState?: string | null; + /** The current billing address zip code for the Apple Pay account */ + billingZip?: string | null; + /** The current billing address country for the Apple Pay account */ + billingCountry?: string | null; + customerVaultToken?: string | null; + /** The current billing street address, second line, for the Apple Pay account */ + billingAddress2?: string | null; + paymentType: PaymentType; + siteGatewaySettingId?: number | null; + gatewayHandle?: string | null; + [key: string]: unknown; +} + +export const applePayPaymentProfileSchema: Schema = expandoObject( + { + id: ['id', optional(number())], + firstName: ['first_name', optional(string())], + lastName: ['last_name', optional(string())], + customerId: ['customer_id', optional(number())], + currentVault: ['current_vault', optional(applePayVaultSchema)], + vaultToken: ['vault_token', optional(string())], + billingAddress: ['billing_address', optional(nullable(string()))], + billingCity: ['billing_city', optional(nullable(string()))], + billingState: ['billing_state', optional(nullable(string()))], + billingZip: ['billing_zip', optional(nullable(string()))], + billingCountry: ['billing_country', optional(nullable(string()))], + customerVaultToken: ['customer_vault_token', optional(nullable(string()))], + billingAddress2: ['billing_address_2', optional(nullable(string()))], + paymentType: ['payment_type', paymentTypeSchema], + siteGatewaySettingId: [ + 'site_gateway_setting_id', + optional(nullable(number())), + ], + gatewayHandle: ['gateway_handle', optional(nullable(string()))], + } +); diff --git a/src/models/applePayVault.ts b/src/models/applePayVault.ts new file mode 100644 index 00000000..4b5842b3 --- /dev/null +++ b/src/models/applePayVault.ts @@ -0,0 +1,21 @@ +/** + * AdvancedBilling + * + * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). + */ + +import { Schema, stringEnum } from '../schema'; + +/** + * Enum for ApplePayVault + */ +export enum ApplePayVault { + BraintreeBlue = 'braintree_blue', +} + +/** + * Schema for ApplePayVault + */ +export const applePayVaultSchema: Schema = stringEnum( + ApplePayVault +); diff --git a/src/models/appliedCreditNoteData.ts b/src/models/appliedCreditNoteData.ts index 3a52889b..eb593f78 100644 --- a/src/models/appliedCreditNoteData.ts +++ b/src/models/appliedCreditNoteData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/applyCreditNoteEvent.ts b/src/models/applyCreditNoteEvent.ts index bbb8de7a..1489fa80 100644 --- a/src/models/applyCreditNoteEvent.ts +++ b/src/models/applyCreditNoteEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/applyCreditNoteEventData.ts b/src/models/applyCreditNoteEventData.ts index 66a5e9d7..c88d0225 100644 --- a/src/models/applyCreditNoteEventData.ts +++ b/src/models/applyCreditNoteEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/applyDebitNoteEvent.ts b/src/models/applyDebitNoteEvent.ts index 41328d1e..01401c1a 100644 --- a/src/models/applyDebitNoteEvent.ts +++ b/src/models/applyDebitNoteEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/applyDebitNoteEventData.ts b/src/models/applyDebitNoteEventData.ts index 1f8eec63..f73aa419 100644 --- a/src/models/applyDebitNoteEventData.ts +++ b/src/models/applyDebitNoteEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/applyPaymentEvent.ts b/src/models/applyPaymentEvent.ts index 7fb1d520..df94b257 100644 --- a/src/models/applyPaymentEvent.ts +++ b/src/models/applyPaymentEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/applyPaymentEventData.ts b/src/models/applyPaymentEventData.ts index c7b85fbc..7f3c7ee6 100644 --- a/src/models/applyPaymentEventData.ts +++ b/src/models/applyPaymentEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/attributeError.ts b/src/models/attributeError.ts index 14062595..06655e75 100644 --- a/src/models/attributeError.ts +++ b/src/models/attributeError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/autoInvite.ts b/src/models/autoInvite.ts index 4c2d906d..3e4e8204 100644 --- a/src/models/autoInvite.ts +++ b/src/models/autoInvite.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/autoResume.ts b/src/models/autoResume.ts index e405e8b5..8703b483 100644 --- a/src/models/autoResume.ts +++ b/src/models/autoResume.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/backportInvoiceEvent.ts b/src/models/backportInvoiceEvent.ts index 1dd6b125..0b6e545c 100644 --- a/src/models/backportInvoiceEvent.ts +++ b/src/models/backportInvoiceEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bankAccountAttributes.ts b/src/models/bankAccountAttributes.ts index 56d6bab0..a7b76b1c 100644 --- a/src/models/bankAccountAttributes.ts +++ b/src/models/bankAccountAttributes.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -30,7 +30,7 @@ export interface BankAccountAttributes { /** Defaults to personal */ bankAccountHolderType?: BankAccountHolderType; paymentType?: PaymentType; - /** The vault that stores the payment profile with the provided vault_token. */ + /** The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. */ currentVault?: BankAccountVault; vaultToken?: string; /** (only for Authorize.Net CIM storage or Square) The customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token */ diff --git a/src/models/bankAccountHolderType.ts b/src/models/bankAccountHolderType.ts index fd19527d..9518b423 100644 --- a/src/models/bankAccountHolderType.ts +++ b/src/models/bankAccountHolderType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bankAccountPaymentProfile.ts b/src/models/bankAccountPaymentProfile.ts index 70df25ed..e27c37f9 100644 --- a/src/models/bankAccountPaymentProfile.ts +++ b/src/models/bankAccountPaymentProfile.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -30,7 +30,7 @@ export interface BankAccountPaymentProfile { lastName?: string; /** The Chargify-assigned id for the customer record to which the bank account belongs */ customerId?: number; - /** The vault that stores the payment profile with the provided vault_token. */ + /** The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. */ currentVault?: BankAccountVault; /** The “token” provided by your vault storage for an already stored payment profile */ vaultToken?: string; @@ -51,14 +51,14 @@ export interface BankAccountPaymentProfile { /** The bank where the account resides */ bankName?: string; /** A string representation of the stored bank routing number with all but the last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’). payment_type will be bank_account */ - maskedBankRoutingNumber: string; + maskedBankRoutingNumber?: string; /** A string representation of the stored bank account number with all but the last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’) */ maskedBankAccountNumber: string; /** Defaults to checking */ bankAccountType?: BankAccountType; /** Defaults to personal */ bankAccountHolderType?: BankAccountHolderType; - paymentType?: PaymentType; + paymentType: PaymentType; /** denotes whether a bank account has been verified by providing the amounts of two small deposits made into the account */ verified?: boolean; siteGatewaySettingId?: number | null; @@ -82,14 +82,14 @@ export const bankAccountPaymentProfileSchema: Schema customerVaultToken: ['customer_vault_token', optional(nullable(string()))], billingAddress2: ['billing_address_2', optional(nullable(string()))], bankName: ['bank_name', optional(string())], - maskedBankRoutingNumber: ['masked_bank_routing_number', string()], + maskedBankRoutingNumber: ['masked_bank_routing_number', optional(string())], maskedBankAccountNumber: ['masked_bank_account_number', string()], bankAccountType: ['bank_account_type', optional(bankAccountTypeSchema)], bankAccountHolderType: [ 'bank_account_holder_type', optional(bankAccountHolderTypeSchema), ], - paymentType: ['payment_type', optional(paymentTypeSchema)], + paymentType: ['payment_type', paymentTypeSchema], verified: ['verified', optional(boolean())], siteGatewaySettingId: [ 'site_gateway_setting_id', diff --git a/src/models/bankAccountResponse.ts b/src/models/bankAccountResponse.ts index aa81d1dd..a239abea 100644 --- a/src/models/bankAccountResponse.ts +++ b/src/models/bankAccountResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bankAccountType.ts b/src/models/bankAccountType.ts index 9fa8920e..b58ea1ad 100644 --- a/src/models/bankAccountType.ts +++ b/src/models/bankAccountType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bankAccountVault.ts b/src/models/bankAccountVault.ts index e1476939..cc535a36 100644 --- a/src/models/bankAccountVault.ts +++ b/src/models/bankAccountVault.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -10,11 +10,14 @@ import { Schema, stringEnum } from '../schema'; * Enum for BankAccountVault */ export enum BankAccountVault { - Bogus = 'bogus', Authorizenet = 'authorizenet', - StripeConnect = 'stripe_connect', - BraintreeBlue = 'braintree_blue', + BlueSnap = 'blue_snap', + Bogus = 'bogus', + Forte = 'forte', Gocardless = 'gocardless', + MaxioPayments = 'maxio_payments', + Maxp = 'maxp', + StripeConnect = 'stripe_connect', } /** diff --git a/src/models/bankAccountVerification.ts b/src/models/bankAccountVerification.ts index d3fafdcf..8e9a2626 100644 --- a/src/models/bankAccountVerification.ts +++ b/src/models/bankAccountVerification.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bankAccountVerificationRequest.ts b/src/models/bankAccountVerificationRequest.ts index 269a24b1..464855c1 100644 --- a/src/models/bankAccountVerificationRequest.ts +++ b/src/models/bankAccountVerificationRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/baseRefundError.ts b/src/models/baseRefundError.ts index e97635cc..71511292 100644 --- a/src/models/baseRefundError.ts +++ b/src/models/baseRefundError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/baseStringError.ts b/src/models/baseStringError.ts index 3ac22d6f..b8b8b07b 100644 --- a/src/models/baseStringError.ts +++ b/src/models/baseStringError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/basicDateField.ts b/src/models/basicDateField.ts index 2f451c0d..2638199e 100644 --- a/src/models/basicDateField.ts +++ b/src/models/basicDateField.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/batchJob.ts b/src/models/batchJob.ts index b41efca0..98ce5c37 100644 --- a/src/models/batchJob.ts +++ b/src/models/batchJob.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/batchJobResponse.ts b/src/models/batchJobResponse.ts index 3c897275..7fd7a206 100644 --- a/src/models/batchJobResponse.ts +++ b/src/models/batchJobResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/billingManifest.ts b/src/models/billingManifest.ts index 7405cc70..eef6cf7c 100644 --- a/src/models/billingManifest.ts +++ b/src/models/billingManifest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/billingManifestItem.ts b/src/models/billingManifestItem.ts index 9c5e3218..df352945 100644 --- a/src/models/billingManifestItem.ts +++ b/src/models/billingManifestItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/billingManifestLineItemKind.ts b/src/models/billingManifestLineItemKind.ts index 8d6694d9..bd3f92e7 100644 --- a/src/models/billingManifestLineItemKind.ts +++ b/src/models/billingManifestLineItemKind.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/billingSchedule.ts b/src/models/billingSchedule.ts index 39a27929..31dca6d4 100644 --- a/src/models/billingSchedule.ts +++ b/src/models/billingSchedule.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/breakouts.ts b/src/models/breakouts.ts index a5c2082e..5b5948d4 100644 --- a/src/models/breakouts.ts +++ b/src/models/breakouts.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bulkComponentsPricePointAssignment.ts b/src/models/bulkComponentsPricePointAssignment.ts index 6f60cac5..a06480d0 100644 --- a/src/models/bulkComponentsPricePointAssignment.ts +++ b/src/models/bulkComponentsPricePointAssignment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bulkCreateProductPricePointsRequest.ts b/src/models/bulkCreateProductPricePointsRequest.ts index d9c89ded..6d2ceb8e 100644 --- a/src/models/bulkCreateProductPricePointsRequest.ts +++ b/src/models/bulkCreateProductPricePointsRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bulkCreateProductPricePointsResponse.ts b/src/models/bulkCreateProductPricePointsResponse.ts index c3aab2c3..9dffd852 100644 --- a/src/models/bulkCreateProductPricePointsResponse.ts +++ b/src/models/bulkCreateProductPricePointsResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bulkCreateSegments.ts b/src/models/bulkCreateSegments.ts index 65e18a49..9b0374f3 100644 --- a/src/models/bulkCreateSegments.ts +++ b/src/models/bulkCreateSegments.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bulkUpdateSegments.ts b/src/models/bulkUpdateSegments.ts index 4583b77d..d0af008e 100644 --- a/src/models/bulkUpdateSegments.ts +++ b/src/models/bulkUpdateSegments.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/bulkUpdateSegmentsItem.ts b/src/models/bulkUpdateSegmentsItem.ts index 71f8221f..49d0c577 100644 --- a/src/models/bulkUpdateSegmentsItem.ts +++ b/src/models/bulkUpdateSegmentsItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/calendarBilling.ts b/src/models/calendarBilling.ts index 7596f437..96dc32b8 100644 --- a/src/models/calendarBilling.ts +++ b/src/models/calendarBilling.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/cancelGroupedSubscriptionsRequest.ts b/src/models/cancelGroupedSubscriptionsRequest.ts index a5a983e3..3bff6d2e 100644 --- a/src/models/cancelGroupedSubscriptionsRequest.ts +++ b/src/models/cancelGroupedSubscriptionsRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/cancellationMethod.ts b/src/models/cancellationMethod.ts index 3bf104fa..cc5bc259 100644 --- a/src/models/cancellationMethod.ts +++ b/src/models/cancellationMethod.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/cancellationOptions.ts b/src/models/cancellationOptions.ts index b1f79c77..e87f8c3b 100644 --- a/src/models/cancellationOptions.ts +++ b/src/models/cancellationOptions.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/cancellationRequest.ts b/src/models/cancellationRequest.ts index 273958c3..a478d0f7 100644 --- a/src/models/cancellationRequest.ts +++ b/src/models/cancellationRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/cardType.ts b/src/models/cardType.ts index af1cd096..b7d17d10 100644 --- a/src/models/cardType.ts +++ b/src/models/cardType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/changeChargebackStatusEvent.ts b/src/models/changeChargebackStatusEvent.ts index 0f467c32..eae248aa 100644 --- a/src/models/changeChargebackStatusEvent.ts +++ b/src/models/changeChargebackStatusEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/changeChargebackStatusEventData.ts b/src/models/changeChargebackStatusEventData.ts index ad2009ec..d66f6292 100644 --- a/src/models/changeChargebackStatusEventData.ts +++ b/src/models/changeChargebackStatusEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/changeInvoiceCollectionMethodEvent.ts b/src/models/changeInvoiceCollectionMethodEvent.ts index 900e01fb..af64ce84 100644 --- a/src/models/changeInvoiceCollectionMethodEvent.ts +++ b/src/models/changeInvoiceCollectionMethodEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/changeInvoiceCollectionMethodEventData.ts b/src/models/changeInvoiceCollectionMethodEventData.ts index b497fab4..c881ce98 100644 --- a/src/models/changeInvoiceCollectionMethodEventData.ts +++ b/src/models/changeInvoiceCollectionMethodEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/changeInvoiceStatusEvent.ts b/src/models/changeInvoiceStatusEvent.ts index 49dc48eb..4e5a59c4 100644 --- a/src/models/changeInvoiceStatusEvent.ts +++ b/src/models/changeInvoiceStatusEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/changeInvoiceStatusEventData.ts b/src/models/changeInvoiceStatusEventData.ts index 4c24887a..24eb26bd 100644 --- a/src/models/changeInvoiceStatusEventData.ts +++ b/src/models/changeInvoiceStatusEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -17,9 +17,9 @@ export interface ChangeInvoiceStatusEventData { gatewayTransId?: string; /** The monetary value associated with the linked payment, expressed in dollars. */ amount?: string; - /** The status of the invoice before any changes occurred. See [Invoice Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices#invoice-statuses) for more. */ + /** The status of the invoice before any changes occurred. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. */ fromStatus: InvoiceStatus; - /** The updated status of the invoice after changes have been made. See [Invoice Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices#invoice-statuses) for more. */ + /** The updated status of the invoice after changes have been made. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. */ toStatus: InvoiceStatus; consolidationLevel?: InvoiceConsolidationLevel; [key: string]: unknown; diff --git a/src/models/chargebackStatus.ts b/src/models/chargebackStatus.ts index 8a0a4960..f6512155 100644 --- a/src/models/chargebackStatus.ts +++ b/src/models/chargebackStatus.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/chargifyEBB.ts b/src/models/chargifyEBB.ts index acc7c65f..deb4ead2 100644 --- a/src/models/chargifyEBB.ts +++ b/src/models/chargifyEBB.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/cleanupScope.ts b/src/models/cleanupScope.ts index d44f37fa..73872842 100644 --- a/src/models/cleanupScope.ts +++ b/src/models/cleanupScope.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/collectionMethod.ts b/src/models/collectionMethod.ts index a6744678..2837205f 100644 --- a/src/models/collectionMethod.ts +++ b/src/models/collectionMethod.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/component.ts b/src/models/component.ts index 99d99d37..c6d32888 100644 --- a/src/models/component.ts +++ b/src/models/component.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -91,7 +91,7 @@ export interface Component { /** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; [key: string]: unknown; } @@ -147,5 +147,5 @@ export const componentSchema: Schema = expandoObject({ optional(number()), ], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], }); diff --git a/src/models/componentAllocationChange.ts b/src/models/componentAllocationChange.ts index 15e08bd6..e041d1dc 100644 --- a/src/models/componentAllocationChange.ts +++ b/src/models/componentAllocationChange.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentAllocationErrorItem.ts b/src/models/componentAllocationErrorItem.ts index 60742308..84161a71 100644 --- a/src/models/componentAllocationErrorItem.ts +++ b/src/models/componentAllocationErrorItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentCostData.ts b/src/models/componentCostData.ts index 2181bfd5..d1996683 100644 --- a/src/models/componentCostData.ts +++ b/src/models/componentCostData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentCostDataRateTier.ts b/src/models/componentCostDataRateTier.ts index e3427abd..8cd368d9 100644 --- a/src/models/componentCostDataRateTier.ts +++ b/src/models/componentCostDataRateTier.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentCurrencyPrice.ts b/src/models/componentCurrencyPrice.ts index 9033e339..d8829f33 100644 --- a/src/models/componentCurrencyPrice.ts +++ b/src/models/componentCurrencyPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentCurrencyPricesResponse.ts b/src/models/componentCurrencyPricesResponse.ts index c27784e2..5ff860d9 100644 --- a/src/models/componentCurrencyPricesResponse.ts +++ b/src/models/componentCurrencyPricesResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentCustomPrice.ts b/src/models/componentCustomPrice.ts index 518bcd55..fc4bfc24 100644 --- a/src/models/componentCustomPrice.ts +++ b/src/models/componentCustomPrice.ts @@ -1,13 +1,15 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { array, + boolean, expandoObject, lazy, + nullable, number, optional, Schema, @@ -18,22 +20,25 @@ import { PricingScheme, pricingSchemeSchema } from './pricingScheme'; /** Create or update custom pricing unique to the subscription. Used in place of `price_point_id`. */ export interface ComponentCustomPrice { + /** Whether or not the price point includes tax */ + taxIncluded?: boolean; /** Omit for On/Off components */ pricingScheme?: PricingScheme; /** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; /** On/off components only need one price bracket starting at 1 */ - prices?: Price[]; + prices: Price[]; [key: string]: unknown; } export const componentCustomPriceSchema: Schema = expandoObject( { + taxIncluded: ['tax_included', optional(boolean())], pricingScheme: ['pricing_scheme', optional(pricingSchemeSchema)], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], - prices: ['prices', optional(array(lazy(() => priceSchema)))], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], + prices: ['prices', array(lazy(() => priceSchema))], } ); diff --git a/src/models/componentKind.ts b/src/models/componentKind.ts index 2e02990e..fedc2233 100644 --- a/src/models/componentKind.ts +++ b/src/models/componentKind.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentPrice.ts b/src/models/componentPrice.ts index 8e3c7af1..40ea41de 100644 --- a/src/models/componentPrice.ts +++ b/src/models/componentPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentPricePoint.ts b/src/models/componentPricePoint.ts index 7825ef05..155ea016 100644 --- a/src/models/componentPricePoint.ts +++ b/src/models/componentPricePoint.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentPricePointAssignment.ts b/src/models/componentPricePointAssignment.ts index 28c874c2..c21d03a2 100644 --- a/src/models/componentPricePointAssignment.ts +++ b/src/models/componentPricePointAssignment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentPricePointErrorItem.ts b/src/models/componentPricePointErrorItem.ts index 3201ff89..eb92b4ad 100644 --- a/src/models/componentPricePointErrorItem.ts +++ b/src/models/componentPricePointErrorItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentPricePointItem.ts b/src/models/componentPricePointItem.ts index 2b4a9979..7b9de74e 100644 --- a/src/models/componentPricePointItem.ts +++ b/src/models/componentPricePointItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -8,6 +8,7 @@ import { array, expandoObject, lazy, + nullable, number, optional, Schema, @@ -25,7 +26,7 @@ export interface ComponentPricePointItem { /** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; prices?: Price[]; [key: string]: unknown; } @@ -36,7 +37,7 @@ export const componentPricePointItemSchema: Schema = ex handle: ['handle', optional(string())], pricingScheme: ['pricing_scheme', optional(pricingSchemeSchema)], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], prices: ['prices', optional(array(lazy(() => priceSchema)))], } ); diff --git a/src/models/componentPricePointResponse.ts b/src/models/componentPricePointResponse.ts index 306fdcdb..59993601 100644 --- a/src/models/componentPricePointResponse.ts +++ b/src/models/componentPricePointResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentPricePointsResponse.ts b/src/models/componentPricePointsResponse.ts index 9a5f9d8e..f2579a4c 100644 --- a/src/models/componentPricePointsResponse.ts +++ b/src/models/componentPricePointsResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/componentResponse.ts b/src/models/componentResponse.ts index ceb1eae8..12c9db2d 100644 --- a/src/models/componentResponse.ts +++ b/src/models/componentResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/compoundingStrategy.ts b/src/models/compoundingStrategy.ts index f24dfcaf..c7d84653 100644 --- a/src/models/compoundingStrategy.ts +++ b/src/models/compoundingStrategy.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/consolidatedInvoice.ts b/src/models/consolidatedInvoice.ts index d009a2ab..39b93437 100644 --- a/src/models/consolidatedInvoice.ts +++ b/src/models/consolidatedInvoice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/addSubscriptionToAGroupGroup.ts b/src/models/containers/addSubscriptionToAGroupGroup.ts index 2405de5e..abb8f617 100644 --- a/src/models/containers/addSubscriptionToAGroupGroup.ts +++ b/src/models/containers/addSubscriptionToAGroupGroup.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/allocationPreviewItemPreviousQuantity.ts b/src/models/containers/allocationPreviewItemPreviousQuantity.ts index 230e8801..f6254566 100644 --- a/src/models/containers/allocationPreviewItemPreviousQuantity.ts +++ b/src/models/containers/allocationPreviewItemPreviousQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/allocationPreviewItemQuantity.ts b/src/models/containers/allocationPreviewItemQuantity.ts index cdc9ffa7..df3cf6c5 100644 --- a/src/models/containers/allocationPreviewItemQuantity.ts +++ b/src/models/containers/allocationPreviewItemQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/allocationPreviousQuantity.ts b/src/models/containers/allocationPreviousQuantity.ts index 16ab6b95..9540df7c 100644 --- a/src/models/containers/allocationPreviousQuantity.ts +++ b/src/models/containers/allocationPreviousQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/allocationQuantity.ts b/src/models/containers/allocationQuantity.ts index 5fc4932c..91be56e1 100644 --- a/src/models/containers/allocationQuantity.ts +++ b/src/models/containers/allocationQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/archiveComponentPricePointComponentId.ts b/src/models/containers/archiveComponentPricePointComponentId.ts index 1959002b..79bb39de 100644 --- a/src/models/containers/archiveComponentPricePointComponentId.ts +++ b/src/models/containers/archiveComponentPricePointComponentId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/archiveComponentPricePointPricePointId.ts b/src/models/containers/archiveComponentPricePointPricePointId.ts index d5a3c242..0ec7aaf9 100644 --- a/src/models/containers/archiveComponentPricePointPricePointId.ts +++ b/src/models/containers/archiveComponentPricePointPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/archiveProductPricePointPricePointId.ts b/src/models/containers/archiveProductPricePointPricePointId.ts index 61d6dda8..44517f48 100644 --- a/src/models/containers/archiveProductPricePointPricePointId.ts +++ b/src/models/containers/archiveProductPricePointPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/archiveProductPricePointProductId.ts b/src/models/containers/archiveProductPricePointProductId.ts index 6eb7ee5f..b04158cc 100644 --- a/src/models/containers/archiveProductPricePointProductId.ts +++ b/src/models/containers/archiveProductPricePointProductId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/calendarBillingSnapDay.ts b/src/models/containers/calendarBillingSnapDay.ts index 7b8f37a4..c7036a7a 100644 --- a/src/models/containers/calendarBillingSnapDay.ts +++ b/src/models/containers/calendarBillingSnapDay.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/componentAllocationChangeAllocatedQuantity.ts b/src/models/containers/componentAllocationChangeAllocatedQuantity.ts index 9dce9593..724ec5a1 100644 --- a/src/models/containers/componentAllocationChangeAllocatedQuantity.ts +++ b/src/models/containers/componentAllocationChangeAllocatedQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/componentPricePointAssignmentPricePoint.ts b/src/models/containers/componentPricePointAssignmentPricePoint.ts index c9d88963..15bea503 100644 --- a/src/models/containers/componentPricePointAssignmentPricePoint.ts +++ b/src/models/containers/componentPricePointAssignmentPricePoint.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createAllocationPricePointId.ts b/src/models/containers/createAllocationPricePointId.ts index 78f3e95c..2b15a8d1 100644 --- a/src/models/containers/createAllocationPricePointId.ts +++ b/src/models/containers/createAllocationPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createComponentPricePointRequestPricePoint.ts b/src/models/containers/createComponentPricePointRequestPricePoint.ts index e83ea586..db675229 100644 --- a/src/models/containers/createComponentPricePointRequestPricePoint.ts +++ b/src/models/containers/createComponentPricePointRequestPricePoint.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createComponentPricePointsRequestPricePoints.ts b/src/models/containers/createComponentPricePointsRequestPricePoints.ts index 8aeb02af..f5435ee1 100644 --- a/src/models/containers/createComponentPricePointsRequestPricePoints.ts +++ b/src/models/containers/createComponentPricePointsRequestPricePoints.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createInvoiceCouponAmount.ts b/src/models/containers/createInvoiceCouponAmount.ts index f60edb97..db351989 100644 --- a/src/models/containers/createInvoiceCouponAmount.ts +++ b/src/models/containers/createInvoiceCouponAmount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createInvoiceCouponPercentage.ts b/src/models/containers/createInvoiceCouponPercentage.ts index 0364ad3e..640cffca 100644 --- a/src/models/containers/createInvoiceCouponPercentage.ts +++ b/src/models/containers/createInvoiceCouponPercentage.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createInvoiceCouponProductFamilyId.ts b/src/models/containers/createInvoiceCouponProductFamilyId.ts index bd991494..65cd2b1a 100644 --- a/src/models/containers/createInvoiceCouponProductFamilyId.ts +++ b/src/models/containers/createInvoiceCouponProductFamilyId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createInvoiceItemComponentId.ts b/src/models/containers/createInvoiceItemComponentId.ts index 35f4f69d..34d91584 100644 --- a/src/models/containers/createInvoiceItemComponentId.ts +++ b/src/models/containers/createInvoiceItemComponentId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createInvoiceItemPricePointId.ts b/src/models/containers/createInvoiceItemPricePointId.ts index 16bec3da..6bff4c4d 100644 --- a/src/models/containers/createInvoiceItemPricePointId.ts +++ b/src/models/containers/createInvoiceItemPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createInvoiceItemProductId.ts b/src/models/containers/createInvoiceItemProductId.ts index a47e57b6..bf073923 100644 --- a/src/models/containers/createInvoiceItemProductId.ts +++ b/src/models/containers/createInvoiceItemProductId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createInvoiceItemProductPricePointId.ts b/src/models/containers/createInvoiceItemProductPricePointId.ts index e4f8b0b8..71fec18a 100644 --- a/src/models/containers/createInvoiceItemProductPricePointId.ts +++ b/src/models/containers/createInvoiceItemProductPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createInvoiceItemQuantity.ts b/src/models/containers/createInvoiceItemQuantity.ts index 5e7ad082..b554a079 100644 --- a/src/models/containers/createInvoiceItemQuantity.ts +++ b/src/models/containers/createInvoiceItemQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createInvoiceItemUnitPrice.ts b/src/models/containers/createInvoiceItemUnitPrice.ts index f2f41a18..50323047 100644 --- a/src/models/containers/createInvoiceItemUnitPrice.ts +++ b/src/models/containers/createInvoiceItemUnitPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createInvoicePaymentAmount.ts b/src/models/containers/createInvoicePaymentAmount.ts index 6611a7d1..43d1ab0d 100644 --- a/src/models/containers/createInvoicePaymentAmount.ts +++ b/src/models/containers/createInvoicePaymentAmount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createMetafieldsRequestMetafields.ts b/src/models/containers/createMetafieldsRequestMetafields.ts index 0ec74081..1f255f17 100644 --- a/src/models/containers/createMetafieldsRequestMetafields.ts +++ b/src/models/containers/createMetafieldsRequestMetafields.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createMultiInvoicePaymentAmount.ts b/src/models/containers/createMultiInvoicePaymentAmount.ts index f104ccca..9774b5ed 100644 --- a/src/models/containers/createMultiInvoicePaymentAmount.ts +++ b/src/models/containers/createMultiInvoicePaymentAmount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createOrUpdateCouponCoupon.ts b/src/models/containers/createOrUpdateCouponCoupon.ts index 9bf0e225..fec45962 100644 --- a/src/models/containers/createOrUpdateCouponCoupon.ts +++ b/src/models/containers/createOrUpdateCouponCoupon.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createOrUpdatePercentageCouponPercentage.ts b/src/models/containers/createOrUpdatePercentageCouponPercentage.ts index c5906dd0..09270e55 100644 --- a/src/models/containers/createOrUpdatePercentageCouponPercentage.ts +++ b/src/models/containers/createOrUpdatePercentageCouponPercentage.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createOrUpdateSegmentPriceUnitPrice.ts b/src/models/containers/createOrUpdateSegmentPriceUnitPrice.ts index 9b28357f..42e9dccc 100644 --- a/src/models/containers/createOrUpdateSegmentPriceUnitPrice.ts +++ b/src/models/containers/createOrUpdateSegmentPriceUnitPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createPaymentProfileExpirationMonth.ts b/src/models/containers/createPaymentProfileExpirationMonth.ts index 992f0ebf..d4a31276 100644 --- a/src/models/containers/createPaymentProfileExpirationMonth.ts +++ b/src/models/containers/createPaymentProfileExpirationMonth.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createPaymentProfileExpirationYear.ts b/src/models/containers/createPaymentProfileExpirationYear.ts index 1c592d19..c68e9ba9 100644 --- a/src/models/containers/createPaymentProfileExpirationYear.ts +++ b/src/models/containers/createPaymentProfileExpirationYear.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createProductPricePointProductId.ts b/src/models/containers/createProductPricePointProductId.ts index 4349ea6a..19a42d81 100644 --- a/src/models/containers/createProductPricePointProductId.ts +++ b/src/models/containers/createProductPricePointProductId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createSegmentSegmentProperty1Value.ts b/src/models/containers/createSegmentSegmentProperty1Value.ts index 17ee0cf4..443fc2f8 100644 --- a/src/models/containers/createSegmentSegmentProperty1Value.ts +++ b/src/models/containers/createSegmentSegmentProperty1Value.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createSegmentSegmentProperty2Value.ts b/src/models/containers/createSegmentSegmentProperty2Value.ts index a1c143b3..dbd40d49 100644 --- a/src/models/containers/createSegmentSegmentProperty2Value.ts +++ b/src/models/containers/createSegmentSegmentProperty2Value.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createSegmentSegmentProperty3Value.ts b/src/models/containers/createSegmentSegmentProperty3Value.ts index 85ff0a7f..f2289c68 100644 --- a/src/models/containers/createSegmentSegmentProperty3Value.ts +++ b/src/models/containers/createSegmentSegmentProperty3Value.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createSegmentSegmentProperty4Value.ts b/src/models/containers/createSegmentSegmentProperty4Value.ts index 0979aa38..86f7f01e 100644 --- a/src/models/containers/createSegmentSegmentProperty4Value.ts +++ b/src/models/containers/createSegmentSegmentProperty4Value.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createSubscriptionComponentAllocatedQuantity.ts b/src/models/containers/createSubscriptionComponentAllocatedQuantity.ts index 346e9934..a7c4daff 100644 --- a/src/models/containers/createSubscriptionComponentAllocatedQuantity.ts +++ b/src/models/containers/createSubscriptionComponentAllocatedQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createSubscriptionComponentComponentId.ts b/src/models/containers/createSubscriptionComponentComponentId.ts index fd5d1ee7..3424ff30 100644 --- a/src/models/containers/createSubscriptionComponentComponentId.ts +++ b/src/models/containers/createSubscriptionComponentComponentId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createSubscriptionComponentPricePointId.ts b/src/models/containers/createSubscriptionComponentPricePointId.ts index a3f7f89a..5e54ae74 100644 --- a/src/models/containers/createSubscriptionComponentPricePointId.ts +++ b/src/models/containers/createSubscriptionComponentPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createSubscriptionOfferId.ts b/src/models/containers/createSubscriptionOfferId.ts index 549f11bc..c021329d 100644 --- a/src/models/containers/createSubscriptionOfferId.ts +++ b/src/models/containers/createSubscriptionOfferId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/createUsageComponentId.ts b/src/models/containers/createUsageComponentId.ts index 52e9abd3..3d2695cc 100644 --- a/src/models/containers/createUsageComponentId.ts +++ b/src/models/containers/createUsageComponentId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/customerErrorResponseErrors.ts b/src/models/containers/customerErrorResponseErrors.ts index 91f9e2e2..99ef10e4 100644 --- a/src/models/containers/customerErrorResponseErrors.ts +++ b/src/models/containers/customerErrorResponseErrors.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/deductServiceCreditAmount.ts b/src/models/containers/deductServiceCreditAmount.ts index 6b1b4288..9dd89ce1 100644 --- a/src/models/containers/deductServiceCreditAmount.ts +++ b/src/models/containers/deductServiceCreditAmount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/eBBComponentUnitPrice.ts b/src/models/containers/eBBComponentUnitPrice.ts index ffca8e10..75f42f0b 100644 --- a/src/models/containers/eBBComponentUnitPrice.ts +++ b/src/models/containers/eBBComponentUnitPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/eventEventSpecificData.ts b/src/models/containers/eventEventSpecificData.ts index 24020e74..ff631033 100644 --- a/src/models/containers/eventEventSpecificData.ts +++ b/src/models/containers/eventEventSpecificData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/invoiceEvent.ts b/src/models/containers/invoiceEvent.ts index 8bf1ccf1..bd0a376f 100644 --- a/src/models/containers/invoiceEvent.ts +++ b/src/models/containers/invoiceEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/invoiceEventPayment.ts b/src/models/containers/invoiceEventPayment.ts index 3002bb20..d5014263 100644 --- a/src/models/containers/invoiceEventPayment.ts +++ b/src/models/containers/invoiceEventPayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/issueServiceCreditAmount.ts b/src/models/containers/issueServiceCreditAmount.ts index fc4812fd..52e98848 100644 --- a/src/models/containers/issueServiceCreditAmount.ts +++ b/src/models/containers/issueServiceCreditAmount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/listProductPricePointsInputProductId.ts b/src/models/containers/listProductPricePointsInputProductId.ts index 8a760b2b..9ab6e5cd 100644 --- a/src/models/containers/listProductPricePointsInputProductId.ts +++ b/src/models/containers/listProductPricePointsInputProductId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/listUsagesInputComponentId.ts b/src/models/containers/listUsagesInputComponentId.ts index dab23cf1..479bb5de 100644 --- a/src/models/containers/listUsagesInputComponentId.ts +++ b/src/models/containers/listUsagesInputComponentId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/metafieldEnum.ts b/src/models/containers/metafieldEnum.ts index 28440b88..c2feb190 100644 --- a/src/models/containers/metafieldEnum.ts +++ b/src/models/containers/metafieldEnum.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/meteredComponentUnitPrice.ts b/src/models/containers/meteredComponentUnitPrice.ts index b780e477..ddc0ae43 100644 --- a/src/models/containers/meteredComponentUnitPrice.ts +++ b/src/models/containers/meteredComponentUnitPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/onOffComponentUnitPrice.ts b/src/models/containers/onOffComponentUnitPrice.ts index e9428a33..26ca7c10 100644 --- a/src/models/containers/onOffComponentUnitPrice.ts +++ b/src/models/containers/onOffComponentUnitPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/paymentProfile.ts b/src/models/containers/paymentProfile.ts new file mode 100644 index 00000000..6e9128a4 --- /dev/null +++ b/src/models/containers/paymentProfile.ts @@ -0,0 +1,107 @@ +/** + * AdvancedBilling + * + * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). + */ + +import { anyOf, Schema, validateAndMap } from '../../schema'; +import { + ApplePayPaymentProfile, + applePayPaymentProfileSchema, +} from '../applePayPaymentProfile'; +import { + BankAccountPaymentProfile, + bankAccountPaymentProfileSchema, +} from '../bankAccountPaymentProfile'; +import { + CreditCardPaymentProfile, + creditCardPaymentProfileSchema, +} from '../creditCardPaymentProfile'; +import { + PaypalPaymentProfile, + paypalPaymentProfileSchema, +} from '../paypalPaymentProfile'; + +/** This is a container type for any-of types. */ +export type PaymentProfile = + | ApplePayPaymentProfile + | BankAccountPaymentProfile + | CreditCardPaymentProfile + | PaypalPaymentProfile; + +const discriminatorMap = { + 'apple_pay': applePayPaymentProfileSchema, + 'bank_account': bankAccountPaymentProfileSchema, + 'credit_card': creditCardPaymentProfileSchema, + 'paypal_account': paypalPaymentProfileSchema, +}; + +export const paymentProfileSchema: Schema = anyOf( + [ + applePayPaymentProfileSchema, + bankAccountPaymentProfileSchema, + creditCardPaymentProfileSchema, + paypalPaymentProfileSchema, + ], + discriminatorMap, + 'paymentType' +); + +export namespace PaymentProfile { + /** + * Validation method to narrow down union type to ApplePayPaymentProfile type case. + * + * This is ApplePay Payment Profile case. + */ + export function isApplePayPaymentProfile( + value: unknown + ): value is ApplePayPaymentProfile { + const validationResult = validateAndMap( + value, + applePayPaymentProfileSchema + ); + return validationResult.errors === false; + } + + /** + * Validation method to narrow down union type to BankAccountPaymentProfile type case. + * + * This is Bank Account Payment Profile case. + */ + export function isBankAccountPaymentProfile( + value: unknown + ): value is BankAccountPaymentProfile { + const validationResult = validateAndMap( + value, + bankAccountPaymentProfileSchema + ); + return validationResult.errors === false; + } + + /** + * Validation method to narrow down union type to CreditCardPaymentProfile type case. + * + * This is Credit Card Payment Profile case. + */ + export function isCreditCardPaymentProfile( + value: unknown + ): value is CreditCardPaymentProfile { + const validationResult = validateAndMap( + value, + creditCardPaymentProfileSchema + ); + return validationResult.errors === false; + } + + /** + * Validation method to narrow down union type to PaypalPaymentProfile type case. + * + * This is Paypal Payment Profile case. + */ + export function isPaypalPaymentProfile( + value: unknown + ): value is PaypalPaymentProfile { + const validationResult = validateAndMap(value, paypalPaymentProfileSchema); + return validationResult.errors === false; + } +} diff --git a/src/models/containers/paymentProfileAttributesExpirationMonth.ts b/src/models/containers/paymentProfileAttributesExpirationMonth.ts index 6b0901d2..56eaffa0 100644 --- a/src/models/containers/paymentProfileAttributesExpirationMonth.ts +++ b/src/models/containers/paymentProfileAttributesExpirationMonth.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/paymentProfileAttributesExpirationYear.ts b/src/models/containers/paymentProfileAttributesExpirationYear.ts index 355ba8db..845cb37d 100644 --- a/src/models/containers/paymentProfileAttributesExpirationYear.ts +++ b/src/models/containers/paymentProfileAttributesExpirationYear.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/paymentProfileResponsePaymentProfile.ts b/src/models/containers/paymentProfileResponsePaymentProfile.ts deleted file mode 100644 index 13cfa646..00000000 --- a/src/models/containers/paymentProfileResponsePaymentProfile.ts +++ /dev/null @@ -1,56 +0,0 @@ -/** - * Maxio Advanced BillingLib - * - * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). - */ - -import { oneOf, Schema, validateAndMap } from '../../schema'; -import { - BankAccountPaymentProfile, - bankAccountPaymentProfileSchema, -} from '../bankAccountPaymentProfile'; -import { - CreditCardPaymentProfile, - creditCardPaymentProfileSchema, -} from '../creditCardPaymentProfile'; - -/** This is a container type for one-of types. */ -export type PaymentProfileResponsePaymentProfile = - | BankAccountPaymentProfile - | CreditCardPaymentProfile; - -export const paymentProfileResponsePaymentProfileSchema: Schema = oneOf( - [bankAccountPaymentProfileSchema, creditCardPaymentProfileSchema] -); - -export namespace PaymentProfileResponsePaymentProfile { - /** - * Validation method to narrow down union type to BankAccountPaymentProfile type case. - * - * This is Bank Account Payment Profile case. - */ - export function isBankAccountPaymentProfile( - value: unknown - ): value is BankAccountPaymentProfile { - const validationResult = validateAndMap( - value, - bankAccountPaymentProfileSchema - ); - return validationResult.errors === false; - } - - /** - * Validation method to narrow down union type to CreditCardPaymentProfile type case. - * - * This is Credit Card Payment Profile case. - */ - export function isCreditCardPaymentProfile( - value: unknown - ): value is CreditCardPaymentProfile { - const validationResult = validateAndMap( - value, - creditCardPaymentProfileSchema - ); - return validationResult.errors === false; - } -} diff --git a/src/models/containers/prepaidUsageComponentUnitPrice.ts b/src/models/containers/prepaidUsageComponentUnitPrice.ts index bd3c915f..aee004ee 100644 --- a/src/models/containers/prepaidUsageComponentUnitPrice.ts +++ b/src/models/containers/prepaidUsageComponentUnitPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/priceEndingQuantity.ts b/src/models/containers/priceEndingQuantity.ts index a0deb03d..a89a703a 100644 --- a/src/models/containers/priceEndingQuantity.ts +++ b/src/models/containers/priceEndingQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/priceStartingQuantity.ts b/src/models/containers/priceStartingQuantity.ts index 830939cf..29ac4069 100644 --- a/src/models/containers/priceStartingQuantity.ts +++ b/src/models/containers/priceStartingQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/priceUnitPrice.ts b/src/models/containers/priceUnitPrice.ts index c3f864da..796ee250 100644 --- a/src/models/containers/priceUnitPrice.ts +++ b/src/models/containers/priceUnitPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/quantityBasedComponentUnitPrice.ts b/src/models/containers/quantityBasedComponentUnitPrice.ts index 5db84b9e..89a86799 100644 --- a/src/models/containers/quantityBasedComponentUnitPrice.ts +++ b/src/models/containers/quantityBasedComponentUnitPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/reactivateSubscriptionRequestResume.ts b/src/models/containers/reactivateSubscriptionRequestResume.ts index b176910a..e6bf1068 100644 --- a/src/models/containers/reactivateSubscriptionRequestResume.ts +++ b/src/models/containers/reactivateSubscriptionRequestResume.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/readComponentPricePointComponentId.ts b/src/models/containers/readComponentPricePointComponentId.ts index 08ba52de..f3d89318 100644 --- a/src/models/containers/readComponentPricePointComponentId.ts +++ b/src/models/containers/readComponentPricePointComponentId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/readComponentPricePointPricePointId.ts b/src/models/containers/readComponentPricePointPricePointId.ts index 4cb4be3e..f8575d39 100644 --- a/src/models/containers/readComponentPricePointPricePointId.ts +++ b/src/models/containers/readComponentPricePointPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/readProductPricePointPricePointId.ts b/src/models/containers/readProductPricePointPricePointId.ts index 31fde4c8..2844efd4 100644 --- a/src/models/containers/readProductPricePointPricePointId.ts +++ b/src/models/containers/readProductPricePointPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/readProductPricePointProductId.ts b/src/models/containers/readProductPricePointProductId.ts index 50a8fb64..fa9c49c3 100644 --- a/src/models/containers/readProductPricePointProductId.ts +++ b/src/models/containers/readProductPricePointProductId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/refundConsolidatedInvoiceSegmentUids.ts b/src/models/containers/refundConsolidatedInvoiceSegmentUids.ts index a8887885..638cd1a5 100644 --- a/src/models/containers/refundConsolidatedInvoiceSegmentUids.ts +++ b/src/models/containers/refundConsolidatedInvoiceSegmentUids.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/refundInvoiceRequestRefund.ts b/src/models/containers/refundInvoiceRequestRefund.ts index 865d669b..cc585962 100644 --- a/src/models/containers/refundInvoiceRequestRefund.ts +++ b/src/models/containers/refundInvoiceRequestRefund.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/refundPrepaymentAmount.ts b/src/models/containers/refundPrepaymentAmount.ts index 4d7c990d..86e8fcff 100644 --- a/src/models/containers/refundPrepaymentAmount.ts +++ b/src/models/containers/refundPrepaymentAmount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/renewalPreviewComponentComponentId.ts b/src/models/containers/renewalPreviewComponentComponentId.ts index 1b9bb71a..99aaab7e 100644 --- a/src/models/containers/renewalPreviewComponentComponentId.ts +++ b/src/models/containers/renewalPreviewComponentComponentId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/renewalPreviewComponentPricePointId.ts b/src/models/containers/renewalPreviewComponentPricePointId.ts index 3612f158..aa3e7eef 100644 --- a/src/models/containers/renewalPreviewComponentPricePointId.ts +++ b/src/models/containers/renewalPreviewComponentPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/segmentSegmentProperty1Value.ts b/src/models/containers/segmentSegmentProperty1Value.ts index 6a0d6c60..e4ef0472 100644 --- a/src/models/containers/segmentSegmentProperty1Value.ts +++ b/src/models/containers/segmentSegmentProperty1Value.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/segmentSegmentProperty2Value.ts b/src/models/containers/segmentSegmentProperty2Value.ts index 828dfba4..b7085737 100644 --- a/src/models/containers/segmentSegmentProperty2Value.ts +++ b/src/models/containers/segmentSegmentProperty2Value.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/segmentSegmentProperty3Value.ts b/src/models/containers/segmentSegmentProperty3Value.ts index f46767b9..03417e79 100644 --- a/src/models/containers/segmentSegmentProperty3Value.ts +++ b/src/models/containers/segmentSegmentProperty3Value.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/segmentSegmentProperty4Value.ts b/src/models/containers/segmentSegmentProperty4Value.ts index 1a7471f2..1b635f51 100644 --- a/src/models/containers/segmentSegmentProperty4Value.ts +++ b/src/models/containers/segmentSegmentProperty4Value.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionComponentAllocatedQuantity.ts b/src/models/containers/subscriptionComponentAllocatedQuantity.ts index f49960fd..9c4bb31a 100644 --- a/src/models/containers/subscriptionComponentAllocatedQuantity.ts +++ b/src/models/containers/subscriptionComponentAllocatedQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionCustomPriceExpirationInterval.ts b/src/models/containers/subscriptionCustomPriceExpirationInterval.ts index fd2747cc..4ef087ef 100644 --- a/src/models/containers/subscriptionCustomPriceExpirationInterval.ts +++ b/src/models/containers/subscriptionCustomPriceExpirationInterval.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionCustomPriceInitialChargeInCents.ts b/src/models/containers/subscriptionCustomPriceInitialChargeInCents.ts index 45054cb8..e8b1dd5c 100644 --- a/src/models/containers/subscriptionCustomPriceInitialChargeInCents.ts +++ b/src/models/containers/subscriptionCustomPriceInitialChargeInCents.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionCustomPriceInterval.ts b/src/models/containers/subscriptionCustomPriceInterval.ts index d7a7c54b..6191f278 100644 --- a/src/models/containers/subscriptionCustomPriceInterval.ts +++ b/src/models/containers/subscriptionCustomPriceInterval.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionCustomPricePriceInCents.ts b/src/models/containers/subscriptionCustomPricePriceInCents.ts index 1b840245..35dd4ee3 100644 --- a/src/models/containers/subscriptionCustomPricePriceInCents.ts +++ b/src/models/containers/subscriptionCustomPricePriceInCents.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionCustomPriceTrialInterval.ts b/src/models/containers/subscriptionCustomPriceTrialInterval.ts index 82d90ece..3ae2fba3 100644 --- a/src/models/containers/subscriptionCustomPriceTrialInterval.ts +++ b/src/models/containers/subscriptionCustomPriceTrialInterval.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionCustomPriceTrialPriceInCents.ts b/src/models/containers/subscriptionCustomPriceTrialPriceInCents.ts index de8b9e28..183c8a76 100644 --- a/src/models/containers/subscriptionCustomPriceTrialPriceInCents.ts +++ b/src/models/containers/subscriptionCustomPriceTrialPriceInCents.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionGroupCreateErrorResponseErrors.ts b/src/models/containers/subscriptionGroupCreateErrorResponseErrors.ts index 5acc6354..eac45954 100644 --- a/src/models/containers/subscriptionGroupCreateErrorResponseErrors.ts +++ b/src/models/containers/subscriptionGroupCreateErrorResponseErrors.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionGroupCreditCardExpirationMonth.ts b/src/models/containers/subscriptionGroupCreditCardExpirationMonth.ts index 18d885fb..51125874 100644 --- a/src/models/containers/subscriptionGroupCreditCardExpirationMonth.ts +++ b/src/models/containers/subscriptionGroupCreditCardExpirationMonth.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionGroupCreditCardExpirationYear.ts b/src/models/containers/subscriptionGroupCreditCardExpirationYear.ts index 8a9c7b7a..2ac7b193 100644 --- a/src/models/containers/subscriptionGroupCreditCardExpirationYear.ts +++ b/src/models/containers/subscriptionGroupCreditCardExpirationYear.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionGroupCreditCardFullNumber.ts b/src/models/containers/subscriptionGroupCreditCardFullNumber.ts index 8bb5f315..732fe8a1 100644 --- a/src/models/containers/subscriptionGroupCreditCardFullNumber.ts +++ b/src/models/containers/subscriptionGroupCreditCardFullNumber.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionGroupSignupComponentAllocatedQuantity.ts b/src/models/containers/subscriptionGroupSignupComponentAllocatedQuantity.ts index 12bf8eb4..63ecf7a5 100644 --- a/src/models/containers/subscriptionGroupSignupComponentAllocatedQuantity.ts +++ b/src/models/containers/subscriptionGroupSignupComponentAllocatedQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionGroupSignupComponentComponentId.ts b/src/models/containers/subscriptionGroupSignupComponentComponentId.ts index 8f0d2302..cef883c7 100644 --- a/src/models/containers/subscriptionGroupSignupComponentComponentId.ts +++ b/src/models/containers/subscriptionGroupSignupComponentComponentId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionGroupSignupComponentPricePointId.ts b/src/models/containers/subscriptionGroupSignupComponentPricePointId.ts index ee76fee4..c0863b10 100644 --- a/src/models/containers/subscriptionGroupSignupComponentPricePointId.ts +++ b/src/models/containers/subscriptionGroupSignupComponentPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/subscriptionGroupSignupComponentUnitBalance.ts b/src/models/containers/subscriptionGroupSignupComponentUnitBalance.ts index b7192317..2feee4ac 100644 --- a/src/models/containers/subscriptionGroupSignupComponentUnitBalance.ts +++ b/src/models/containers/subscriptionGroupSignupComponentUnitBalance.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/updateComponentPricePointComponentId.ts b/src/models/containers/updateComponentPricePointComponentId.ts index 8058d482..6aa93859 100644 --- a/src/models/containers/updateComponentPricePointComponentId.ts +++ b/src/models/containers/updateComponentPricePointComponentId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/updateComponentPricePointPricePointId.ts b/src/models/containers/updateComponentPricePointPricePointId.ts index bcda0ea4..b1946973 100644 --- a/src/models/containers/updateComponentPricePointPricePointId.ts +++ b/src/models/containers/updateComponentPricePointPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/updateMetafieldsRequestMetafields.ts b/src/models/containers/updateMetafieldsRequestMetafields.ts index 14ba87c0..5e9028d0 100644 --- a/src/models/containers/updateMetafieldsRequestMetafields.ts +++ b/src/models/containers/updateMetafieldsRequestMetafields.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/updatePriceEndingQuantity.ts b/src/models/containers/updatePriceEndingQuantity.ts index ab1fdfde..1da543df 100644 --- a/src/models/containers/updatePriceEndingQuantity.ts +++ b/src/models/containers/updatePriceEndingQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/updatePriceStartingQuantity.ts b/src/models/containers/updatePriceStartingQuantity.ts index 371e841d..2f9464a9 100644 --- a/src/models/containers/updatePriceStartingQuantity.ts +++ b/src/models/containers/updatePriceStartingQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/updatePriceUnitPrice.ts b/src/models/containers/updatePriceUnitPrice.ts index dda09418..055a03ad 100644 --- a/src/models/containers/updatePriceUnitPrice.ts +++ b/src/models/containers/updatePriceUnitPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/updateProductPricePointPricePointId.ts b/src/models/containers/updateProductPricePointPricePointId.ts index ebaf6596..d5f868c1 100644 --- a/src/models/containers/updateProductPricePointPricePointId.ts +++ b/src/models/containers/updateProductPricePointPricePointId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/updateProductPricePointProductId.ts b/src/models/containers/updateProductPricePointProductId.ts index a9900090..73207d6a 100644 --- a/src/models/containers/updateProductPricePointProductId.ts +++ b/src/models/containers/updateProductPricePointProductId.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/updateSubscriptionNetTerms.ts b/src/models/containers/updateSubscriptionNetTerms.ts index b9375ca7..0a35e006 100644 --- a/src/models/containers/updateSubscriptionNetTerms.ts +++ b/src/models/containers/updateSubscriptionNetTerms.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/updateSubscriptionSnapDay.ts b/src/models/containers/updateSubscriptionSnapDay.ts index 71198a39..74a3ea24 100644 --- a/src/models/containers/updateSubscriptionSnapDay.ts +++ b/src/models/containers/updateSubscriptionSnapDay.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/containers/usageQuantity.ts b/src/models/containers/usageQuantity.ts index 0b0070da..6c510977 100644 --- a/src/models/containers/usageQuantity.ts +++ b/src/models/containers/usageQuantity.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/countResponse.ts b/src/models/countResponse.ts index f1ee91e2..430a4103 100644 --- a/src/models/countResponse.ts +++ b/src/models/countResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/coupon.ts b/src/models/coupon.ts index 5ebc47da..2523bbae 100644 --- a/src/models/coupon.ts +++ b/src/models/coupon.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/couponCurrency.ts b/src/models/couponCurrency.ts index 22dd9d94..287ccadf 100644 --- a/src/models/couponCurrency.ts +++ b/src/models/couponCurrency.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/couponCurrencyRequest.ts b/src/models/couponCurrencyRequest.ts index 2ec1ce6b..ff32566f 100644 --- a/src/models/couponCurrencyRequest.ts +++ b/src/models/couponCurrencyRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/couponCurrencyResponse.ts b/src/models/couponCurrencyResponse.ts index d54e8e47..70725d2f 100644 --- a/src/models/couponCurrencyResponse.ts +++ b/src/models/couponCurrencyResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/couponResponse.ts b/src/models/couponResponse.ts index a80f739f..7f651336 100644 --- a/src/models/couponResponse.ts +++ b/src/models/couponResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/couponRestriction.ts b/src/models/couponRestriction.ts index e9922b05..98dfeba4 100644 --- a/src/models/couponRestriction.ts +++ b/src/models/couponRestriction.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/couponSubcodes.ts b/src/models/couponSubcodes.ts index e020366a..d722ce5b 100644 --- a/src/models/couponSubcodes.ts +++ b/src/models/couponSubcodes.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/couponSubcodesResponse.ts b/src/models/couponSubcodesResponse.ts index 88a380c2..f8611f8b 100644 --- a/src/models/couponSubcodesResponse.ts +++ b/src/models/couponSubcodesResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/couponUsage.ts b/src/models/couponUsage.ts index a7064ba5..35c3ecc6 100644 --- a/src/models/couponUsage.ts +++ b/src/models/couponUsage.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createAllocation.ts b/src/models/createAllocation.ts index b2f24421..2d8bf10b 100644 --- a/src/models/createAllocation.ts +++ b/src/models/createAllocation.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createAllocationRequest.ts b/src/models/createAllocationRequest.ts index 2ef07fbc..cf14d4c7 100644 --- a/src/models/createAllocationRequest.ts +++ b/src/models/createAllocationRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createComponentPricePoint.ts b/src/models/createComponentPricePoint.ts index b060b11d..7c07bfe9 100644 --- a/src/models/createComponentPricePoint.ts +++ b/src/models/createComponentPricePoint.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -9,6 +9,7 @@ import { boolean, expandoObject, lazy, + nullable, number, optional, Schema, @@ -31,7 +32,7 @@ export interface CreateComponentPricePoint { /** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; [key: string]: unknown; } @@ -44,6 +45,6 @@ export const createComponentPricePointSchema: Schema useSiteExchangeRate: ['use_site_exchange_rate', optional(boolean())], taxIncluded: ['tax_included', optional(boolean())], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], } ); diff --git a/src/models/createComponentPricePointRequest.ts b/src/models/createComponentPricePointRequest.ts index dbb888d9..5a7a0cc8 100644 --- a/src/models/createComponentPricePointRequest.ts +++ b/src/models/createComponentPricePointRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createComponentPricePointsRequest.ts b/src/models/createComponentPricePointsRequest.ts index 2dc75ca1..a59182ad 100644 --- a/src/models/createComponentPricePointsRequest.ts +++ b/src/models/createComponentPricePointsRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createCreditNoteEvent.ts b/src/models/createCreditNoteEvent.ts index f9f758e1..9f91389c 100644 --- a/src/models/createCreditNoteEvent.ts +++ b/src/models/createCreditNoteEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createCurrencyPrice.ts b/src/models/createCurrencyPrice.ts index 5da9f905..0a8f4fb3 100644 --- a/src/models/createCurrencyPrice.ts +++ b/src/models/createCurrencyPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createCurrencyPricesRequest.ts b/src/models/createCurrencyPricesRequest.ts index b9db4b81..32bbacca 100644 --- a/src/models/createCurrencyPricesRequest.ts +++ b/src/models/createCurrencyPricesRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createCustomer.ts b/src/models/createCustomer.ts index 02264a5d..c38fe9e9 100644 --- a/src/models/createCustomer.ts +++ b/src/models/createCustomer.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -35,6 +35,8 @@ export interface CreateCustomer { taxExemptReason?: string; /** The parent ID in Chargify if applicable. Parent is another Customer object. */ parentId?: number | null; + /** The Salesforce ID of the customer */ + salesforceId?: string | null; [key: string]: unknown; } @@ -57,4 +59,5 @@ export const createCustomerSchema: Schema = expandoObject({ taxExempt: ['tax_exempt', optional(boolean())], taxExemptReason: ['tax_exempt_reason', optional(string())], parentId: ['parent_id', optional(nullable(number()))], + salesforceId: ['salesforce_id', optional(nullable(string()))], }); diff --git a/src/models/createCustomerRequest.ts b/src/models/createCustomerRequest.ts index fbea9b44..9f0982b5 100644 --- a/src/models/createCustomerRequest.ts +++ b/src/models/createCustomerRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createDebitNoteEvent.ts b/src/models/createDebitNoteEvent.ts index 1815c7d3..97dbd866 100644 --- a/src/models/createDebitNoteEvent.ts +++ b/src/models/createDebitNoteEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createEBBComponent.ts b/src/models/createEBBComponent.ts index fda206fb..50bcab50 100644 --- a/src/models/createEBBComponent.ts +++ b/src/models/createEBBComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createInvoice.ts b/src/models/createInvoice.ts index 284fca24..5816dc5e 100644 --- a/src/models/createInvoice.ts +++ b/src/models/createInvoice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createInvoiceAddress.ts b/src/models/createInvoiceAddress.ts index 82533c4f..dc689e8b 100644 --- a/src/models/createInvoiceAddress.ts +++ b/src/models/createInvoiceAddress.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createInvoiceCoupon.ts b/src/models/createInvoiceCoupon.ts index 47d88bcc..731c0c67 100644 --- a/src/models/createInvoiceCoupon.ts +++ b/src/models/createInvoiceCoupon.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createInvoiceItem.ts b/src/models/createInvoiceItem.ts index e2a7aaec..78698dc1 100644 --- a/src/models/createInvoiceItem.ts +++ b/src/models/createInvoiceItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createInvoicePayment.ts b/src/models/createInvoicePayment.ts index 33ded633..1e89ae99 100644 --- a/src/models/createInvoicePayment.ts +++ b/src/models/createInvoicePayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createInvoicePaymentApplication.ts b/src/models/createInvoicePaymentApplication.ts index aee53e9a..617d3489 100644 --- a/src/models/createInvoicePaymentApplication.ts +++ b/src/models/createInvoicePaymentApplication.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createInvoicePaymentRequest.ts b/src/models/createInvoicePaymentRequest.ts index 013a8c4f..57d6243f 100644 --- a/src/models/createInvoicePaymentRequest.ts +++ b/src/models/createInvoicePaymentRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createInvoiceRequest.ts b/src/models/createInvoiceRequest.ts index 6e5bb780..65fc2910 100644 --- a/src/models/createInvoiceRequest.ts +++ b/src/models/createInvoiceRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createInvoiceStatus.ts b/src/models/createInvoiceStatus.ts index a1af726f..87a118dd 100644 --- a/src/models/createInvoiceStatus.ts +++ b/src/models/createInvoiceStatus.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createMetadata.ts b/src/models/createMetadata.ts index 56f7b098..68555e42 100644 --- a/src/models/createMetadata.ts +++ b/src/models/createMetadata.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createMetadataRequest.ts b/src/models/createMetadataRequest.ts index 7fe5f434..b42f14cf 100644 --- a/src/models/createMetadataRequest.ts +++ b/src/models/createMetadataRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createMetafield.ts b/src/models/createMetafield.ts index 90299b8a..26365dad 100644 --- a/src/models/createMetafield.ts +++ b/src/models/createMetafield.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -21,7 +21,7 @@ export interface CreateMetafield { scope?: MetafieldScope; /** Indicates how data should be added to the metafield. For example, a text type is just a string, so a given metafield of this type can have any value attached. On the other hand, dropdown and radio have a set of allowed values that can be input, and appear differently on a Public Signup Page. Defaults to 'text' */ inputType?: MetafieldInput; - /** Only applicable when input_type is radio or dropdown */ + /** Only applicable when input_type is radio or dropdown. Empty strings will not be submitted. */ mEnum?: string[]; [key: string]: unknown; } diff --git a/src/models/createMetafieldsRequest.ts b/src/models/createMetafieldsRequest.ts index 399f5739..b59ecd1c 100644 --- a/src/models/createMetafieldsRequest.ts +++ b/src/models/createMetafieldsRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createMeteredComponent.ts b/src/models/createMeteredComponent.ts index 57051783..dfad1d23 100644 --- a/src/models/createMeteredComponent.ts +++ b/src/models/createMeteredComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createMultiInvoicePayment.ts b/src/models/createMultiInvoicePayment.ts index b04f4aed..5d253a9d 100644 --- a/src/models/createMultiInvoicePayment.ts +++ b/src/models/createMultiInvoicePayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createMultiInvoicePaymentRequest.ts b/src/models/createMultiInvoicePaymentRequest.ts index 9beff8c8..7e02f800 100644 --- a/src/models/createMultiInvoicePaymentRequest.ts +++ b/src/models/createMultiInvoicePaymentRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOffer.ts b/src/models/createOffer.ts index 51785a66..f9f3e92c 100644 --- a/src/models/createOffer.ts +++ b/src/models/createOffer.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOfferComponent.ts b/src/models/createOfferComponent.ts index 3f10a6cf..a654ebce 100644 --- a/src/models/createOfferComponent.ts +++ b/src/models/createOfferComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOfferRequest.ts b/src/models/createOfferRequest.ts index 28be0cb8..e6ce56e3 100644 --- a/src/models/createOfferRequest.ts +++ b/src/models/createOfferRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOnOffComponent.ts b/src/models/createOnOffComponent.ts index acda4832..16639f84 100644 --- a/src/models/createOnOffComponent.ts +++ b/src/models/createOnOffComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOrUpdateCoupon.ts b/src/models/createOrUpdateCoupon.ts index edcb8ba0..446fb4e6 100644 --- a/src/models/createOrUpdateCoupon.ts +++ b/src/models/createOrUpdateCoupon.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOrUpdateEndpoint.ts b/src/models/createOrUpdateEndpoint.ts index 3352873c..e6fa3609 100644 --- a/src/models/createOrUpdateEndpoint.ts +++ b/src/models/createOrUpdateEndpoint.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOrUpdateEndpointRequest.ts b/src/models/createOrUpdateEndpointRequest.ts index c38cba71..8d50af4c 100644 --- a/src/models/createOrUpdateEndpointRequest.ts +++ b/src/models/createOrUpdateEndpointRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOrUpdateFlatAmountCoupon.ts b/src/models/createOrUpdateFlatAmountCoupon.ts index 28ce92cb..8da807de 100644 --- a/src/models/createOrUpdateFlatAmountCoupon.ts +++ b/src/models/createOrUpdateFlatAmountCoupon.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOrUpdatePercentageCoupon.ts b/src/models/createOrUpdatePercentageCoupon.ts index c967dd6e..7622adf0 100644 --- a/src/models/createOrUpdatePercentageCoupon.ts +++ b/src/models/createOrUpdatePercentageCoupon.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOrUpdateProduct.ts b/src/models/createOrUpdateProduct.ts index 6e2cad6e..ea30ccaf 100644 --- a/src/models/createOrUpdateProduct.ts +++ b/src/models/createOrUpdateProduct.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -8,11 +8,16 @@ import { bigint, boolean, expandoObject, + nullable, number, optional, Schema, string, } from '../schema'; +import { + ExpirationIntervalUnit, + expirationIntervalUnitSchema, +} from './expirationIntervalUnit'; import { IntervalUnit, intervalUnitSchema } from './intervalUnit'; export interface CreateOrUpdateProduct { @@ -37,12 +42,12 @@ export interface CreateOrUpdateProduct { /** The numerical trial interval. i.e. an interval of ‘30’ coupled with a trial_interval_unit of day would mean this product trial would last 30 days. */ trialInterval?: number; /** A string representing the trial interval unit for this product, either month or day */ - trialIntervalUnit?: IntervalUnit; + trialIntervalUnit?: IntervalUnit | null; trialType?: string; /** The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product would expire after 30 days. */ expirationInterval?: number; - /** A string representing the expiration interval unit for this product, either month or day */ - expirationIntervalUnit?: IntervalUnit; + /** A string representing the expiration interval unit for this product, either month, day or never */ + expirationIntervalUnit?: ExpirationIntervalUnit | null; autoCreateSignupPage?: boolean; /** A string representing the tax code related to the product type. This is especially important when using the Avalara service to tax based on locale. This attribute has a max length of 10 characters. */ taxCode?: string; @@ -61,12 +66,15 @@ export const createOrUpdateProductSchema: Schema = expand intervalUnit: ['interval_unit', intervalUnitSchema], trialPriceInCents: ['trial_price_in_cents', optional(bigint())], trialInterval: ['trial_interval', optional(number())], - trialIntervalUnit: ['trial_interval_unit', optional(intervalUnitSchema)], + trialIntervalUnit: [ + 'trial_interval_unit', + optional(nullable(intervalUnitSchema)), + ], trialType: ['trial_type', optional(string())], expirationInterval: ['expiration_interval', optional(number())], expirationIntervalUnit: [ 'expiration_interval_unit', - optional(intervalUnitSchema), + optional(nullable(expirationIntervalUnitSchema)), ], autoCreateSignupPage: ['auto_create_signup_page', optional(boolean())], taxCode: ['tax_code', optional(string())], diff --git a/src/models/createOrUpdateProductRequest.ts b/src/models/createOrUpdateProductRequest.ts index 94e8e9c1..f4802e65 100644 --- a/src/models/createOrUpdateProductRequest.ts +++ b/src/models/createOrUpdateProductRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createOrUpdateSegmentPrice.ts b/src/models/createOrUpdateSegmentPrice.ts index 2a284d5a..4fb269e9 100644 --- a/src/models/createOrUpdateSegmentPrice.ts +++ b/src/models/createOrUpdateSegmentPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createPayment.ts b/src/models/createPayment.ts index 257eb8d0..ca401200 100644 --- a/src/models/createPayment.ts +++ b/src/models/createPayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createPaymentProfile.ts b/src/models/createPaymentProfile.ts index 475dd442..b8acaf3e 100644 --- a/src/models/createPaymentProfile.ts +++ b/src/models/createPaymentProfile.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -12,6 +12,7 @@ import { Schema, string, } from '../schema'; +import { AllVaults, allVaultsSchema } from './allVaults'; import { BankAccountHolderType, bankAccountHolderTypeSchema, @@ -26,7 +27,6 @@ import { CreatePaymentProfileExpirationYear, createPaymentProfileExpirationYearSchema, } from './containers/createPaymentProfileExpirationYear'; -import { CurrentVault, currentVaultSchema } from './currentVault'; import { PaymentType, paymentTypeSchema } from './paymentType'; export interface CreatePaymentProfile { @@ -60,7 +60,7 @@ export interface CreatePaymentProfile { /** The credit card or bank account billing address zip code (i.e. 12345). This value is merely passed through to the payment gateway. */ billingZip?: string; /** The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. */ - currentVault?: CurrentVault; + currentVault?: AllVaults; /** The “token” provided by your vault storage for an already stored payment profile */ vaultToken?: string; /** (only for Authorize.Net CIM storage or Square) The customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token */ @@ -118,7 +118,7 @@ export const createPaymentProfileSchema: Schema = expandoO billingState: ['billing_state', optional(string())], billingCountry: ['billing_country', optional(string())], billingZip: ['billing_zip', optional(string())], - currentVault: ['current_vault', optional(currentVaultSchema)], + currentVault: ['current_vault', optional(allVaultsSchema)], vaultToken: ['vault_token', optional(string())], customerVaultToken: ['customer_vault_token', optional(string())], customerId: ['customer_id', optional(number())], diff --git a/src/models/createPaymentProfileRequest.ts b/src/models/createPaymentProfileRequest.ts index 36397e06..752c28ac 100644 --- a/src/models/createPaymentProfileRequest.ts +++ b/src/models/createPaymentProfileRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createPrepaidComponent.ts b/src/models/createPrepaidComponent.ts index 06791a7f..687c704b 100644 --- a/src/models/createPrepaidComponent.ts +++ b/src/models/createPrepaidComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createPrepaidUsageComponentPricePoint.ts b/src/models/createPrepaidUsageComponentPricePoint.ts index fe4edc38..afce2e76 100644 --- a/src/models/createPrepaidUsageComponentPricePoint.ts +++ b/src/models/createPrepaidUsageComponentPricePoint.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -9,12 +9,16 @@ import { boolean, expandoObject, lazy, + nullable, number, optional, Schema, string, } from '../schema'; -import { IntervalUnit, intervalUnitSchema } from './intervalUnit'; +import { + ExpirationIntervalUnit, + expirationIntervalUnitSchema, +} from './expirationIntervalUnit'; import { OveragePricing, overagePricingSchema } from './overagePricing'; import { Price, priceSchema } from './price'; import { PricingScheme, pricingSchemeSchema } from './pricingScheme'; @@ -34,7 +38,8 @@ export interface CreatePrepaidUsageComponentPricePoint { renewPrepaidAllocation?: boolean; /** (only for prepaid usage components where rollover_prepaid_remainder is true) The number of `expiration_interval_unit`s after which rollover amounts should expire */ expirationInterval?: number; - expirationIntervalUnit?: IntervalUnit; + /** A string representing the expiration interval unit for this component, either month or day */ + expirationIntervalUnit?: ExpirationIntervalUnit | null; [key: string]: unknown; } @@ -54,7 +59,7 @@ export const createPrepaidUsageComponentPricePointSchema: Schema = ex expirationInterval: ['expiration_interval', optional(number())], expirationIntervalUnit: [ 'expiration_interval_unit', - optional(intervalUnitSchema), + optional(nullable(expirationIntervalUnitSchema)), ], useSiteExchangeRate: ['use_site_exchange_rate', optional(boolean())], } diff --git a/src/models/createProductPricePointRequest.ts b/src/models/createProductPricePointRequest.ts index 948275c0..3c74f57a 100644 --- a/src/models/createProductPricePointRequest.ts +++ b/src/models/createProductPricePointRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createQuantityBasedComponent.ts b/src/models/createQuantityBasedComponent.ts index 7c63b637..100c7bc1 100644 --- a/src/models/createQuantityBasedComponent.ts +++ b/src/models/createQuantityBasedComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createReasonCode.ts b/src/models/createReasonCode.ts index 097f298e..68c2f1bb 100644 --- a/src/models/createReasonCode.ts +++ b/src/models/createReasonCode.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createReasonCodeRequest.ts b/src/models/createReasonCodeRequest.ts index be1a543e..a7ef4947 100644 --- a/src/models/createReasonCodeRequest.ts +++ b/src/models/createReasonCodeRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createSegment.ts b/src/models/createSegment.ts index 45f3f5b9..77446884 100644 --- a/src/models/createSegment.ts +++ b/src/models/createSegment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createSegmentRequest.ts b/src/models/createSegmentRequest.ts index 89b9f590..802536e6 100644 --- a/src/models/createSegmentRequest.ts +++ b/src/models/createSegmentRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createSignupProformaPreviewInclude.ts b/src/models/createSignupProformaPreviewInclude.ts index d257aa2b..b4676855 100644 --- a/src/models/createSignupProformaPreviewInclude.ts +++ b/src/models/createSignupProformaPreviewInclude.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createSubscription.ts b/src/models/createSubscription.ts index 9eaf5770..5bd2459f 100644 --- a/src/models/createSubscription.ts +++ b/src/models/createSubscription.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -76,9 +76,9 @@ export interface CreateSubscription { netTerms?: string; /** The ID of an existing customer within Chargify. Required, unless a `customer_reference` or a set of `customer_attributes` is given. */ customerId?: number; - /** (Optional) Set this attribute to a future date/time to sync imported subscriptions to your existing renewal schedule. See the notes on “Date/Time Format” in our [subscription import documentation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404863655821#date-format). If you provide a next_billing_at timestamp that is in the future, no trial or initial charges will be applied when you create the subscription. In fact, no payment will be captured at all. The first payment will be captured, according to the prices defined by the product, near the time specified by next_billing_at. If you do not provide a value for next_billing_at, any trial and/or initial charges will be assessed and charged at the time of subscription creation. If the card cannot be successfully charged, the subscription will not be created. See further notes in the section on Importing Subscriptions. */ + /** (Optional) Set this attribute to a future date/time to sync imported subscriptions to your existing renewal schedule. See the notes on “Date/Time Format” in our [subscription import documentation](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Advanced-Billing-Subscription-Imports#date-format). If you provide a next_billing_at timestamp that is in the future, no trial or initial charges will be applied when you create the subscription. In fact, no payment will be captured at all. The first payment will be captured, according to the prices defined by the product, near the time specified by next_billing_at. If you do not provide a value for next_billing_at, any trial and/or initial charges will be assessed and charged at the time of subscription creation. If the card cannot be successfully charged, the subscription will not be created. See further notes in the section on Importing Subscriptions. */ nextBillingAt?: string; - /** (Optional) Set this attribute to a future date/time to create a subscription in the "Awaiting Signup" state, rather than "Active" or "Trialing". See the notes on “Date/Time Format” in our [subscription import documentation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404863655821#date-format). In the "Awaiting Signup" state, a subscription behaves like any other. It can be canceled, allocated to, had its billing date changed. etc. When the initial_billing_at date hits, the subscription will transition to the expected state. If the product has a trial, the subscription will enter a trial, otherwise it will go active. Setup fees will be respected either before or after the trial, as configured on the price point. If the payment is due at the initial_billing_at and it fails the subscription will be immediately canceled. See further notes in the section on Delayed Signups. */ + /** (Optional) Set this attribute to a future date/time to create a subscription in the "Awaiting Signup" state, rather than "Active" or "Trialing". See the notes on “Date/Time Format” in our [subscription import documentation](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Advanced-Billing-Subscription-Imports#date-format). In the "Awaiting Signup" state, a subscription behaves like any other. It can be canceled, allocated to, had its billing date changed. etc. When the initial_billing_at date hits, the subscription will transition to the expected state. If the product has a trial, the subscription will enter a trial, otherwise it will go active. Setup fees will be respected either before or after the trial, as configured on the price point. If the payment is due at the initial_billing_at and it fails the subscription will be immediately canceled. See further notes in the section on Delayed Signups. */ initialBillingAt?: string; /** For European sites subject to PSD2 and using 3D Secure, this can be used to reference a previous transaction for the customer. This will ensure the card will be charged successfully at renewal. */ storedCredentialTransactionId?: number; @@ -93,7 +93,7 @@ export interface CreateSubscription { /** Credit Card data to create a new Subscription. Interchangeable with `payment_profile_attributes` property. */ creditCardAttributes?: PaymentProfileAttributes; bankAccountAttributes?: BankAccountAttributes; - /** (Optional) An array of component ids and quantities to be added to the subscription. See [Components](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677) for more information. */ + /** (Optional) An array of component ids and quantities to be added to the subscription. See [Components](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview) for more information. */ components?: CreateSubscriptionComponent[]; /** (Optional). Cannot be used when also specifying next_billing_at */ calendarBilling?: CalendarBilling; @@ -102,7 +102,7 @@ export interface CreateSubscription { /** The reference value (provided by your app) of an existing customer within Chargify. Required, unless a `customer_id` or a set of `customer_attributes` is given. */ customerReference?: string; group?: GroupSettings; - /** A valid referral code. (optional, see [Referrals](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405420204045-Referrals-Reference#how-to-obtain-referral-codes) for more details). If supplied, must be valid, or else subscription creation will fail. */ + /** A valid referral code. (optional, see [Referrals](https://maxio.zendesk.com/hc/en-us/articles/24286981223693-Referrals-Reference#how-to-obtain-referral-codes) for more details). If supplied, must be valid, or else subscription creation will fail. */ ref?: string; /** (Optional) Can be used when canceling a subscription (via the HTTP DELETE method) to make a note about the reason for cancellation. */ cancellationMessage?: string; diff --git a/src/models/createSubscriptionComponent.ts b/src/models/createSubscriptionComponent.ts index 9aa6f4c3..76da9345 100644 --- a/src/models/createSubscriptionComponent.ts +++ b/src/models/createSubscriptionComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createSubscriptionGroup.ts b/src/models/createSubscriptionGroup.ts index aa51c445..bde4dca0 100644 --- a/src/models/createSubscriptionGroup.ts +++ b/src/models/createSubscriptionGroup.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createSubscriptionGroupRequest.ts b/src/models/createSubscriptionGroupRequest.ts index 7a7c513b..9ddcaa8f 100644 --- a/src/models/createSubscriptionGroupRequest.ts +++ b/src/models/createSubscriptionGroupRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createSubscriptionRequest.ts b/src/models/createSubscriptionRequest.ts index ed178587..8a97ac6c 100644 --- a/src/models/createSubscriptionRequest.ts +++ b/src/models/createSubscriptionRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createUsage.ts b/src/models/createUsage.ts index 9cd9b6c7..22744d79 100644 --- a/src/models/createUsage.ts +++ b/src/models/createUsage.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createUsageRequest.ts b/src/models/createUsageRequest.ts index cb94b8c3..b589a73b 100644 --- a/src/models/createUsageRequest.ts +++ b/src/models/createUsageRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/createdPrepayment.ts b/src/models/createdPrepayment.ts index 827eb720..94e6889c 100644 --- a/src/models/createdPrepayment.ts +++ b/src/models/createdPrepayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/creditAccountBalanceChanged.ts b/src/models/creditAccountBalanceChanged.ts index 4ec6e503..8f7f4c3e 100644 --- a/src/models/creditAccountBalanceChanged.ts +++ b/src/models/creditAccountBalanceChanged.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/creditCardAttributes.ts b/src/models/creditCardAttributes.ts index adcfea5f..ebd64362 100644 --- a/src/models/creditCardAttributes.ts +++ b/src/models/creditCardAttributes.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/creditCardPaymentProfile.ts b/src/models/creditCardPaymentProfile.ts index 8b82f750..d510d0e6 100644 --- a/src/models/creditCardPaymentProfile.ts +++ b/src/models/creditCardPaymentProfile.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -14,7 +14,7 @@ import { string, } from '../schema'; import { CardType, cardTypeSchema } from './cardType'; -import { CurrentVault, currentVaultSchema } from './currentVault'; +import { CreditCardVault, creditCardVaultSchema } from './creditCardVault'; import { PaymentType, paymentTypeSchema } from './paymentType'; export interface CreditCardPaymentProfile { @@ -25,7 +25,7 @@ export interface CreditCardPaymentProfile { /** The last name of the card holder. */ lastName?: string; /** A string representation of the credit card number with all but the last 4 digits masked with X’s (i.e. ‘XXXX-XXXX-XXXX-1234’). */ - maskedCardNumber: string; + maskedCardNumber?: string; /** The type of card used. */ cardType?: CardType; /** An integer representing the expiration month of the card(1 – 12). */ @@ -35,7 +35,7 @@ export interface CreditCardPaymentProfile { /** The Chargify-assigned id for the customer record to which the card belongs. */ customerId?: number; /** The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. */ - currentVault?: CurrentVault; + currentVault?: CreditCardVault; /** The “token” provided by your vault storage for an already stored payment profile. */ vaultToken?: string | null; /** The current billing street address for the card. */ @@ -52,7 +52,7 @@ export interface CreditCardPaymentProfile { customerVaultToken?: string | null; /** The current billing street address, second line, for the card. */ billingAddress2?: string | null; - paymentType?: PaymentType; + paymentType: PaymentType; disabled?: boolean; /** Token received after sending billing information using chargify.js. This token will only be received if passed as a sole attribute of credit_card_attributes (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) */ chargifyToken?: string; @@ -67,12 +67,12 @@ export const creditCardPaymentProfileSchema: Schema = id: ['id', optional(number())], firstName: ['first_name', optional(string())], lastName: ['last_name', optional(string())], - maskedCardNumber: ['masked_card_number', string()], + maskedCardNumber: ['masked_card_number', optional(string())], cardType: ['card_type', optional(cardTypeSchema)], expirationMonth: ['expiration_month', optional(number())], expirationYear: ['expiration_year', optional(number())], customerId: ['customer_id', optional(number())], - currentVault: ['current_vault', optional(currentVaultSchema)], + currentVault: ['current_vault', optional(creditCardVaultSchema)], vaultToken: ['vault_token', optional(nullable(string()))], billingAddress: ['billing_address', optional(nullable(string()))], billingCity: ['billing_city', optional(nullable(string()))], @@ -81,7 +81,7 @@ export const creditCardPaymentProfileSchema: Schema = billingCountry: ['billing_country', optional(nullable(string()))], customerVaultToken: ['customer_vault_token', optional(nullable(string()))], billingAddress2: ['billing_address_2', optional(nullable(string()))], - paymentType: ['payment_type', optional(paymentTypeSchema)], + paymentType: ['payment_type', paymentTypeSchema], disabled: ['disabled', optional(boolean())], chargifyToken: ['chargify_token', optional(string())], siteGatewaySettingId: [ diff --git a/src/models/creditCardVault.ts b/src/models/creditCardVault.ts new file mode 100644 index 00000000..a52d657b --- /dev/null +++ b/src/models/creditCardVault.ts @@ -0,0 +1,53 @@ +/** + * AdvancedBilling + * + * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). + */ + +import { Schema, stringEnum } from '../schema'; + +/** + * Enum for CreditCardVault + */ +export enum CreditCardVault { + Adyen = 'adyen', + Authorizenet = 'authorizenet', + Beanstream = 'beanstream', + BlueSnap = 'blue_snap', + Bogus = 'bogus', + Braintree1 = 'braintree1', + BraintreeBlue = 'braintree_blue', + Checkout = 'checkout', + Cybersource = 'cybersource', + Elavon = 'elavon', + Eway = 'eway', + EwayRapid = 'eway_rapid', + EwayRapidStd = 'eway_rapid_std', + Firstdata = 'firstdata', + Forte = 'forte', + Litle = 'litle', + MaxioPayments = 'maxio_payments', + Maxp = 'maxp', + Moduslink = 'moduslink', + Moneris = 'moneris', + Nmi = 'nmi', + Orbital = 'orbital', + PaymentExpress = 'payment_express', + Paymill = 'paymill', + Paypal = 'paypal', + PaypalComplete = 'paypal_complete', + Pin = 'pin', + Square = 'square', + Stripe = 'stripe', + StripeConnect = 'stripe_connect', + TrustCommerce = 'trust_commerce', + Unipaas = 'unipaas', + Wirecard = 'wirecard', +} + +/** + * Schema for CreditCardVault + */ +export const creditCardVaultSchema: Schema = stringEnum( + CreditCardVault +); diff --git a/src/models/creditNote.ts b/src/models/creditNote.ts index fd0b188a..5152243b 100644 --- a/src/models/creditNote.ts +++ b/src/models/creditNote.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -89,7 +89,7 @@ export interface CreditNote { taxes?: InvoiceTax[]; applications?: CreditNoteApplication[]; refunds?: InvoiceRefund[]; - /** An array of origin invoices for the credit note. Learn more about [Origin Invoice from our docs](https://chargify.zendesk.com/hc/en-us/articles/4407753036699#origin-invoices) */ + /** An array of origin invoices for the credit note. Learn more about [Origin Invoice from our docs](https://maxio.zendesk.com/hc/en-us/articles/24252261284749-Credit-Notes-Proration#origin-invoices) */ originInvoices?: OriginInvoice[]; [key: string]: unknown; } diff --git a/src/models/creditNoteApplication.ts b/src/models/creditNoteApplication.ts index 229ad512..1f4f1da6 100644 --- a/src/models/creditNoteApplication.ts +++ b/src/models/creditNoteApplication.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/creditNoteLineItem.ts b/src/models/creditNoteLineItem.ts index 1af278b5..0d64a756 100644 --- a/src/models/creditNoteLineItem.ts +++ b/src/models/creditNoteLineItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/creditNoteStatus.ts b/src/models/creditNoteStatus.ts index 4f57a94f..0f9ba43d 100644 --- a/src/models/creditNoteStatus.ts +++ b/src/models/creditNoteStatus.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/creditScheme.ts b/src/models/creditScheme.ts index b7b409d9..f4fa9ce4 100644 --- a/src/models/creditScheme.ts +++ b/src/models/creditScheme.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/creditSchemeRequest.ts b/src/models/creditSchemeRequest.ts index a24308ea..87e1010d 100644 --- a/src/models/creditSchemeRequest.ts +++ b/src/models/creditSchemeRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/creditType.ts b/src/models/creditType.ts index d68076ab..84366c72 100644 --- a/src/models/creditType.ts +++ b/src/models/creditType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/currencyPrice.ts b/src/models/currencyPrice.ts index 608c1b13..fa5cd0e8 100644 --- a/src/models/currencyPrice.ts +++ b/src/models/currencyPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/currencyPriceRole.ts b/src/models/currencyPriceRole.ts index c69b71d8..18fe81d7 100644 --- a/src/models/currencyPriceRole.ts +++ b/src/models/currencyPriceRole.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/currencyPricesResponse.ts b/src/models/currencyPricesResponse.ts index d028cd46..db304541 100644 --- a/src/models/currencyPricesResponse.ts +++ b/src/models/currencyPricesResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/customFieldOwner.ts b/src/models/customFieldOwner.ts index dba9937b..ca0428d9 100644 --- a/src/models/customFieldOwner.ts +++ b/src/models/customFieldOwner.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/customFieldValueChange.ts b/src/models/customFieldValueChange.ts index f8507c67..d18d98e7 100644 --- a/src/models/customFieldValueChange.ts +++ b/src/models/customFieldValueChange.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/customer.ts b/src/models/customer.ts index d3b11506..fc465b22 100644 --- a/src/models/customer.ts +++ b/src/models/customer.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -68,6 +68,8 @@ export interface Customer { /** The locale for the customer to identify language-region */ locale?: string | null; defaultSubscriptionGroupUid?: string | null; + /** The Salesforce ID for the customer */ + salesforceId?: string | null; [key: string]: unknown; } @@ -111,4 +113,5 @@ export const customerSchema: Schema = expandoObject({ 'default_subscription_group_uid', optional(nullable(string())), ], + salesforceId: ['salesforce_id', optional(nullable(string()))], }); diff --git a/src/models/customerAttributes.ts b/src/models/customerAttributes.ts index a5873003..262cf39a 100644 --- a/src/models/customerAttributes.ts +++ b/src/models/customerAttributes.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -51,6 +51,8 @@ export interface CustomerAttributes { metafields?: Record; /** The parent ID in Chargify if applicable. Parent is another Customer object. */ parentId?: number | null; + /** (Optional) The Salesforce ID of the customer. */ + salesforceId?: string | null; [key: string]: unknown; } @@ -74,5 +76,6 @@ export const customerAttributesSchema: Schema = expandoObjec vatNumber: ['vat_number', optional(string())], metafields: ['metafields', optional(dict(string()))], parentId: ['parent_id', optional(nullable(number()))], + salesforceId: ['salesforce_id', optional(nullable(string()))], } ); diff --git a/src/models/customerChange.ts b/src/models/customerChange.ts index be2c7c90..ee3ed154 100644 --- a/src/models/customerChange.ts +++ b/src/models/customerChange.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/customerChangesPreviewResponse.ts b/src/models/customerChangesPreviewResponse.ts index a5f490fd..d63e6633 100644 --- a/src/models/customerChangesPreviewResponse.ts +++ b/src/models/customerChangesPreviewResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/customerCustomFieldsChange.ts b/src/models/customerCustomFieldsChange.ts index 150e42c9..80220a69 100644 --- a/src/models/customerCustomFieldsChange.ts +++ b/src/models/customerCustomFieldsChange.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/customerError.ts b/src/models/customerError.ts index 33c15988..c2fe8d8c 100644 --- a/src/models/customerError.ts +++ b/src/models/customerError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/customerPayerChange.ts b/src/models/customerPayerChange.ts index e394db8f..fd1d9c69 100644 --- a/src/models/customerPayerChange.ts +++ b/src/models/customerPayerChange.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/customerResponse.ts b/src/models/customerResponse.ts index 0fa2d6c2..5c882e22 100644 --- a/src/models/customerResponse.ts +++ b/src/models/customerResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/debitNote.ts b/src/models/debitNote.ts index 41fabde8..40a922b0 100644 --- a/src/models/debitNote.ts +++ b/src/models/debitNote.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/debitNoteRole.ts b/src/models/debitNoteRole.ts index ff05ac1a..85c6609b 100644 --- a/src/models/debitNoteRole.ts +++ b/src/models/debitNoteRole.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/debitNoteStatus.ts b/src/models/debitNoteStatus.ts index 888db9fa..437f45c7 100644 --- a/src/models/debitNoteStatus.ts +++ b/src/models/debitNoteStatus.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/deductServiceCredit.ts b/src/models/deductServiceCredit.ts index a106eac0..8be7f948 100644 --- a/src/models/deductServiceCredit.ts +++ b/src/models/deductServiceCredit.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/deductServiceCreditRequest.ts b/src/models/deductServiceCreditRequest.ts index 8ef6ee5e..4f9f0728 100644 --- a/src/models/deductServiceCreditRequest.ts +++ b/src/models/deductServiceCreditRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/delayedCancellationResponse.ts b/src/models/delayedCancellationResponse.ts index fadc6c43..72194858 100644 --- a/src/models/delayedCancellationResponse.ts +++ b/src/models/delayedCancellationResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/deleteSubscriptionGroupResponse.ts b/src/models/deleteSubscriptionGroupResponse.ts index 2f8ab8cd..b7d23116 100644 --- a/src/models/deleteSubscriptionGroupResponse.ts +++ b/src/models/deleteSubscriptionGroupResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/direction.ts b/src/models/direction.ts index 61916935..bb8b8a35 100644 --- a/src/models/direction.ts +++ b/src/models/direction.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/discountType.ts b/src/models/discountType.ts index 9956d0b7..4d1c00ce 100644 --- a/src/models/discountType.ts +++ b/src/models/discountType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/dunnerData.ts b/src/models/dunnerData.ts index 8b4de132..d8415b4a 100644 --- a/src/models/dunnerData.ts +++ b/src/models/dunnerData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/dunningStepData.ts b/src/models/dunningStepData.ts index d979d183..0ef120ae 100644 --- a/src/models/dunningStepData.ts +++ b/src/models/dunningStepData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/dunningStepReached.ts b/src/models/dunningStepReached.ts index 9eedee0c..09b79281 100644 --- a/src/models/dunningStepReached.ts +++ b/src/models/dunningStepReached.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/eBBComponent.ts b/src/models/eBBComponent.ts index 6194ae67..696cd767 100644 --- a/src/models/eBBComponent.ts +++ b/src/models/eBBComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -67,7 +67,7 @@ export interface EBBComponent { /** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; [key: string]: unknown; } @@ -91,5 +91,5 @@ export const eBBComponentSchema: Schema = expandoObject({ priceInCents: ['price_in_cents', optional(string())], eventBasedBillingMetricId: ['event_based_billing_metric_id', number()], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], }); diff --git a/src/models/eBBEvent.ts b/src/models/eBBEvent.ts index 93b67be7..766ae868 100644 --- a/src/models/eBBEvent.ts +++ b/src/models/eBBEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/enableWebhooksRequest.ts b/src/models/enableWebhooksRequest.ts index 215555e7..f79de129 100644 --- a/src/models/enableWebhooksRequest.ts +++ b/src/models/enableWebhooksRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/enableWebhooksResponse.ts b/src/models/enableWebhooksResponse.ts index cb955177..1735ad55 100644 --- a/src/models/enableWebhooksResponse.ts +++ b/src/models/enableWebhooksResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/endpoint.ts b/src/models/endpoint.ts index 32792cab..cb3daa31 100644 --- a/src/models/endpoint.ts +++ b/src/models/endpoint.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/endpointResponse.ts b/src/models/endpointResponse.ts index 5a1efa84..0e9b197b 100644 --- a/src/models/endpointResponse.ts +++ b/src/models/endpointResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/errors.ts b/src/models/errors.ts index f515e376..8d3c9dc1 100644 --- a/src/models/errors.ts +++ b/src/models/errors.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/event.ts b/src/models/event.ts index 0c0ec9d4..9777269c 100644 --- a/src/models/event.ts +++ b/src/models/event.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/eventBasedBillingSegmentError.ts b/src/models/eventBasedBillingSegmentError.ts index c8c51232..378cf6fa 100644 --- a/src/models/eventBasedBillingSegmentError.ts +++ b/src/models/eventBasedBillingSegmentError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/eventResponse.ts b/src/models/eventResponse.ts index 84a74fe9..5f29f2ac 100644 --- a/src/models/eventResponse.ts +++ b/src/models/eventResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/eventType.ts b/src/models/eventType.ts index e8cbf75d..61244088 100644 --- a/src/models/eventType.ts +++ b/src/models/eventType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/expirationIntervalUnit.ts b/src/models/expirationIntervalUnit.ts new file mode 100644 index 00000000..f0b9c52f --- /dev/null +++ b/src/models/expirationIntervalUnit.ts @@ -0,0 +1,23 @@ +/** + * AdvancedBilling + * + * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). + */ + +import { Schema, stringEnum } from '../schema'; + +/** + * Enum for ExpirationIntervalUnit + */ +export enum ExpirationIntervalUnit { + Day = 'day', + Month = 'month', + Never = 'never', +} + +/** + * Schema for ExpirationIntervalUnit + */ +export const expirationIntervalUnitSchema: Schema = stringEnum( + ExpirationIntervalUnit +); diff --git a/src/models/extendedIntervalUnit.ts b/src/models/extendedIntervalUnit.ts deleted file mode 100644 index 2243ef10..00000000 --- a/src/models/extendedIntervalUnit.ts +++ /dev/null @@ -1,23 +0,0 @@ -/** - * Maxio Advanced BillingLib - * - * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). - */ - -import { Schema, stringEnum } from '../schema'; - -/** - * Enum for ExtendedIntervalUnit - */ -export enum ExtendedIntervalUnit { - Day = 'day', - Month = 'month', - Never = 'never', -} - -/** - * Schema for ExtendedIntervalUnit - */ -export const extendedIntervalUnitSchema: Schema = stringEnum( - ExtendedIntervalUnit -); diff --git a/src/models/failedPaymentAction.ts b/src/models/failedPaymentAction.ts index e4bd1c48..7644ed28 100644 --- a/src/models/failedPaymentAction.ts +++ b/src/models/failedPaymentAction.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/failedPaymentEvent.ts b/src/models/failedPaymentEvent.ts index 17d70e04..2cf14b60 100644 --- a/src/models/failedPaymentEvent.ts +++ b/src/models/failedPaymentEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/failedPaymentEventData.ts b/src/models/failedPaymentEventData.ts index 41da6482..31a10e8d 100644 --- a/src/models/failedPaymentEventData.ts +++ b/src/models/failedPaymentEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/firstChargeType.ts b/src/models/firstChargeType.ts index 8b14a6a0..e68ca6f4 100644 --- a/src/models/firstChargeType.ts +++ b/src/models/firstChargeType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/fullSubscriptionGroupResponse.ts b/src/models/fullSubscriptionGroupResponse.ts index 05baebd1..d9799012 100644 --- a/src/models/fullSubscriptionGroupResponse.ts +++ b/src/models/fullSubscriptionGroupResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -47,16 +47,16 @@ export interface FullSubscriptionGroupResponse { * * **Problem States** * * `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers. * * `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed. - * * `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) settings to have a Final Action of `mark the subscription unpaid`. + * * `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) settings to have a Final Action of `mark the subscription unpaid`. * * **End of Life States** - * * `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) process without payment. See the [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404559291021) documentation for info on how to restart a canceled subscription. + * * `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) documentation for info on how to restart a canceled subscription. * While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance. * * `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period. * * `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.) * * `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time. * * `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state. - * * `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221) for more details. - * See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773) for more info about subscription states and state transitions. + * * `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing) for more details. + * See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscription-States) for more info about subscription states and state transitions. */ state?: SubscriptionState; cancelAtEndOfPeriod?: boolean; diff --git a/src/models/getOneTimeTokenPaymentProfile.ts b/src/models/getOneTimeTokenPaymentProfile.ts index 68d2ae7d..b7d33fea 100644 --- a/src/models/getOneTimeTokenPaymentProfile.ts +++ b/src/models/getOneTimeTokenPaymentProfile.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -14,7 +14,7 @@ import { string, } from '../schema'; import { CardType, cardTypeSchema } from './cardType'; -import { CurrentVault, currentVaultSchema } from './currentVault'; +import { CreditCardVault, creditCardVaultSchema } from './creditCardVault'; export interface GetOneTimeTokenPaymentProfile { id?: string | null; @@ -27,7 +27,7 @@ export interface GetOneTimeTokenPaymentProfile { expirationYear: number; customerId?: string | null; /** The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. */ - currentVault: CurrentVault; + currentVault: CreditCardVault; vaultToken: string; billingAddress: string; billingAddress2?: string; @@ -53,7 +53,7 @@ export const getOneTimeTokenPaymentProfileSchema: Schema = expandoObject({ 'previous_balance_data', optional(lazy(() => invoicePreviousBalanceSchema)), ], + publicUrlExpiresOn: ['public_url_expires_on', optional(string())], }); diff --git a/src/models/invoiceAddress.ts b/src/models/invoiceAddress.ts index 7fb40d5c..15ece0e3 100644 --- a/src/models/invoiceAddress.ts +++ b/src/models/invoiceAddress.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceBalanceItem.ts b/src/models/invoiceBalanceItem.ts index ae3727f3..255892eb 100644 --- a/src/models/invoiceBalanceItem.ts +++ b/src/models/invoiceBalanceItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceConsolidationLevel.ts b/src/models/invoiceConsolidationLevel.ts index 5da6029c..69a70024 100644 --- a/src/models/invoiceConsolidationLevel.ts +++ b/src/models/invoiceConsolidationLevel.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceCredit.ts b/src/models/invoiceCredit.ts index 52122694..1e41c693 100644 --- a/src/models/invoiceCredit.ts +++ b/src/models/invoiceCredit.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceCustomField.ts b/src/models/invoiceCustomField.ts index 7eb6b7f7..8cfacc2b 100644 --- a/src/models/invoiceCustomField.ts +++ b/src/models/invoiceCustomField.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceCustomer.ts b/src/models/invoiceCustomer.ts index 9886e32b..41ceb7ed 100644 --- a/src/models/invoiceCustomer.ts +++ b/src/models/invoiceCustomer.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceDateField.ts b/src/models/invoiceDateField.ts index 4ee9b172..c3048adc 100644 --- a/src/models/invoiceDateField.ts +++ b/src/models/invoiceDateField.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceDiscount.ts b/src/models/invoiceDiscount.ts index 75155398..d9daaace 100644 --- a/src/models/invoiceDiscount.ts +++ b/src/models/invoiceDiscount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceDiscountBreakout.ts b/src/models/invoiceDiscountBreakout.ts index 4d9fc856..64b5b4c6 100644 --- a/src/models/invoiceDiscountBreakout.ts +++ b/src/models/invoiceDiscountBreakout.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceDiscountSourceType.ts b/src/models/invoiceDiscountSourceType.ts index 759bf3dc..b2cedc11 100644 --- a/src/models/invoiceDiscountSourceType.ts +++ b/src/models/invoiceDiscountSourceType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceDiscountType.ts b/src/models/invoiceDiscountType.ts index 8cbadad1..4f7a8d08 100644 --- a/src/models/invoiceDiscountType.ts +++ b/src/models/invoiceDiscountType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceDisplaySettings.ts b/src/models/invoiceDisplaySettings.ts index 25335201..82f18a28 100644 --- a/src/models/invoiceDisplaySettings.ts +++ b/src/models/invoiceDisplaySettings.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceEventPaymentMethod.ts b/src/models/invoiceEventPaymentMethod.ts index f8caefb2..f5d19920 100644 --- a/src/models/invoiceEventPaymentMethod.ts +++ b/src/models/invoiceEventPaymentMethod.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceEventType.ts b/src/models/invoiceEventType.ts index af2f55c5..3c8ee2a5 100644 --- a/src/models/invoiceEventType.ts +++ b/src/models/invoiceEventType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceIssued.ts b/src/models/invoiceIssued.ts index df8d9c12..2d698c27 100644 --- a/src/models/invoiceIssued.ts +++ b/src/models/invoiceIssued.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceLineItem.ts b/src/models/invoiceLineItem.ts index 42d05548..f73c4f28 100644 --- a/src/models/invoiceLineItem.ts +++ b/src/models/invoiceLineItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceLineItemComponentCostData.ts b/src/models/invoiceLineItemComponentCostData.ts index 4c9e3638..d62cee03 100644 --- a/src/models/invoiceLineItemComponentCostData.ts +++ b/src/models/invoiceLineItemComponentCostData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceLineItemEventData.ts b/src/models/invoiceLineItemEventData.ts index 530d2bce..2b50fe94 100644 --- a/src/models/invoiceLineItemEventData.ts +++ b/src/models/invoiceLineItemEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceLineItemPricingDetail.ts b/src/models/invoiceLineItemPricingDetail.ts index 2bae2121..2b213487 100644 --- a/src/models/invoiceLineItemPricingDetail.ts +++ b/src/models/invoiceLineItemPricingDetail.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoicePayer.ts b/src/models/invoicePayer.ts index 9c6435f8..3a0b4273 100644 --- a/src/models/invoicePayer.ts +++ b/src/models/invoicePayer.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoicePayerChange.ts b/src/models/invoicePayerChange.ts index 2ccc07aa..9d3769ca 100644 --- a/src/models/invoicePayerChange.ts +++ b/src/models/invoicePayerChange.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoicePayment.ts b/src/models/invoicePayment.ts index 0d70e86c..7daab60b 100644 --- a/src/models/invoicePayment.ts +++ b/src/models/invoicePayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoicePaymentApplication.ts b/src/models/invoicePaymentApplication.ts index 8141b61b..dbd979a5 100644 --- a/src/models/invoicePaymentApplication.ts +++ b/src/models/invoicePaymentApplication.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoicePaymentMethod.ts b/src/models/invoicePaymentMethod.ts index b9304bcb..8b5d8afa 100644 --- a/src/models/invoicePaymentMethod.ts +++ b/src/models/invoicePaymentMethod.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoicePaymentMethodType.ts b/src/models/invoicePaymentMethodType.ts index 31b8a72e..0e72cbf2 100644 --- a/src/models/invoicePaymentMethodType.ts +++ b/src/models/invoicePaymentMethodType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoicePaymentType.ts b/src/models/invoicePaymentType.ts index c6a18d45..a8b6c336 100644 --- a/src/models/invoicePaymentType.ts +++ b/src/models/invoicePaymentType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoicePrePayment.ts b/src/models/invoicePrePayment.ts index 3411c60c..b01f8a70 100644 --- a/src/models/invoicePrePayment.ts +++ b/src/models/invoicePrePayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoicePreviousBalance.ts b/src/models/invoicePreviousBalance.ts index 0903d121..c060ddb3 100644 --- a/src/models/invoicePreviousBalance.ts +++ b/src/models/invoicePreviousBalance.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceRefund.ts b/src/models/invoiceRefund.ts index 979bc23c..5d360da6 100644 --- a/src/models/invoiceRefund.ts +++ b/src/models/invoiceRefund.ts @@ -1,10 +1,11 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { + boolean, expandoObject, nullable, number, @@ -23,6 +24,7 @@ export interface InvoiceRefund { gatewayTransactionId?: string | null; gatewayUsed?: string; gatewayHandle?: string | null; + achLateReject?: boolean | null; [key: string]: unknown; } @@ -38,4 +40,5 @@ export const invoiceRefundSchema: Schema = expandoObject({ ], gatewayUsed: ['gateway_used', optional(string())], gatewayHandle: ['gateway_handle', optional(nullable(string()))], + achLateReject: ['ach_late_reject', optional(nullable(boolean()))], }); diff --git a/src/models/invoiceResponse.ts b/src/models/invoiceResponse.ts index 84622555..bcc26e59 100644 --- a/src/models/invoiceResponse.ts +++ b/src/models/invoiceResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceRole.ts b/src/models/invoiceRole.ts index 9ac97a2f..93e8b53a 100644 --- a/src/models/invoiceRole.ts +++ b/src/models/invoiceRole.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceSeller.ts b/src/models/invoiceSeller.ts index 40259f31..cb7fa455 100644 --- a/src/models/invoiceSeller.ts +++ b/src/models/invoiceSeller.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceSortField.ts b/src/models/invoiceSortField.ts index 2cdeef9e..3a329b6b 100644 --- a/src/models/invoiceSortField.ts +++ b/src/models/invoiceSortField.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceStatus.ts b/src/models/invoiceStatus.ts index eb7bdd78..8bd36a06 100644 --- a/src/models/invoiceStatus.ts +++ b/src/models/invoiceStatus.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceTax.ts b/src/models/invoiceTax.ts index 7c2ca1cb..b9617a90 100644 --- a/src/models/invoiceTax.ts +++ b/src/models/invoiceTax.ts @@ -1,11 +1,12 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { array, + boolean, expandoObject, lazy, nullable, @@ -39,6 +40,9 @@ export interface InvoiceTax { transactionId?: number; lineItemBreakouts?: InvoiceTaxBreakout[]; taxComponentBreakouts?: InvoiceTaxComponentBreakout[]; + euVat?: boolean; + type?: string; + taxExemptAmount?: string; [key: string]: unknown; } @@ -60,4 +64,7 @@ export const invoiceTaxSchema: Schema = expandoObject({ 'tax_component_breakouts', optional(array(lazy(() => invoiceTaxComponentBreakoutSchema))), ], + euVat: ['eu_vat', optional(boolean())], + type: ['type', optional(string())], + taxExemptAmount: ['tax_exempt_amount', optional(string())], }); diff --git a/src/models/invoiceTaxBreakout.ts b/src/models/invoiceTaxBreakout.ts index de3ad5e5..5e0a212e 100644 --- a/src/models/invoiceTaxBreakout.ts +++ b/src/models/invoiceTaxBreakout.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/invoiceTaxComponentBreakout.ts b/src/models/invoiceTaxComponentBreakout.ts index 5c273000..4e3da04a 100644 --- a/src/models/invoiceTaxComponentBreakout.ts +++ b/src/models/invoiceTaxComponentBreakout.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -11,6 +11,16 @@ export interface InvoiceTaxComponentBreakout { percentage?: string; countryCode?: string; subdivisionCode?: string; + taxAmount?: string; + taxableAmount?: string; + taxExemptAmount?: string; + nonTaxableAmount?: string; + taxName?: string; + taxType?: string; + rateType?: string; + taxAuthorityType?: number; + stateAssignedNo?: string; + taxSubType?: string; [key: string]: unknown; } @@ -20,5 +30,15 @@ export const invoiceTaxComponentBreakoutSchema: Schema = expandoObject({ ], publicSignupPageIds: ['public_signup_page_ids', optional(array(number()))], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], }); diff --git a/src/models/meteredUsage.ts b/src/models/meteredUsage.ts index 86414fd2..6b0bc707 100644 --- a/src/models/meteredUsage.ts +++ b/src/models/meteredUsage.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/movement.ts b/src/models/movement.ts index e9d68842..ea734dd7 100644 --- a/src/models/movement.ts +++ b/src/models/movement.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/movementLineItem.ts b/src/models/movementLineItem.ts index 193dc14f..7e897e9b 100644 --- a/src/models/movementLineItem.ts +++ b/src/models/movementLineItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/multiInvoicePayment.ts b/src/models/multiInvoicePayment.ts index a390d509..6becfe56 100644 --- a/src/models/multiInvoicePayment.ts +++ b/src/models/multiInvoicePayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/multiInvoicePaymentResponse.ts b/src/models/multiInvoicePaymentResponse.ts index aaf223e6..5b3db3bf 100644 --- a/src/models/multiInvoicePaymentResponse.ts +++ b/src/models/multiInvoicePaymentResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/nestedSubscriptionGroup.ts b/src/models/nestedSubscriptionGroup.ts index fe74652d..1bb29e6c 100644 --- a/src/models/nestedSubscriptionGroup.ts +++ b/src/models/nestedSubscriptionGroup.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/netTerms.ts b/src/models/netTerms.ts index 83ad88d6..dfa42cc9 100644 --- a/src/models/netTerms.ts +++ b/src/models/netTerms.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/offer.ts b/src/models/offer.ts index 2940cd66..d8a9060c 100644 --- a/src/models/offer.ts +++ b/src/models/offer.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/offerDiscount.ts b/src/models/offerDiscount.ts index 7b7b03d7..2ee1cd71 100644 --- a/src/models/offerDiscount.ts +++ b/src/models/offerDiscount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/offerItem.ts b/src/models/offerItem.ts index f29c7de1..c10fc1fb 100644 --- a/src/models/offerItem.ts +++ b/src/models/offerItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -9,6 +9,7 @@ import { boolean, expandoObject, lazy, + nullable, number, optional, Schema, @@ -29,7 +30,7 @@ export interface OfferItem { /** The numerical interval. i.e. an interval of '30' coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; [key: string]: unknown; } @@ -46,5 +47,5 @@ export const offerItemSchema: Schema = expandoObject({ optional(array(lazy(() => currencyPriceSchema))), ], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], }); diff --git a/src/models/offerResponse.ts b/src/models/offerResponse.ts index 76a3c038..5299c79d 100644 --- a/src/models/offerResponse.ts +++ b/src/models/offerResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/offerSignupPage.ts b/src/models/offerSignupPage.ts index 6977120c..2893d0d6 100644 --- a/src/models/offerSignupPage.ts +++ b/src/models/offerSignupPage.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/onOffComponent.ts b/src/models/onOffComponent.ts index 7bdcaa2f..3a44f6f4 100644 --- a/src/models/onOffComponent.ts +++ b/src/models/onOffComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -36,7 +36,7 @@ export interface OnOffComponent { handle?: string; /** Boolean flag describing whether a component is taxable or not. */ taxable?: boolean; - /** (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. */ + /** (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261191737101-Price-Points-Components) for an overview of how price brackets work for different pricing schemes. */ prices?: Price[]; /** * The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. @@ -63,7 +63,7 @@ export interface OnOffComponent { /** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; [key: string]: unknown; } @@ -90,5 +90,5 @@ export const onOffComponentSchema: Schema = expandoObject({ ], publicSignupPageIds: ['public_signup_page_ids', optional(array(number()))], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], }); diff --git a/src/models/organizationAddress.ts b/src/models/organizationAddress.ts index 2f3828d3..e1bb0ed3 100644 --- a/src/models/organizationAddress.ts +++ b/src/models/organizationAddress.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/originInvoice.ts b/src/models/originInvoice.ts index ebb48211..df5c796c 100644 --- a/src/models/originInvoice.ts +++ b/src/models/originInvoice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/overagePricing.ts b/src/models/overagePricing.ts index 03941c8b..6fb1dec5 100644 --- a/src/models/overagePricing.ts +++ b/src/models/overagePricing.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/overrideSubscription.ts b/src/models/overrideSubscription.ts index ebdbf5d5..4304d230 100644 --- a/src/models/overrideSubscription.ts +++ b/src/models/overrideSubscription.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/overrideSubscriptionRequest.ts b/src/models/overrideSubscriptionRequest.ts index 1d99b33d..7546cae3 100644 --- a/src/models/overrideSubscriptionRequest.ts +++ b/src/models/overrideSubscriptionRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paginatedMetadata.ts b/src/models/paginatedMetadata.ts index d0966be7..b225d93d 100644 --- a/src/models/paginatedMetadata.ts +++ b/src/models/paginatedMetadata.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paidInvoice.ts b/src/models/paidInvoice.ts index cacf7730..19437afc 100644 --- a/src/models/paidInvoice.ts +++ b/src/models/paidInvoice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -10,7 +10,7 @@ import { InvoiceStatus, invoiceStatusSchema } from './invoiceStatus'; export interface PaidInvoice { /** The uid of the paid invoice */ invoiceId?: string; - /** The current status of the invoice. See [Invoice Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253-Introduction-to-Invoices#invoice-statuses) for more. */ + /** The current status of the invoice. See [Invoice Statuses](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview#invoice-statuses) for more. */ status?: InvoiceStatus; /** The remaining due amount on the invoice */ dueAmount?: string; diff --git a/src/models/pauseRequest.ts b/src/models/pauseRequest.ts index 50e4d5bc..fe76e863 100644 --- a/src/models/pauseRequest.ts +++ b/src/models/pauseRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/payPalVault.ts b/src/models/payPalVault.ts new file mode 100644 index 00000000..0050b538 --- /dev/null +++ b/src/models/payPalVault.ts @@ -0,0 +1,22 @@ +/** + * AdvancedBilling + * + * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). + */ + +import { Schema, stringEnum } from '../schema'; + +/** + * Enum for PayPalVault + */ +export enum PayPalVault { + BraintreeBlue = 'braintree_blue', + Paypal = 'paypal', + Moduslink = 'moduslink', + PaypalComplete = 'paypal_complete', +} + +/** + * Schema for PayPalVault + */ +export const payPalVaultSchema: Schema = stringEnum(PayPalVault); diff --git a/src/models/payerAttributes.ts b/src/models/payerAttributes.ts index 73d23ea3..5cc022b3 100644 --- a/src/models/payerAttributes.ts +++ b/src/models/payerAttributes.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/payerError.ts b/src/models/payerError.ts index 2f0adfc5..1505393e 100644 --- a/src/models/payerError.ts +++ b/src/models/payerError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paymentCollectionMethodChanged.ts b/src/models/paymentCollectionMethodChanged.ts index 06ed3bfa..ccead723 100644 --- a/src/models/paymentCollectionMethodChanged.ts +++ b/src/models/paymentCollectionMethodChanged.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paymentForAllocation.ts b/src/models/paymentForAllocation.ts index 3fcc3a0f..6c61d50a 100644 --- a/src/models/paymentForAllocation.ts +++ b/src/models/paymentForAllocation.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paymentMethodApplePay.ts b/src/models/paymentMethodApplePay.ts index f5791928..dddda9d6 100644 --- a/src/models/paymentMethodApplePay.ts +++ b/src/models/paymentMethodApplePay.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paymentMethodBankAccount.ts b/src/models/paymentMethodBankAccount.ts index a610fa7c..e5db013b 100644 --- a/src/models/paymentMethodBankAccount.ts +++ b/src/models/paymentMethodBankAccount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paymentMethodCreditCard.ts b/src/models/paymentMethodCreditCard.ts index abab164c..129bc52a 100644 --- a/src/models/paymentMethodCreditCard.ts +++ b/src/models/paymentMethodCreditCard.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paymentMethodExternal.ts b/src/models/paymentMethodExternal.ts index b92943a0..372c2fa5 100644 --- a/src/models/paymentMethodExternal.ts +++ b/src/models/paymentMethodExternal.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paymentMethodPaypal.ts b/src/models/paymentMethodPaypal.ts index dd8ad94b..a1b1b5e0 100644 --- a/src/models/paymentMethodPaypal.ts +++ b/src/models/paymentMethodPaypal.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paymentProfileAttributes.ts b/src/models/paymentProfileAttributes.ts index 4e14f4bc..89688c88 100644 --- a/src/models/paymentProfileAttributes.ts +++ b/src/models/paymentProfileAttributes.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -12,6 +12,7 @@ import { Schema, string, } from '../schema'; +import { AllVaults, allVaultsSchema } from './allVaults'; import { CardType, cardTypeSchema } from './cardType'; import { PaymentProfileAttributesExpirationMonth, @@ -21,14 +22,14 @@ import { PaymentProfileAttributesExpirationYear, paymentProfileAttributesExpirationYearSchema, } from './containers/paymentProfileAttributesExpirationYear'; -import { CurrentVault, currentVaultSchema } from './currentVault'; +import { PaymentType, paymentTypeSchema } from './paymentType'; /** alias to credit_card_attributes */ export interface PaymentProfileAttributes { - /** (Optional) Token received after sending billing informations using chargify.js. This token must be passed as a sole attribute of `payment_profile_attributes` (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) */ + /** (Optional) Token received after sending billing information using chargify.js. This token must be passed as a sole attribute of `payment_profile_attributes` (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) */ chargifyToken?: string; id?: number; - paymentType?: string; + paymentType?: PaymentType; /** (Optional) First name on card or bank account. If omitted, the first_name from customer attributes will be used. */ firstName?: string; /** (Optional) Last name on card or bank account. If omitted, the last_name from customer attributes will be used. */ @@ -55,7 +56,7 @@ export interface PaymentProfileAttributes { /** (Optional, may be required by your product configuration or gateway settings) The credit card or bank account billing address zip code (i.e. 12345). This value is merely passed through to the payment gateway. */ billingZip?: string; /** (Optional, used only for Subscription Import) The vault that stores the payment profile with the provided vault_token. */ - currentVault?: CurrentVault; + currentVault?: AllVaults; /** (Optional, used only for Subscription Import) The “token” provided by your vault storage for an already stored payment profile */ vaultToken?: string; /** (Optional, used only for Subscription Import) (only for Authorize.Net CIM storage or Square) The customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token */ @@ -77,7 +78,7 @@ export const paymentProfileAttributesSchema: Schema = { chargifyToken: ['chargify_token', optional(string())], id: ['id', optional(number())], - paymentType: ['payment_type', optional(string())], + paymentType: ['payment_type', optional(paymentTypeSchema)], firstName: ['first_name', optional(string())], lastName: ['last_name', optional(string())], maskedCardNumber: ['masked_card_number', optional(string())], @@ -97,7 +98,7 @@ export const paymentProfileAttributesSchema: Schema = billingState: ['billing_state', optional(string())], billingCountry: ['billing_country', optional(string())], billingZip: ['billing_zip', optional(string())], - currentVault: ['current_vault', optional(currentVaultSchema)], + currentVault: ['current_vault', optional(allVaultsSchema)], vaultToken: ['vault_token', optional(string())], customerVaultToken: ['customer_vault_token', optional(string())], customerId: ['customer_id', optional(number())], diff --git a/src/models/paymentProfileResponse.ts b/src/models/paymentProfileResponse.ts index a2e71811..1b636034 100644 --- a/src/models/paymentProfileResponse.ts +++ b/src/models/paymentProfileResponse.ts @@ -1,25 +1,20 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { expandoObject, Schema } from '../schema'; import { - PaymentProfileResponsePaymentProfile, - paymentProfileResponsePaymentProfileSchema, -} from './containers/paymentProfileResponsePaymentProfile'; + PaymentProfile, + paymentProfileSchema, +} from './containers/paymentProfile'; export interface PaymentProfileResponse { - paymentProfile: PaymentProfileResponsePaymentProfile; + paymentProfile: PaymentProfile; [key: string]: unknown; } export const paymentProfileResponseSchema: Schema = expandoObject( - { - paymentProfile: [ - 'payment_profile', - paymentProfileResponsePaymentProfileSchema, - ], - } + { paymentProfile: ['payment_profile', paymentProfileSchema] } ); diff --git a/src/models/paymentRelatedEvents.ts b/src/models/paymentRelatedEvents.ts index 797db80e..b94974cf 100644 --- a/src/models/paymentRelatedEvents.ts +++ b/src/models/paymentRelatedEvents.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/paymentType.ts b/src/models/paymentType.ts index 3c74ddba..190f5415 100644 --- a/src/models/paymentType.ts +++ b/src/models/paymentType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -13,6 +13,7 @@ export enum PaymentType { CreditCard = 'credit_card', BankAccount = 'bank_account', PaypalAccount = 'paypal_account', + ApplePay = 'apple_pay', } /** diff --git a/src/models/paypalPaymentProfile.ts b/src/models/paypalPaymentProfile.ts new file mode 100644 index 00000000..622c34cd --- /dev/null +++ b/src/models/paypalPaymentProfile.ts @@ -0,0 +1,74 @@ +/** + * AdvancedBilling + * + * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). + */ + +import { + expandoObject, + nullable, + number, + optional, + Schema, + string, +} from '../schema'; +import { PaymentType, paymentTypeSchema } from './paymentType'; +import { PayPalVault, payPalVaultSchema } from './payPalVault'; + +export interface PaypalPaymentProfile { + /** The Chargify-assigned ID of the stored PayPal payment profile. */ + id?: number; + /** The first name of the PayPal account holder */ + firstName?: string; + /** The last name of the PayPal account holder */ + lastName?: string; + /** The Chargify-assigned id for the customer record to which the PayPal account belongs */ + customerId?: number; + /** The vault that stores the payment profile with the provided vault_token. */ + currentVault?: PayPalVault; + /** The “token” provided by your vault storage for an already stored payment profile */ + vaultToken?: string; + /** The current billing street address for the PayPal account */ + billingAddress?: string | null; + /** The current billing address city for the PayPal account */ + billingCity?: string | null; + /** The current billing address state for the PayPal account */ + billingState?: string | null; + /** The current billing address zip code for the PayPal account */ + billingZip?: string | null; + /** The current billing address country for the PayPal account */ + billingCountry?: string | null; + customerVaultToken?: string | null; + /** The current billing street address, second line, for the PayPal account */ + billingAddress2?: string | null; + paymentType: PaymentType; + siteGatewaySettingId?: number | null; + gatewayHandle?: string | null; + paypalEmail?: string; + [key: string]: unknown; +} + +export const paypalPaymentProfileSchema: Schema = expandoObject( + { + id: ['id', optional(number())], + firstName: ['first_name', optional(string())], + lastName: ['last_name', optional(string())], + customerId: ['customer_id', optional(number())], + currentVault: ['current_vault', optional(payPalVaultSchema)], + vaultToken: ['vault_token', optional(string())], + billingAddress: ['billing_address', optional(nullable(string()))], + billingCity: ['billing_city', optional(nullable(string()))], + billingState: ['billing_state', optional(nullable(string()))], + billingZip: ['billing_zip', optional(nullable(string()))], + billingCountry: ['billing_country', optional(nullable(string()))], + customerVaultToken: ['customer_vault_token', optional(nullable(string()))], + billingAddress2: ['billing_address_2', optional(nullable(string()))], + paymentType: ['payment_type', paymentTypeSchema], + siteGatewaySettingId: [ + 'site_gateway_setting_id', + optional(nullable(number())), + ], + gatewayHandle: ['gateway_handle', optional(nullable(string()))], + paypalEmail: ['paypal_email', optional(string())], + } +); diff --git a/src/models/pendingCancellationChange.ts b/src/models/pendingCancellationChange.ts index 92867644..507622e8 100644 --- a/src/models/pendingCancellationChange.ts +++ b/src/models/pendingCancellationChange.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/portalManagementLink.ts b/src/models/portalManagementLink.ts index 07293bc1..a3c423b4 100644 --- a/src/models/portalManagementLink.ts +++ b/src/models/portalManagementLink.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaidComponentPricePoint.ts b/src/models/prepaidComponentPricePoint.ts index 90dde06c..140cfe78 100644 --- a/src/models/prepaidComponentPricePoint.ts +++ b/src/models/prepaidComponentPricePoint.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaidConfiguration.ts b/src/models/prepaidConfiguration.ts index f8834661..a1795c47 100644 --- a/src/models/prepaidConfiguration.ts +++ b/src/models/prepaidConfiguration.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaidConfigurationResponse.ts b/src/models/prepaidConfigurationResponse.ts index 401d7c6d..4f83019c 100644 --- a/src/models/prepaidConfigurationResponse.ts +++ b/src/models/prepaidConfigurationResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaidProductPricePointFilter.ts b/src/models/prepaidProductPricePointFilter.ts index 1b19793d..5d12e9a2 100644 --- a/src/models/prepaidProductPricePointFilter.ts +++ b/src/models/prepaidProductPricePointFilter.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaidSubscriptionBalanceChanged.ts b/src/models/prepaidSubscriptionBalanceChanged.ts index 708a30f6..65f664ed 100644 --- a/src/models/prepaidSubscriptionBalanceChanged.ts +++ b/src/models/prepaidSubscriptionBalanceChanged.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaidUsage.ts b/src/models/prepaidUsage.ts index a884c0ca..2582a978 100644 --- a/src/models/prepaidUsage.ts +++ b/src/models/prepaidUsage.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaidUsageAllocationDetail.ts b/src/models/prepaidUsageAllocationDetail.ts index d53a5035..377f823d 100644 --- a/src/models/prepaidUsageAllocationDetail.ts +++ b/src/models/prepaidUsageAllocationDetail.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaidUsageComponent.ts b/src/models/prepaidUsageComponent.ts index 14fe7635..02caf3a1 100644 --- a/src/models/prepaidUsageComponent.ts +++ b/src/models/prepaidUsageComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -20,7 +20,10 @@ import { prepaidUsageComponentUnitPriceSchema, } from './containers/prepaidUsageComponentUnitPrice'; import { CreditType, creditTypeSchema } from './creditType'; -import { IntervalUnit, intervalUnitSchema } from './intervalUnit'; +import { + ExpirationIntervalUnit, + expirationIntervalUnitSchema, +} from './expirationIntervalUnit'; import { OveragePricing, overagePricingSchema } from './overagePricing'; import { PrepaidComponentPricePoint, @@ -42,7 +45,7 @@ export interface PrepaidUsageComponent { taxable?: boolean; /** The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. */ pricingScheme?: PricingScheme; - /** (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#general-price-bracket-rules) for an overview of how price brackets work for different pricing schemes. */ + /** (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Component-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. */ prices?: Price[]; /** * The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. @@ -70,7 +73,7 @@ export interface PrepaidUsageComponent { renewPrepaidAllocation?: boolean; /** (only for prepaid usage components where rollover_prepaid_remainder is true) The number of `expiration_interval_unit`s after which rollover amounts should expire */ expirationInterval?: number; - expirationIntervalUnit?: IntervalUnit; + expirationIntervalUnit?: ExpirationIntervalUnit | null; displayOnHostedPage?: boolean; allowFractionalQuantities?: boolean; publicSignupPageIds?: number[]; @@ -108,7 +111,7 @@ export const prepaidUsageComponentSchema: Schema = expand expirationInterval: ['expiration_interval', optional(number())], expirationIntervalUnit: [ 'expiration_interval_unit', - optional(intervalUnitSchema), + optional(nullable(expirationIntervalUnitSchema)), ], displayOnHostedPage: ['display_on_hosted_page', optional(boolean())], allowFractionalQuantities: [ diff --git a/src/models/prepayment.ts b/src/models/prepayment.ts index 037e984d..c03b7d81 100644 --- a/src/models/prepayment.ts +++ b/src/models/prepayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaymentAccountBalanceChanged.ts b/src/models/prepaymentAccountBalanceChanged.ts index 1d80502e..8c4b5f1b 100644 --- a/src/models/prepaymentAccountBalanceChanged.ts +++ b/src/models/prepaymentAccountBalanceChanged.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaymentMethod.ts b/src/models/prepaymentMethod.ts index 7c9610e7..af81d1a2 100644 --- a/src/models/prepaymentMethod.ts +++ b/src/models/prepaymentMethod.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaymentResponse.ts b/src/models/prepaymentResponse.ts index c3c571fb..b3e63cff 100644 --- a/src/models/prepaymentResponse.ts +++ b/src/models/prepaymentResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/prepaymentsResponse.ts b/src/models/prepaymentsResponse.ts index cbcbe645..1ffe57f8 100644 --- a/src/models/prepaymentsResponse.ts +++ b/src/models/prepaymentsResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/previewAllocationsRequest.ts b/src/models/previewAllocationsRequest.ts index 595ac8f5..f6870c96 100644 --- a/src/models/previewAllocationsRequest.ts +++ b/src/models/previewAllocationsRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/price.ts b/src/models/price.ts index c4a03937..5a5679e9 100644 --- a/src/models/price.ts +++ b/src/models/price.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/pricePointType.ts b/src/models/pricePointType.ts index 084b77dd..3c4d1667 100644 --- a/src/models/pricePointType.ts +++ b/src/models/pricePointType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/pricingScheme.ts b/src/models/pricingScheme.ts index 1c52e2d4..a4a27a03 100644 --- a/src/models/pricingScheme.ts +++ b/src/models/pricingScheme.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/product.ts b/src/models/product.ts index e389c3eb..66efd267 100644 --- a/src/models/product.ts +++ b/src/models/product.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -17,9 +17,9 @@ import { string, } from '../schema'; import { - ExtendedIntervalUnit, - extendedIntervalUnitSchema, -} from './extendedIntervalUnit'; + ExpirationIntervalUnit, + expirationIntervalUnitSchema, +} from './expirationIntervalUnit'; import { IntervalUnit, intervalUnitSchema } from './intervalUnit'; import { ProductFamily, productFamilySchema } from './productFamily'; import { PublicSignupPage, publicSignupPageSchema } from './publicSignupPage'; @@ -38,8 +38,8 @@ export interface Product { requestCreditCard?: boolean; /** A numerical interval for the length a subscription to this product will run before it expires. See the description of interval for a description of how this value is coupled with an interval unit to calculate the full interval */ expirationInterval?: number | null; - /** A string representing the expiration interval unit for this product, either month or day */ - expirationIntervalUnit?: ExtendedIntervalUnit | null; + /** A string representing the expiration interval unit for this product, either month, day or never */ + expirationIntervalUnit?: ExpirationIntervalUnit | null; /** Timestamp indicating when this product was created */ createdAt?: string; /** Timestamp indicating when this product was last updated */ @@ -101,7 +101,7 @@ export const productSchema: Schema = expandoObject({ expirationInterval: ['expiration_interval', optional(nullable(number()))], expirationIntervalUnit: [ 'expiration_interval_unit', - optional(nullable(extendedIntervalUnitSchema)), + optional(nullable(expirationIntervalUnitSchema)), ], createdAt: ['created_at', optional(string())], updatedAt: ['updated_at', optional(string())], diff --git a/src/models/productFamily.ts b/src/models/productFamily.ts index a1acd334..4cf4e67e 100644 --- a/src/models/productFamily.ts +++ b/src/models/productFamily.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/productFamilyResponse.ts b/src/models/productFamilyResponse.ts index e33e0acb..a67015b4 100644 --- a/src/models/productFamilyResponse.ts +++ b/src/models/productFamilyResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/productPricePoint.ts b/src/models/productPricePoint.ts index 90816e76..f5e72bc0 100644 --- a/src/models/productPricePoint.ts +++ b/src/models/productPricePoint.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -17,6 +17,10 @@ import { string, } from '../schema'; import { CurrencyPrice, currencyPriceSchema } from './currencyPrice'; +import { + ExpirationIntervalUnit, + expirationIntervalUnitSchema, +} from './expirationIntervalUnit'; import { IntervalUnit, intervalUnitSchema } from './intervalUnit'; import { PricePointType, pricePointTypeSchema } from './pricePointType'; @@ -46,8 +50,8 @@ export interface ProductPricePoint { initialChargeAfterTrial?: boolean | null; /** The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product price point would expire after 30 days */ expirationInterval?: number | null; - /** A string representing the expiration interval unit for this product price point, either month or day */ - expirationIntervalUnit?: IntervalUnit | null; + /** A string representing the expiration interval unit for this product price point, either month, day or never */ + expirationIntervalUnit?: ExpirationIntervalUnit | null; /** The product id this price point belongs to */ productId?: number; /** Timestamp indicating when this price point was archived */ @@ -96,7 +100,7 @@ export const productPricePointSchema: Schema = expandoObject( expirationInterval: ['expiration_interval', optional(nullable(number()))], expirationIntervalUnit: [ 'expiration_interval_unit', - optional(nullable(intervalUnitSchema)), + optional(nullable(expirationIntervalUnitSchema)), ], productId: ['product_id', optional(number())], archivedAt: ['archived_at', optional(nullable(string()))], diff --git a/src/models/productPricePointErrors.ts b/src/models/productPricePointErrors.ts index 52db8fdc..2ecd5482 100644 --- a/src/models/productPricePointErrors.ts +++ b/src/models/productPricePointErrors.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/productPricePointResponse.ts b/src/models/productPricePointResponse.ts index 95f87957..a2aefabe 100644 --- a/src/models/productPricePointResponse.ts +++ b/src/models/productPricePointResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/productResponse.ts b/src/models/productResponse.ts index 1b3b2402..52ac31d5 100644 --- a/src/models/productResponse.ts +++ b/src/models/productResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proformaError.ts b/src/models/proformaError.ts index 9bd602c3..e4c40038 100644 --- a/src/models/proformaError.ts +++ b/src/models/proformaError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proformaInvoice.ts b/src/models/proformaInvoice.ts index 2698de91..5e26d3c1 100644 --- a/src/models/proformaInvoice.ts +++ b/src/models/proformaInvoice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -72,7 +72,7 @@ export interface ProformaInvoice { * * "child": An invoice segment which has been combined into a consolidated invoice. * * "parent": A consolidated invoice, whose contents are composed of invoice segments. * "Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments. - * See also the [invoice consolidation documentation](https://chargify.zendesk.com/hc/en-us/articles/4407746391835). + * See also the [invoice consolidation documentation](https://maxio.zendesk.com/hc/en-us/articles/24252269909389-Invoice-Consolidation). */ consolidationLevel?: InvoiceConsolidationLevel; productName?: string; diff --git a/src/models/proformaInvoiceCredit.ts b/src/models/proformaInvoiceCredit.ts index a3da1240..f273c748 100644 --- a/src/models/proformaInvoiceCredit.ts +++ b/src/models/proformaInvoiceCredit.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proformaInvoiceDiscount.ts b/src/models/proformaInvoiceDiscount.ts index c0bd13b7..6dd032cb 100644 --- a/src/models/proformaInvoiceDiscount.ts +++ b/src/models/proformaInvoiceDiscount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proformaInvoiceDiscountSourceType.ts b/src/models/proformaInvoiceDiscountSourceType.ts index b6ce55f6..085cded8 100644 --- a/src/models/proformaInvoiceDiscountSourceType.ts +++ b/src/models/proformaInvoiceDiscountSourceType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proformaInvoiceIssued.ts b/src/models/proformaInvoiceIssued.ts index 4ac467fb..5f3f731c 100644 --- a/src/models/proformaInvoiceIssued.ts +++ b/src/models/proformaInvoiceIssued.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proformaInvoicePayment.ts b/src/models/proformaInvoicePayment.ts index 06815ca6..a5229432 100644 --- a/src/models/proformaInvoicePayment.ts +++ b/src/models/proformaInvoicePayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proformaInvoiceRole.ts b/src/models/proformaInvoiceRole.ts index 5ad74f54..70931e4c 100644 --- a/src/models/proformaInvoiceRole.ts +++ b/src/models/proformaInvoiceRole.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proformaInvoiceStatus.ts b/src/models/proformaInvoiceStatus.ts index 8d199559..72dde460 100644 --- a/src/models/proformaInvoiceStatus.ts +++ b/src/models/proformaInvoiceStatus.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proformaInvoiceTax.ts b/src/models/proformaInvoiceTax.ts index 17707b26..640f719b 100644 --- a/src/models/proformaInvoiceTax.ts +++ b/src/models/proformaInvoiceTax.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proformaInvoiceTaxSourceType.ts b/src/models/proformaInvoiceTaxSourceType.ts index 2c56e40b..5216cb24 100644 --- a/src/models/proformaInvoiceTaxSourceType.ts +++ b/src/models/proformaInvoiceTaxSourceType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/proration.ts b/src/models/proration.ts index a9bab5d1..e4ab3b21 100644 --- a/src/models/proration.ts +++ b/src/models/proration.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/publicKey.ts b/src/models/publicKey.ts index 0715568c..f785c3d9 100644 --- a/src/models/publicKey.ts +++ b/src/models/publicKey.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/publicSignupPage.ts b/src/models/publicSignupPage.ts index 4273aa7a..9a708e31 100644 --- a/src/models/publicSignupPage.ts +++ b/src/models/publicSignupPage.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/quantityBasedComponent.ts b/src/models/quantityBasedComponent.ts index 4703d057..42ffe25d 100644 --- a/src/models/quantityBasedComponent.ts +++ b/src/models/quantityBasedComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -41,7 +41,7 @@ export interface QuantityBasedComponent { taxable?: boolean; /** The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. */ pricingScheme: PricingScheme; - /** (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. */ + /** (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Component-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. */ prices?: Price[]; /** * The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. @@ -69,7 +69,7 @@ export interface QuantityBasedComponent { /** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; [key: string]: unknown; } @@ -100,6 +100,6 @@ export const quantityBasedComponentSchema: Schema = expa ], publicSignupPageIds: ['public_signup_page_ids', optional(array(number()))], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], } ); diff --git a/src/models/reactivateSubscriptionGroupRequest.ts b/src/models/reactivateSubscriptionGroupRequest.ts index c167caab..7b68518f 100644 --- a/src/models/reactivateSubscriptionGroupRequest.ts +++ b/src/models/reactivateSubscriptionGroupRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/reactivateSubscriptionGroupResponse.ts b/src/models/reactivateSubscriptionGroupResponse.ts index 6fc46625..4402c6b6 100644 --- a/src/models/reactivateSubscriptionGroupResponse.ts +++ b/src/models/reactivateSubscriptionGroupResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/reactivateSubscriptionRequest.ts b/src/models/reactivateSubscriptionRequest.ts index 55b81630..fa41801b 100644 --- a/src/models/reactivateSubscriptionRequest.ts +++ b/src/models/reactivateSubscriptionRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/reactivationBilling.ts b/src/models/reactivationBilling.ts index 7d83af01..777da3e8 100644 --- a/src/models/reactivationBilling.ts +++ b/src/models/reactivationBilling.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/reactivationCharge.ts b/src/models/reactivationCharge.ts index d459622a..6d7a079f 100644 --- a/src/models/reactivationCharge.ts +++ b/src/models/reactivationCharge.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/reasonCode.ts b/src/models/reasonCode.ts index 090af5cf..ea2b2a0a 100644 --- a/src/models/reasonCode.ts +++ b/src/models/reasonCode.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/reasonCodeResponse.ts b/src/models/reasonCodeResponse.ts index de860881..89e6291c 100644 --- a/src/models/reasonCodeResponse.ts +++ b/src/models/reasonCodeResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/reasonCodesJsonResponse.ts b/src/models/reasonCodesJsonResponse.ts index 91f27f72..22605421 100644 --- a/src/models/reasonCodesJsonResponse.ts +++ b/src/models/reasonCodesJsonResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/recordPaymentRequest.ts b/src/models/recordPaymentRequest.ts index f8e09d23..3070f40d 100644 --- a/src/models/recordPaymentRequest.ts +++ b/src/models/recordPaymentRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/recordPaymentResponse.ts b/src/models/recordPaymentResponse.ts index 1a7cd01a..426d53ea 100644 --- a/src/models/recordPaymentResponse.ts +++ b/src/models/recordPaymentResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/recurringScheme.ts b/src/models/recurringScheme.ts index 6fd836aa..69510d28 100644 --- a/src/models/recurringScheme.ts +++ b/src/models/recurringScheme.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/referralCode.ts b/src/models/referralCode.ts index dad2d066..5508d5c8 100644 --- a/src/models/referralCode.ts +++ b/src/models/referralCode.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/referralValidationResponse.ts b/src/models/referralValidationResponse.ts index 20e348d4..8bc66c20 100644 --- a/src/models/referralValidationResponse.ts +++ b/src/models/referralValidationResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/refundConsolidatedInvoice.ts b/src/models/refundConsolidatedInvoice.ts index 7845e194..ae54838f 100644 --- a/src/models/refundConsolidatedInvoice.ts +++ b/src/models/refundConsolidatedInvoice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/refundInvoice.ts b/src/models/refundInvoice.ts index de75f201..b9fb27b7 100644 --- a/src/models/refundInvoice.ts +++ b/src/models/refundInvoice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/refundInvoiceEvent.ts b/src/models/refundInvoiceEvent.ts index e60d3320..344e3f80 100644 --- a/src/models/refundInvoiceEvent.ts +++ b/src/models/refundInvoiceEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/refundInvoiceEventData.ts b/src/models/refundInvoiceEventData.ts index ce5b9c8e..ace6ec12 100644 --- a/src/models/refundInvoiceEventData.ts +++ b/src/models/refundInvoiceEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -29,7 +29,7 @@ export interface RefundInvoiceEventData { * * "child": An invoice segment which has been combined into a consolidated invoice. * * "parent": A consolidated invoice, whose contents are composed of invoice segments. * "Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments. - * See also the [invoice consolidation documentation](https://chargify.zendesk.com/hc/en-us/articles/4407746391835). + * See also the [invoice consolidation documentation](https://maxio.zendesk.com/hc/en-us/articles/24252269909389-Invoice-Consolidation). */ consolidationLevel?: InvoiceConsolidationLevel; creditNoteAttributes: CreditNote; diff --git a/src/models/refundInvoiceRequest.ts b/src/models/refundInvoiceRequest.ts index 03bf248e..a9308a0a 100644 --- a/src/models/refundInvoiceRequest.ts +++ b/src/models/refundInvoiceRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/refundPrepayment.ts b/src/models/refundPrepayment.ts index 18e51988..aa2db6fd 100644 --- a/src/models/refundPrepayment.ts +++ b/src/models/refundPrepayment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/refundPrepaymentBaseRefundError.ts b/src/models/refundPrepaymentBaseRefundError.ts index 1828db65..d3cb9de4 100644 --- a/src/models/refundPrepaymentBaseRefundError.ts +++ b/src/models/refundPrepaymentBaseRefundError.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/refundPrepaymentRequest.ts b/src/models/refundPrepaymentRequest.ts index cee45f64..5700df22 100644 --- a/src/models/refundPrepaymentRequest.ts +++ b/src/models/refundPrepaymentRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/refundSuccess.ts b/src/models/refundSuccess.ts index 7b40b299..8ace443c 100644 --- a/src/models/refundSuccess.ts +++ b/src/models/refundSuccess.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/removePaymentEvent.ts b/src/models/removePaymentEvent.ts index 2265da0d..5c3b533c 100644 --- a/src/models/removePaymentEvent.ts +++ b/src/models/removePaymentEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/removePaymentEventData.ts b/src/models/removePaymentEventData.ts index 5aee42b5..029468ca 100644 --- a/src/models/removePaymentEventData.ts +++ b/src/models/removePaymentEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/renewalPreview.ts b/src/models/renewalPreview.ts index b32f92db..36ae174e 100644 --- a/src/models/renewalPreview.ts +++ b/src/models/renewalPreview.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/renewalPreviewComponent.ts b/src/models/renewalPreviewComponent.ts index bbf721b6..839f02d9 100644 --- a/src/models/renewalPreviewComponent.ts +++ b/src/models/renewalPreviewComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/renewalPreviewLineItem.ts b/src/models/renewalPreviewLineItem.ts index 759bddb7..c2a48e95 100644 --- a/src/models/renewalPreviewLineItem.ts +++ b/src/models/renewalPreviewLineItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/renewalPreviewRequest.ts b/src/models/renewalPreviewRequest.ts index 0cc2011a..0a69e8c6 100644 --- a/src/models/renewalPreviewRequest.ts +++ b/src/models/renewalPreviewRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/renewalPreviewResponse.ts b/src/models/renewalPreviewResponse.ts index 08c03f11..a6fa62c7 100644 --- a/src/models/renewalPreviewResponse.ts +++ b/src/models/renewalPreviewResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/replayWebhooksRequest.ts b/src/models/replayWebhooksRequest.ts index 1ab86c94..77c79391 100644 --- a/src/models/replayWebhooksRequest.ts +++ b/src/models/replayWebhooksRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/replayWebhooksResponse.ts b/src/models/replayWebhooksResponse.ts index a0af4d97..aeb5856b 100644 --- a/src/models/replayWebhooksResponse.ts +++ b/src/models/replayWebhooksResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/resentInvitation.ts b/src/models/resentInvitation.ts index 861e5bc1..6b0c74de 100644 --- a/src/models/resentInvitation.ts +++ b/src/models/resentInvitation.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -11,6 +11,8 @@ export interface ResentInvitation { lastAcceptedAt?: string; sendInviteLinkText?: string; uninvitedCount?: number; + lastInviteSentAt?: string; + lastInviteAcceptedAt?: string; [key: string]: unknown; } @@ -19,4 +21,6 @@ export const resentInvitationSchema: Schema = expandoObject({ lastAcceptedAt: ['last_accepted_at', optional(string())], sendInviteLinkText: ['send_invite_link_text', optional(string())], uninvitedCount: ['uninvited_count', optional(number())], + lastInviteSentAt: ['last_invite_sent_at', optional(string())], + lastInviteAcceptedAt: ['last_invite_accepted_at', optional(string())], }); diff --git a/src/models/resourceType.ts b/src/models/resourceType.ts index c6510061..c0992b31 100644 --- a/src/models/resourceType.ts +++ b/src/models/resourceType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/restrictionType.ts b/src/models/restrictionType.ts index d14751d7..9417d03a 100644 --- a/src/models/restrictionType.ts +++ b/src/models/restrictionType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/resumeOptions.ts b/src/models/resumeOptions.ts index 5143bd5f..c7d11d53 100644 --- a/src/models/resumeOptions.ts +++ b/src/models/resumeOptions.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/resumptionCharge.ts b/src/models/resumptionCharge.ts index 020abe98..c1f59e68 100644 --- a/src/models/resumptionCharge.ts +++ b/src/models/resumptionCharge.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/revokedInvitation.ts b/src/models/revokedInvitation.ts index e7082ec8..247943e1 100644 --- a/src/models/revokedInvitation.ts +++ b/src/models/revokedInvitation.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/saleRep.ts b/src/models/saleRep.ts index a49ff6f2..f820bc48 100644 --- a/src/models/saleRep.ts +++ b/src/models/saleRep.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/saleRepItemMrr.ts b/src/models/saleRepItemMrr.ts index fb626af1..70111b55 100644 --- a/src/models/saleRepItemMrr.ts +++ b/src/models/saleRepItemMrr.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/saleRepSettings.ts b/src/models/saleRepSettings.ts index 1d88228a..072bbf6d 100644 --- a/src/models/saleRepSettings.ts +++ b/src/models/saleRepSettings.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/saleRepSubscription.ts b/src/models/saleRepSubscription.ts index d16bd4ba..aac15361 100644 --- a/src/models/saleRepSubscription.ts +++ b/src/models/saleRepSubscription.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/segment.ts b/src/models/segment.ts index fed52d85..920d2f56 100644 --- a/src/models/segment.ts +++ b/src/models/segment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/segmentPrice.ts b/src/models/segmentPrice.ts index 9eefb73e..caa500ea 100644 --- a/src/models/segmentPrice.ts +++ b/src/models/segmentPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/segmentResponse.ts b/src/models/segmentResponse.ts index 068af5aa..5071efa9 100644 --- a/src/models/segmentResponse.ts +++ b/src/models/segmentResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/sendInvoiceRequest.ts b/src/models/sendInvoiceRequest.ts index 990df99e..91802052 100644 --- a/src/models/sendInvoiceRequest.ts +++ b/src/models/sendInvoiceRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/serviceCredit.ts b/src/models/serviceCredit.ts index 8163214e..d7c4ae41 100644 --- a/src/models/serviceCredit.ts +++ b/src/models/serviceCredit.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/serviceCreditResponse.ts b/src/models/serviceCreditResponse.ts index 403181fb..343819a7 100644 --- a/src/models/serviceCreditResponse.ts +++ b/src/models/serviceCreditResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/serviceCreditType.ts b/src/models/serviceCreditType.ts index 813b8c9f..65fb48a5 100644 --- a/src/models/serviceCreditType.ts +++ b/src/models/serviceCreditType.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/signupProformaPreview.ts b/src/models/signupProformaPreview.ts index f6c586f4..8afea711 100644 --- a/src/models/signupProformaPreview.ts +++ b/src/models/signupProformaPreview.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/signupProformaPreviewResponse.ts b/src/models/signupProformaPreviewResponse.ts index 67607dbc..cd547116 100644 --- a/src/models/signupProformaPreviewResponse.ts +++ b/src/models/signupProformaPreviewResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/site.ts b/src/models/site.ts index 587cc9bb..0a1c7abc 100644 --- a/src/models/site.ts +++ b/src/models/site.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/siteResponse.ts b/src/models/siteResponse.ts index 7f49f075..19087024 100644 --- a/src/models/siteResponse.ts +++ b/src/models/siteResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/siteStatistics.ts b/src/models/siteStatistics.ts index 6d04bd2b..813cfb5c 100644 --- a/src/models/siteStatistics.ts +++ b/src/models/siteStatistics.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/siteSummary.ts b/src/models/siteSummary.ts index 416f507b..2530ca56 100644 --- a/src/models/siteSummary.ts +++ b/src/models/siteSummary.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/snapDay.ts b/src/models/snapDay.ts index d9a39296..8fb7af84 100644 --- a/src/models/snapDay.ts +++ b/src/models/snapDay.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/sortingDirection.ts b/src/models/sortingDirection.ts index cc2c09b3..5b5fc5c2 100644 --- a/src/models/sortingDirection.ts +++ b/src/models/sortingDirection.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/subscription.ts b/src/models/subscription.ts index a20cce84..1af46c73 100644 --- a/src/models/subscription.ts +++ b/src/models/subscription.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -63,16 +63,16 @@ export interface Subscription { * * **Problem States** * * `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers. * * `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed. - * * `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) settings to have a Final Action of `mark the subscription unpaid`. + * * `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) settings to have a Final Action of `mark the subscription unpaid`. * * **End of Life States** - * * `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) process without payment. See the [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404559291021) documentation for info on how to restart a canceled subscription. + * * `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) documentation for info on how to restart a canceled subscription. * While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance. * * `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period. * * `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.) * * `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time. * * `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state. - * * `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221) for more details. - * See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773) for more info about subscription states and state transitions. + * * `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing) for more details. + * See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscription-States) for more info about subscription states and state transitions. */ state?: SubscriptionState; /** Gives the current outstanding subscription balance in the number of cents. */ diff --git a/src/models/subscriptionComponent.ts b/src/models/subscriptionComponent.ts index a7ac6d37..825c300f 100644 --- a/src/models/subscriptionComponent.ts +++ b/src/models/subscriptionComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -76,7 +76,7 @@ export interface SubscriptionComponent { /** The numerical interval. i.e. an interval of '30' coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */ interval?: number; /** A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. */ - intervalUnit?: IntervalUnit; + intervalUnit?: IntervalUnit | null; [key: string]: unknown; } @@ -131,6 +131,6 @@ export const subscriptionComponentSchema: Schema = expand ], displayOnHostedPage: ['display_on_hosted_page', optional(boolean())], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], } ); diff --git a/src/models/subscriptionComponentAllocationErrorItem.ts b/src/models/subscriptionComponentAllocationErrorItem.ts index b4bb2958..628eca3d 100644 --- a/src/models/subscriptionComponentAllocationErrorItem.ts +++ b/src/models/subscriptionComponentAllocationErrorItem.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/subscriptionComponentResponse.ts b/src/models/subscriptionComponentResponse.ts index 479d74ad..7e00622f 100644 --- a/src/models/subscriptionComponentResponse.ts +++ b/src/models/subscriptionComponentResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/subscriptionComponentSubscription.ts b/src/models/subscriptionComponentSubscription.ts index 5fe58677..389e6efb 100644 --- a/src/models/subscriptionComponentSubscription.ts +++ b/src/models/subscriptionComponentSubscription.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -23,16 +23,16 @@ export interface SubscriptionComponentSubscription { * * **Problem States** * * `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers. * * `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed. - * * `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) settings to have a Final Action of `mark the subscription unpaid`. + * * `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) settings to have a Final Action of `mark the subscription unpaid`. * * **End of Life States** - * * `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405505141005) process without payment. See the [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404559291021) documentation for info on how to restart a canceled subscription. + * * `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning-Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming) documentation for info on how to restart a canceled subscription. * While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance. * * `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period. * * `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.) * * `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time. * * `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state. - * * `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221) for more details. - * See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773) for more info about subscription states and state transitions. + * * `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-Editing) for more details. + * See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscription-States) for more info about subscription states and state transitions. */ state?: SubscriptionState; updatedAt?: string; diff --git a/src/models/subscriptionCustomPrice.ts b/src/models/subscriptionCustomPrice.ts index aae56e2b..cdb3796e 100644 --- a/src/models/subscriptionCustomPrice.ts +++ b/src/models/subscriptionCustomPrice.ts @@ -1,10 +1,17 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ -import { boolean, expandoObject, optional, Schema, string } from '../schema'; +import { + boolean, + expandoObject, + nullable, + optional, + Schema, + string, +} from '../schema'; import { SubscriptionCustomPriceExpirationInterval, subscriptionCustomPriceExpirationIntervalSchema, @@ -29,6 +36,10 @@ import { SubscriptionCustomPriceTrialPriceInCents, subscriptionCustomPriceTrialPriceInCentsSchema, } from './containers/subscriptionCustomPriceTrialPriceInCents'; +import { + ExpirationIntervalUnit, + expirationIntervalUnitSchema, +} from './expirationIntervalUnit'; import { IntervalUnit, intervalUnitSchema } from './intervalUnit'; /** (Optional) Used in place of `product_price_point_id` to define a custom price point unique to the subscription */ @@ -42,7 +53,7 @@ export interface SubscriptionCustomPrice { /** Required if using `custom_price` attribute. */ interval: SubscriptionCustomPriceInterval; /** Required if using `custom_price` attribute. */ - intervalUnit: IntervalUnit; + intervalUnit: IntervalUnit | null; /** (Optional) */ trialPriceInCents?: SubscriptionCustomPriceTrialPriceInCents; /** (Optional) */ @@ -56,7 +67,7 @@ export interface SubscriptionCustomPrice { /** (Optional) */ expirationInterval?: SubscriptionCustomPriceExpirationInterval; /** (Optional) */ - expirationIntervalUnit?: IntervalUnit; + expirationIntervalUnit?: ExpirationIntervalUnit | null; /** (Optional) */ taxIncluded?: boolean; [key: string]: unknown; @@ -68,7 +79,7 @@ export const subscriptionCustomPriceSchema: Schema = ex handle: ['handle', optional(string())], priceInCents: ['price_in_cents', subscriptionCustomPricePriceInCentsSchema], interval: ['interval', subscriptionCustomPriceIntervalSchema], - intervalUnit: ['interval_unit', intervalUnitSchema], + intervalUnit: ['interval_unit', nullable(intervalUnitSchema)], trialPriceInCents: [ 'trial_price_in_cents', optional(subscriptionCustomPriceTrialPriceInCentsSchema), @@ -92,7 +103,7 @@ export const subscriptionCustomPriceSchema: Schema = ex ], expirationIntervalUnit: [ 'expiration_interval_unit', - optional(intervalUnitSchema), + optional(nullable(expirationIntervalUnitSchema)), ], taxIncluded: ['tax_included', optional(boolean())], } diff --git a/src/models/subscriptionDateField.ts b/src/models/subscriptionDateField.ts index 8344c80e..f720f214 100644 --- a/src/models/subscriptionDateField.ts +++ b/src/models/subscriptionDateField.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/subscriptionFilter.ts b/src/models/subscriptionFilter.ts index 63ccd525..28b5ee9a 100644 --- a/src/models/subscriptionFilter.ts +++ b/src/models/subscriptionFilter.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/subscriptionGroup.ts b/src/models/subscriptionGroup.ts index 05cdf876..085c2d33 100644 --- a/src/models/subscriptionGroup.ts +++ b/src/models/subscriptionGroup.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/subscriptionGroupBalances.ts b/src/models/subscriptionGroupBalances.ts index dfee8bf2..c71eb230 100644 --- a/src/models/subscriptionGroupBalances.ts +++ b/src/models/subscriptionGroupBalances.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/subscriptionGroupBankAccount.ts b/src/models/subscriptionGroupBankAccount.ts index 5eafbfcf..ce0a5b3c 100644 --- a/src/models/subscriptionGroupBankAccount.ts +++ b/src/models/subscriptionGroupBankAccount.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -35,7 +35,7 @@ export interface SubscriptionGroupBankAccount { billingZip?: string; billingCountry?: string; chargifyToken?: string; - /** The vault that stores the payment profile with the provided vault_token. */ + /** The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. */ currentVault?: BankAccountVault; gatewayHandle?: string; [key: string]: unknown; diff --git a/src/models/subscriptionGroupComponentCustomPrice.ts b/src/models/subscriptionGroupComponentCustomPrice.ts index f67c5ea4..514cf2a4 100644 --- a/src/models/subscriptionGroupComponentCustomPrice.ts +++ b/src/models/subscriptionGroupComponentCustomPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/subscriptionGroupCreditCard.ts b/src/models/subscriptionGroupCreditCard.ts index 6ae189eb..50ed4945 100644 --- a/src/models/subscriptionGroupCreditCard.ts +++ b/src/models/subscriptionGroupCreditCard.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -18,7 +18,7 @@ import { SubscriptionGroupCreditCardFullNumber, subscriptionGroupCreditCardFullNumberSchema, } from './containers/subscriptionGroupCreditCardFullNumber'; -import { CurrentVault, currentVaultSchema } from './currentVault'; +import { CreditCardVault, creditCardVaultSchema } from './creditCardVault'; export interface SubscriptionGroupCreditCard { fullNumber?: SubscriptionGroupCreditCardFullNumber; @@ -27,7 +27,7 @@ export interface SubscriptionGroupCreditCard { chargifyToken?: string; vaultToken?: string; /** The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. */ - currentVault?: CurrentVault; + currentVault?: CreditCardVault; gatewayHandle?: string; firstName?: string; lastName?: string; @@ -62,7 +62,7 @@ export const subscriptionGroupCreditCardSchema: Schema useSiteExchangeRate: ['use_site_exchange_rate', optional(boolean())], taxIncluded: ['tax_included', optional(boolean())], interval: ['interval', optional(number())], - intervalUnit: ['interval_unit', optional(intervalUnitSchema)], + intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))], prices: ['prices', optional(array(lazy(() => updatePriceSchema)))], } ); diff --git a/src/models/updateComponentPricePointRequest.ts b/src/models/updateComponentPricePointRequest.ts index 6331eccd..4c07885a 100644 --- a/src/models/updateComponentPricePointRequest.ts +++ b/src/models/updateComponentPricePointRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateComponentRequest.ts b/src/models/updateComponentRequest.ts index 5aff3edf..7becffe0 100644 --- a/src/models/updateComponentRequest.ts +++ b/src/models/updateComponentRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateCouponCurrency.ts b/src/models/updateCouponCurrency.ts index 4828a6a7..d0ff7a6b 100644 --- a/src/models/updateCouponCurrency.ts +++ b/src/models/updateCouponCurrency.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateCurrencyPrice.ts b/src/models/updateCurrencyPrice.ts index c82b86e2..be188e56 100644 --- a/src/models/updateCurrencyPrice.ts +++ b/src/models/updateCurrencyPrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateCurrencyPricesRequest.ts b/src/models/updateCurrencyPricesRequest.ts index ebe6814e..84a2c583 100644 --- a/src/models/updateCurrencyPricesRequest.ts +++ b/src/models/updateCurrencyPricesRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateCustomer.ts b/src/models/updateCustomer.ts index 23912a22..b04a6c35 100644 --- a/src/models/updateCustomer.ts +++ b/src/models/updateCustomer.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ @@ -36,6 +36,8 @@ export interface UpdateCustomer { parentId?: number | null; /** Is the customer verified to use ACH as a payment method. Available only on Authorize.Net gateway */ verified?: boolean | null; + /** The Salesforce ID of the customer */ + salesforceId?: string | null; [key: string]: unknown; } @@ -59,4 +61,5 @@ export const updateCustomerSchema: Schema = expandoObject({ taxExemptReason: ['tax_exempt_reason', optional(string())], parentId: ['parent_id', optional(nullable(number()))], verified: ['verified', optional(nullable(boolean()))], + salesforceId: ['salesforce_id', optional(nullable(string()))], }); diff --git a/src/models/updateCustomerRequest.ts b/src/models/updateCustomerRequest.ts index b333ecdf..793470e2 100644 --- a/src/models/updateCustomerRequest.ts +++ b/src/models/updateCustomerRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateMetadata.ts b/src/models/updateMetadata.ts index 8ce8f5d3..4124e69b 100644 --- a/src/models/updateMetadata.ts +++ b/src/models/updateMetadata.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateMetadataRequest.ts b/src/models/updateMetadataRequest.ts index a16e0c53..9eae7249 100644 --- a/src/models/updateMetadataRequest.ts +++ b/src/models/updateMetadataRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateMetafield.ts b/src/models/updateMetafield.ts index 39d89eae..81f1193b 100644 --- a/src/models/updateMetafield.ts +++ b/src/models/updateMetafield.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateMetafieldsRequest.ts b/src/models/updateMetafieldsRequest.ts index ba0ce9a3..62ebc37a 100644 --- a/src/models/updateMetafieldsRequest.ts +++ b/src/models/updateMetafieldsRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updatePaymentProfile.ts b/src/models/updatePaymentProfile.ts index 37151f7b..f9561273 100644 --- a/src/models/updatePaymentProfile.ts +++ b/src/models/updatePaymentProfile.ts @@ -1,12 +1,12 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { expandoObject, nullable, optional, Schema, string } from '../schema'; +import { AllVaults, allVaultsSchema } from './allVaults'; import { CardType, cardTypeSchema } from './cardType'; -import { CurrentVault, currentVaultSchema } from './currentVault'; export interface UpdatePaymentProfile { /** The first name of the card holder. */ @@ -22,7 +22,7 @@ export interface UpdatePaymentProfile { /** (Optional when performing a Import via vault_token, required otherwise) The 4-digit credit card expiration year, as an integer or string, i.e. 2012 */ expirationYear?: string; /** The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. */ - currentVault?: CurrentVault; + currentVault?: AllVaults; /** The credit card or bank account billing street address (i.e. 123 Main St.). This value is merely passed through to the payment gateway. */ billingAddress?: string; /** The credit card or bank account billing address city (i.e. “Boston”). This value is merely passed through to the payment gateway. */ @@ -46,7 +46,7 @@ export const updatePaymentProfileSchema: Schema = expandoO cardType: ['card_type', optional(cardTypeSchema)], expirationMonth: ['expiration_month', optional(string())], expirationYear: ['expiration_year', optional(string())], - currentVault: ['current_vault', optional(currentVaultSchema)], + currentVault: ['current_vault', optional(allVaultsSchema)], billingAddress: ['billing_address', optional(string())], billingCity: ['billing_city', optional(string())], billingState: ['billing_state', optional(string())], diff --git a/src/models/updatePaymentProfileRequest.ts b/src/models/updatePaymentProfileRequest.ts index e5946e13..53bf1d30 100644 --- a/src/models/updatePaymentProfileRequest.ts +++ b/src/models/updatePaymentProfileRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updatePrice.ts b/src/models/updatePrice.ts index 2ec95cc5..0547e9f0 100644 --- a/src/models/updatePrice.ts +++ b/src/models/updatePrice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateProductPricePoint.ts b/src/models/updateProductPricePoint.ts index 2dd7eda0..c81cc88c 100644 --- a/src/models/updateProductPricePoint.ts +++ b/src/models/updateProductPricePoint.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateProductPricePointRequest.ts b/src/models/updateProductPricePointRequest.ts index 14e21f14..fbc5316f 100644 --- a/src/models/updateProductPricePointRequest.ts +++ b/src/models/updateProductPricePointRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateReasonCode.ts b/src/models/updateReasonCode.ts index b12e803d..3cfd144f 100644 --- a/src/models/updateReasonCode.ts +++ b/src/models/updateReasonCode.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateReasonCodeRequest.ts b/src/models/updateReasonCodeRequest.ts index 7f2faa89..ba575976 100644 --- a/src/models/updateReasonCodeRequest.ts +++ b/src/models/updateReasonCodeRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateSegment.ts b/src/models/updateSegment.ts index c008aa4e..03939f93 100644 --- a/src/models/updateSegment.ts +++ b/src/models/updateSegment.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateSegmentRequest.ts b/src/models/updateSegmentRequest.ts index 7013ed3a..94d9a826 100644 --- a/src/models/updateSegmentRequest.ts +++ b/src/models/updateSegmentRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateSubscription.ts b/src/models/updateSubscription.ts index 2e00c296..879112b5 100644 --- a/src/models/updateSubscription.ts +++ b/src/models/updateSubscription.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateSubscriptionComponent.ts b/src/models/updateSubscriptionComponent.ts index 44235515..0136d5eb 100644 --- a/src/models/updateSubscriptionComponent.ts +++ b/src/models/updateSubscriptionComponent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateSubscriptionGroup.ts b/src/models/updateSubscriptionGroup.ts index 6f3da32f..217704a7 100644 --- a/src/models/updateSubscriptionGroup.ts +++ b/src/models/updateSubscriptionGroup.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateSubscriptionGroupRequest.ts b/src/models/updateSubscriptionGroupRequest.ts index 98d0b176..4a018b7c 100644 --- a/src/models/updateSubscriptionGroupRequest.ts +++ b/src/models/updateSubscriptionGroupRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateSubscriptionNote.ts b/src/models/updateSubscriptionNote.ts index 63f58d6c..2e5ed2d8 100644 --- a/src/models/updateSubscriptionNote.ts +++ b/src/models/updateSubscriptionNote.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateSubscriptionNoteRequest.ts b/src/models/updateSubscriptionNoteRequest.ts index 53db2888..26489776 100644 --- a/src/models/updateSubscriptionNoteRequest.ts +++ b/src/models/updateSubscriptionNoteRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/updateSubscriptionRequest.ts b/src/models/updateSubscriptionRequest.ts index 5d128759..2ef5eff6 100644 --- a/src/models/updateSubscriptionRequest.ts +++ b/src/models/updateSubscriptionRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/upsertPrepaidConfiguration.ts b/src/models/upsertPrepaidConfiguration.ts index 6dc884b5..dfe678da 100644 --- a/src/models/upsertPrepaidConfiguration.ts +++ b/src/models/upsertPrepaidConfiguration.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/upsertPrepaidConfigurationRequest.ts b/src/models/upsertPrepaidConfigurationRequest.ts index 23378f3a..28b95275 100644 --- a/src/models/upsertPrepaidConfigurationRequest.ts +++ b/src/models/upsertPrepaidConfigurationRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/usage.ts b/src/models/usage.ts index e8ab60c3..992d68c2 100644 --- a/src/models/usage.ts +++ b/src/models/usage.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/usageResponse.ts b/src/models/usageResponse.ts index 558cb12f..4bb0db2d 100644 --- a/src/models/usageResponse.ts +++ b/src/models/usageResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/voidInvoice.ts b/src/models/voidInvoice.ts index 1d98b013..77a714a4 100644 --- a/src/models/voidInvoice.ts +++ b/src/models/voidInvoice.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/voidInvoiceEvent.ts b/src/models/voidInvoiceEvent.ts index 8ecab5f0..db75d1e2 100644 --- a/src/models/voidInvoiceEvent.ts +++ b/src/models/voidInvoiceEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/voidInvoiceEventData.ts b/src/models/voidInvoiceEventData.ts index 3867384c..ab38ea4b 100644 --- a/src/models/voidInvoiceEventData.ts +++ b/src/models/voidInvoiceEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/voidInvoiceRequest.ts b/src/models/voidInvoiceRequest.ts index 586b6b5c..8efa8b42 100644 --- a/src/models/voidInvoiceRequest.ts +++ b/src/models/voidInvoiceRequest.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/voidRemainderEvent.ts b/src/models/voidRemainderEvent.ts index ec4b9e48..076540c3 100644 --- a/src/models/voidRemainderEvent.ts +++ b/src/models/voidRemainderEvent.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/voidRemainderEventData.ts b/src/models/voidRemainderEventData.ts index f1e5f547..bc7f813b 100644 --- a/src/models/voidRemainderEventData.ts +++ b/src/models/voidRemainderEventData.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/webhook.ts b/src/models/webhook.ts index c8cb5de9..1d2d121b 100644 --- a/src/models/webhook.ts +++ b/src/models/webhook.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/webhookOrder.ts b/src/models/webhookOrder.ts index 3c07b5a1..9be29188 100644 --- a/src/models/webhookOrder.ts +++ b/src/models/webhookOrder.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/webhookResponse.ts b/src/models/webhookResponse.ts index 865af4f0..ef76000a 100644 --- a/src/models/webhookResponse.ts +++ b/src/models/webhookResponse.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/webhookStatus.ts b/src/models/webhookStatus.ts index ba1e85b0..8ae87d72 100644 --- a/src/models/webhookStatus.ts +++ b/src/models/webhookStatus.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/models/webhookSubscription.ts b/src/models/webhookSubscription.ts index 5c643f41..1d2dbec7 100644 --- a/src/models/webhookSubscription.ts +++ b/src/models/webhookSubscription.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ diff --git a/src/schema.ts b/src/schema.ts index e4a51dd8..fc801a1f 100644 --- a/src/schema.ts +++ b/src/schema.ts @@ -1,5 +1,5 @@ /** - * Maxio Advanced BillingLib + * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */