zuora-sdk-js 3.0.0 → 3.2.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -16
- package/dist/ZuoraClient.js +20 -30
- package/dist/zuora_api/ApiClient.js +20 -2
- package/dist/zuora_api/api/APIHealthApi.js +1 -1
- package/dist/zuora_api/api/AccountingCodesApi.js +1 -1
- package/dist/zuora_api/api/AccountingPeriodsApi.js +1 -1
- package/dist/zuora_api/api/AccountsApi.js +1 -1
- package/dist/zuora_api/api/ActionsApi.js +1 -1
- package/dist/zuora_api/api/AdjustmentsApi.js +1 -1
- package/dist/zuora_api/api/AggregateQueriesApi.js +1 -1
- package/dist/zuora_api/api/AttachmentsApi.js +1 -1
- package/dist/zuora_api/api/BillRunApi.js +1 -1
- package/dist/zuora_api/api/BillRunHealthApi.js +1 -1
- package/dist/zuora_api/api/BillingDocumentsApi.js +1 -1
- package/dist/zuora_api/api/BillingPreviewRunApi.js +1 -1
- package/dist/zuora_api/api/BookingDateBackfillJobApi.js +1 -1
- package/dist/zuora_api/api/CatalogGroupsApi.js +1 -1
- package/dist/zuora_api/api/ConfigurationTemplatesApi.js +1 -1
- package/dist/zuora_api/api/ContactSnapshotsApi.js +1 -1
- package/dist/zuora_api/api/ContactsApi.js +1 -1
- package/dist/zuora_api/api/CreditMemosApi.js +1 -1
- package/dist/zuora_api/api/CustomEventTriggersApi.js +1 -1
- package/dist/zuora_api/api/CustomExchangeRatesApi.js +1 -1
- package/dist/zuora_api/api/CustomObjectDefinitionsApi.js +1 -1
- package/dist/zuora_api/api/CustomObjectJobsApi.js +1 -1
- package/dist/zuora_api/api/CustomObjectRecordsApi.js +1 -1
- package/dist/zuora_api/api/CustomPaymentMethodTypesApi.js +1 -1
- package/dist/zuora_api/api/CustomScheduledEventsApi.js +1 -1
- package/dist/zuora_api/api/DataBackfillJobApi.js +1 -1
- package/dist/zuora_api/api/DataQueriesApi.js +1 -1
- package/dist/zuora_api/api/DebitMemosApi.js +75 -1
- package/dist/zuora_api/api/DescribeApi.js +1 -1
- package/dist/zuora_api/api/EInvoicingApi.js +1 -1
- package/dist/zuora_api/api/ElectronicPaymentsHealthApi.js +1 -1
- package/dist/zuora_api/api/FilesApi.js +2 -2
- package/dist/zuora_api/api/FulfillmentsApi.js +1 -1
- package/dist/zuora_api/api/HostedPagesApi.js +1 -1
- package/dist/zuora_api/api/ImportsApi.js +1 -1
- package/dist/zuora_api/api/InvoiceSchedulesApi.js +1 -1
- package/dist/zuora_api/api/InvoicesApi.js +1 -1
- package/dist/zuora_api/api/JournalRunsApi.js +1 -1
- package/dist/zuora_api/api/MassUpdaterApi.js +1 -1
- package/dist/zuora_api/api/NotificationsApi.js +1 -1
- package/dist/zuora_api/api/OAuthApi.js +1 -1
- package/dist/zuora_api/api/ObjectQueriesApi.js +90 -258
- package/dist/zuora_api/api/OperationsApi.js +1 -1
- package/dist/zuora_api/api/OrderActionsApi.js +1 -1
- package/dist/zuora_api/api/OrderLineItemsApi.js +1 -1
- package/dist/zuora_api/api/OrdersApi.js +75 -1
- package/dist/zuora_api/api/PaymentAuthorizationApi.js +1 -1
- package/dist/zuora_api/api/PaymentGatewayReconciliationApi.js +1 -1
- package/dist/zuora_api/api/PaymentGatewaysApi.js +1 -1
- package/dist/zuora_api/api/PaymentMethodSnapshotsApi.js +1 -1
- package/dist/zuora_api/api/PaymentMethodTransactionLogsApi.js +1 -1
- package/dist/zuora_api/api/PaymentMethodUpdaterApi.js +1 -1
- package/dist/zuora_api/api/PaymentMethodsApi.js +1 -1
- package/dist/zuora_api/api/PaymentRunsApi.js +1 -1
- package/dist/zuora_api/api/PaymentSchedulesApi.js +1 -1
- package/dist/zuora_api/api/PaymentTransactionLogsApi.js +1 -1
- package/dist/zuora_api/api/PaymentsApi.js +1 -1
- package/dist/zuora_api/api/ProductRatePlanChargeTiersApi.js +1 -1
- package/dist/zuora_api/api/ProductRatePlanChargesApi.js +1 -1
- package/dist/zuora_api/api/ProductRatePlansApi.js +1 -1
- package/dist/zuora_api/api/ProductsApi.js +1 -1
- package/dist/zuora_api/api/RSASignaturesApi.js +1 -1
- package/dist/zuora_api/api/RampsApi.js +1 -1
- package/dist/zuora_api/api/RatePlansApi.js +1 -1
- package/dist/zuora_api/api/RefundsApi.js +1 -1
- package/dist/zuora_api/api/RegenerateApi.js +1 -1
- package/dist/zuora_api/api/{ZuoraRevenueIntegrationApi.js → RevenueAccountingCodesApi.js} +9 -9
- package/dist/zuora_api/api/RevenueIntegrationApi.js +747 -0
- package/dist/zuora_api/api/SequenceSetsApi.js +1 -1
- package/dist/zuora_api/api/SettingsApi.js +1 -1
- package/dist/zuora_api/api/SignUpApi.js +1 -1
- package/dist/zuora_api/api/SubscriptionChangeLogsApi.js +254 -0
- package/dist/zuora_api/api/SubscriptionsApi.js +1 -1
- package/dist/zuora_api/api/SummaryJournalEntriesApi.js +1 -1
- package/dist/zuora_api/api/TaxationItemsApi.js +1 -1
- package/dist/zuora_api/api/UsageApi.js +1 -1
- package/dist/zuora_api/api/WorkflowsApi.js +1 -1
- package/dist/zuora_api/index.js +173 -47
- package/dist/zuora_api/model/AccountBasicInfo.js +12 -1
- package/dist/zuora_api/model/AccountBillingAndPayment.js +12 -1
- package/dist/zuora_api/model/AccountCreditCardHolder.js +12 -1
- package/dist/zuora_api/model/AccountData.js +26 -2
- package/dist/zuora_api/model/AccountDetailResponse.js +25 -1
- package/dist/zuora_api/model/AccountEInvoiceProfile.js +14 -1
- package/dist/zuora_api/model/AccountMetrics.js +12 -1
- package/dist/zuora_api/model/AccountObjectNSFields.js +12 -1
- package/dist/zuora_api/model/AccountPMMandateInfo.js +12 -1
- package/dist/zuora_api/model/AccountSummaryBasicInfo.js +12 -1
- package/dist/zuora_api/model/AccountSummaryDefaultPaymentMethod.js +12 -1
- package/dist/zuora_api/model/AccountSummaryInvoice.js +12 -1
- package/dist/zuora_api/model/AccountSummaryPayment.js +12 -1
- package/dist/zuora_api/model/AccountSummaryPaymentInvoice.js +12 -1
- package/dist/zuora_api/model/AccountSummaryRatePlan.js +12 -1
- package/dist/zuora_api/model/AccountSummaryResponse.js +25 -1
- package/dist/zuora_api/model/AccountSummarySubscription.js +12 -1
- package/dist/zuora_api/model/AccountSummaryUsage.js +12 -1
- package/dist/zuora_api/model/AccountingCodeItemResponse.js +12 -1
- package/dist/zuora_api/model/ActionsErrorResponse.js +12 -1
- package/dist/zuora_api/model/AddSubscriptionComponent.js +13 -2
- package/dist/zuora_api/model/AddSubscriptionRatePlan.js +13 -2
- package/dist/zuora_api/model/ApiVolumeSummaryRecord.js +12 -1
- package/dist/zuora_api/model/ApplyCreditMemoItemToDebitMemoItem.js +13 -2
- package/dist/zuora_api/model/ApplyCreditMemoItemToInvoiceItem.js +13 -2
- package/dist/zuora_api/model/ApplyCreditMemoRequest.js +12 -1
- package/dist/zuora_api/model/ApplyCreditMemoToDebitMemo.js +13 -2
- package/dist/zuora_api/model/ApplyCreditMemoToInvoice.js +13 -2
- package/dist/zuora_api/model/ApplyPaymentDebitMemoApplication.js +13 -2
- package/dist/zuora_api/model/ApplyPaymentDebitMemoApplicationItem.js +13 -2
- package/dist/zuora_api/model/ApplyPaymentInvoiceApplication.js +13 -2
- package/dist/zuora_api/model/ApplyPaymentInvoiceApplicationItem.js +13 -2
- package/dist/zuora_api/model/ApplyPaymentRequest.js +12 -1
- package/dist/zuora_api/model/AsyncOperationResponse.js +12 -1
- package/dist/zuora_api/model/AsyncOrderJobResult.js +12 -1
- package/dist/zuora_api/model/AsyncOrderProcessingOptions.js +12 -1
- package/dist/zuora_api/model/AsyncOrderResultSubscriptions.js +12 -1
- package/dist/zuora_api/model/BadRequestErrors.js +12 -1
- package/dist/zuora_api/model/BadRequestResponse.js +12 -1
- package/dist/zuora_api/model/BillRun.js +12 -1
- package/dist/zuora_api/model/BillRunFilter.js +12 -1
- package/dist/zuora_api/model/BillRunResponse.js +12 -1
- package/dist/zuora_api/model/BillRunSchedule.js +12 -1
- package/dist/zuora_api/model/BillingAdjustment.js +12 -1
- package/dist/zuora_api/model/BillingAdjustmentExclusion.js +12 -1
- package/dist/zuora_api/model/BillingDocVolumeSummaryRecord.js +12 -1
- package/dist/zuora_api/model/BillingDocumentItemProcessingType.js +5 -0
- package/dist/zuora_api/model/BillingDocumentItemSourceType.js +10 -0
- package/dist/zuora_api/model/BillingDocumentQueryResponseElement.js +12 -1
- package/dist/zuora_api/model/BillingOptions.js +12 -1
- package/dist/zuora_api/model/BillingUpdate.js +12 -1
- package/dist/zuora_api/model/BookingDateJob.js +12 -1
- package/dist/zuora_api/model/BulkCreateCreditMemosFromChargeRequest.js +13 -2
- package/dist/zuora_api/model/BulkCreateCreditMemosFromInvoiceRequest.js +13 -2
- package/dist/zuora_api/model/BulkCreateCreditMemosRequest.js +1 -1
- package/dist/zuora_api/model/BulkCreateDebitMemosFromChargeRequest.js +13 -2
- package/dist/zuora_api/model/BulkCreateDebitMemosFromInvoiceRequest.js +13 -2
- package/dist/zuora_api/model/BulkCreateDebitMemosRequest.js +1 -1
- package/dist/zuora_api/model/BulkCreateInvoicesRequest.js +12 -1
- package/dist/zuora_api/model/BulkCreateInvoicesResponse.js +12 -1
- package/dist/zuora_api/model/BulkCreditMemosResponse.js +12 -1
- package/dist/zuora_api/model/BulkDebitMemosResponse.js +12 -1
- package/dist/zuora_api/model/BulkPDFGenerationJobStatus.js +5 -0
- package/dist/zuora_api/model/BulkPdfGenerationJobRequest.js +13 -2
- package/dist/zuora_api/model/BulkPdfGenerationJobResponse.js +12 -1
- package/dist/zuora_api/model/BulkPostInvoicesRequest.js +12 -1
- package/dist/zuora_api/model/BulkPostInvoicesResponse.js +12 -1
- package/dist/zuora_api/model/BulkUpdateCreditMemosRequest.js +12 -1
- package/dist/zuora_api/model/BulkUpdateDebitMemosRequest.js +12 -1
- package/dist/zuora_api/model/BulkUpdateInvoicesRequest.js +12 -1
- package/dist/zuora_api/model/BulkUpdateOrderLineItem.js +73 -28
- package/dist/zuora_api/model/BulkUpdateOrderLineItemsRequest.js +12 -1
- package/dist/zuora_api/model/BusinessRegion.js +12 -1
- package/dist/zuora_api/model/BusinessRegionsResponse.js +12 -1
- package/dist/zuora_api/model/CalloutAuth.js +12 -1
- package/dist/zuora_api/model/CancelAuthorizationRequest.js +13 -2
- package/dist/zuora_api/model/CancelAuthorizationResponse.js +12 -1
- package/dist/zuora_api/model/CancelBillRunRequest.js +12 -1
- package/dist/zuora_api/model/CancelBillRunResponse.js +12 -1
- package/dist/zuora_api/model/CancelBillingAdjustmentRequest.js +12 -1
- package/dist/zuora_api/model/CancelBillingAdjustmentResponse.js +12 -1
- package/dist/zuora_api/model/CancelOrderRequest.js +12 -1
- package/dist/zuora_api/model/CancelOrderResponse.js +12 -1
- package/dist/zuora_api/model/CancelPaymentSchedule.js +13 -2
- package/dist/zuora_api/model/CancelSubscriptionRequest.js +13 -2
- package/dist/zuora_api/model/CancelSubscriptionResponse.js +12 -1
- package/dist/zuora_api/model/CatalogGroup.js +12 -5
- package/dist/zuora_api/model/CatalogGroupProductRatePlan.js +12 -1
- package/dist/zuora_api/model/ChangeLogField.js +128 -0
- package/dist/zuora_api/model/ChangePlanRatePlanOverride.js +12 -1
- package/dist/zuora_api/model/ChangeSubscriptionRatePlan.js +12 -1
- package/dist/zuora_api/model/ChargeMetrics.js +12 -1
- package/dist/zuora_api/model/ChargeModelConfiguration.js +12 -1
- package/dist/zuora_api/model/ChargeModelConfigurationForSubscription.js +12 -1
- package/dist/zuora_api/model/ChargeModelConfigurationItem.js +13 -2
- package/dist/zuora_api/model/ChargeModelDataOverride.js +12 -1
- package/dist/zuora_api/model/ChargeOverride.js +46 -4
- package/dist/zuora_api/model/ChargeOverrideBilling.js +12 -1
- package/dist/zuora_api/model/ChargeOverridePricing.js +12 -1
- package/dist/zuora_api/model/ChargeProrationRuleDaysInMonth.js +63 -0
- package/dist/zuora_api/model/ChargeProrationRuleProrationUnit.js +58 -0
- package/dist/zuora_api/model/ChargeTier.js +13 -2
- package/dist/zuora_api/model/ChargeUpdate.js +12 -1
- package/dist/zuora_api/model/ChildrenSettingValueRequest.js +12 -1
- package/dist/zuora_api/model/CollectDebitMemoRequest.js +12 -1
- package/dist/zuora_api/model/CollectDebitMemoRequestPayment.js +12 -1
- package/dist/zuora_api/model/CollectDebitMemoResponse.js +12 -1
- package/dist/zuora_api/model/CollectDebitMemoResponseAppliedCreditMemos.js +12 -1
- package/dist/zuora_api/model/CollectDebitMemoResponseAppliedPayments.js +12 -1
- package/dist/zuora_api/model/CollectDebitMemoResponseDebitMemo.js +12 -1
- package/dist/zuora_api/model/CollectDebitMemoResponseProcessedPayment.js +12 -1
- package/dist/zuora_api/model/CommonErrorResponse.js +12 -1
- package/dist/zuora_api/model/CommonResponse.js +12 -1
- package/dist/zuora_api/model/CompareSchemaInfoResponse.js +12 -1
- package/dist/zuora_api/model/CompareSchemaKeyValue.js +12 -1
- package/dist/zuora_api/model/ConfigTemplateErrorResponse.js +12 -1
- package/dist/zuora_api/model/ConfigTemplateErrorResponseReasonsInner.js +12 -1
- package/dist/zuora_api/model/ConfigurationTemplateContent.js +12 -1
- package/dist/zuora_api/model/Contact.js +39 -1
- package/dist/zuora_api/model/ContactInfo.js +13 -2
- package/dist/zuora_api/model/ContactResponse.js +54 -1
- package/dist/zuora_api/model/ContactSnapshot.js +39 -1
- package/dist/zuora_api/model/ContactSnapshotResponse.js +54 -1
- package/dist/zuora_api/model/CreateAccountContact.js +14 -3
- package/dist/zuora_api/model/CreateAccountCreditCard.js +13 -2
- package/dist/zuora_api/model/CreateAccountCreditCardHolderInfo.js +13 -2
- package/dist/zuora_api/model/CreateAccountPaymentMethod.js +13 -2
- package/dist/zuora_api/model/CreateAccountRequest.js +35 -2
- package/dist/zuora_api/model/CreateAccountResponse.js +25 -1
- package/dist/zuora_api/model/CreateAccountSubscription.js +13 -2
- package/dist/zuora_api/model/CreateAccountingCodeRequest.js +13 -2
- package/dist/zuora_api/model/CreateAccountingCodeResponse.js +12 -1
- package/dist/zuora_api/model/CreateAccountingPeriodRequest.js +13 -2
- package/dist/zuora_api/model/CreateAccountingPeriodResponse.js +12 -1
- package/dist/zuora_api/model/CreateAuthorizationRequest.js +13 -2
- package/dist/zuora_api/model/CreateAuthorizationResponse.js +12 -1
- package/dist/zuora_api/model/CreateAuthorizationResponsePaymentGateway.js +12 -1
- package/dist/zuora_api/model/CreateAuthorizationResponseReasons.js +12 -1
- package/dist/zuora_api/model/CreateBatchQueryJobRequest.js +12 -1
- package/dist/zuora_api/model/CreateBatchQueryJobResponse.js +12 -1
- package/dist/zuora_api/model/CreateBatchQueryRequest.js +12 -1
- package/dist/zuora_api/model/CreateBatchQueryResponse.js +12 -1
- package/dist/zuora_api/model/CreateBillRunRequest.js +43 -1
- package/dist/zuora_api/model/CreateBillingAdjustmentRequest.js +24 -2
- package/dist/zuora_api/model/CreateBillingDocumentFilesDeletionJobRequest.js +12 -1
- package/dist/zuora_api/model/CreateBillingDocumentFilesDeletionJobResponse.js +12 -1
- package/dist/zuora_api/model/CreateBillingPreviewCreditMemoItem.js +12 -1
- package/dist/zuora_api/model/CreateBillingPreviewInvoiceItem.js +12 -1
- package/dist/zuora_api/model/CreateBillingPreviewRequest.js +13 -2
- package/dist/zuora_api/model/CreateBillingPreviewResponse.js +12 -1
- package/dist/zuora_api/model/CreateBillingPreviewRunRequest.js +13 -2
- package/dist/zuora_api/model/CreateBillingPreviewRunResponse.js +12 -1
- package/dist/zuora_api/model/CreateCatalogGroupRequest.js +12 -1
- package/dist/zuora_api/model/CreateContactRequest.js +40 -2
- package/dist/zuora_api/model/CreateCreditMemoFromCharge.js +12 -1
- package/dist/zuora_api/model/CreateCreditMemoFromChargeRequest.js +12 -1
- package/dist/zuora_api/model/CreateCreditMemoFromInvoice.js +12 -1
- package/dist/zuora_api/model/CreateCreditMemoFromInvoiceRequest.js +12 -1
- package/dist/zuora_api/model/CreateCreditMemoTaxationItemsRequest.js +12 -1
- package/dist/zuora_api/model/CreateDebitMemoFromCharge.js +12 -1
- package/dist/zuora_api/model/CreateDebitMemoFromChargeRequest.js +12 -1
- package/dist/zuora_api/model/CreateDebitMemoFromInvoiceRequest.js +47 -1
- package/dist/zuora_api/model/CreateDebitMemosFromInvoiceRequest.js +62 -1
- package/dist/zuora_api/model/CreateDiscountItem.js +13 -2
- package/dist/zuora_api/model/CreateFulfillment.js +14 -3
- package/dist/zuora_api/model/CreateFulfillmentItem.js +12 -1
- package/dist/zuora_api/model/CreateFulfillmentItemResponse.js +12 -1
- package/dist/zuora_api/model/CreateFulfillmentItemsRequest.js +12 -1
- package/dist/zuora_api/model/CreateFulfillmentItemsResponse.js +12 -1
- package/dist/zuora_api/model/CreateFulfillmentResponse.js +12 -1
- package/dist/zuora_api/model/CreateFulfillmentsRequest.js +12 -1
- package/dist/zuora_api/model/CreateFulfillmentsResponse.js +12 -1
- package/dist/zuora_api/model/CreateInvoiceCollectCreditMemos.js +12 -1
- package/dist/zuora_api/model/CreateInvoiceCollectInvoices.js +12 -1
- package/dist/zuora_api/model/CreateInvoiceCollectRequest.js +13 -2
- package/dist/zuora_api/model/CreateInvoiceCollectResponse.js +12 -1
- package/dist/zuora_api/model/CreateInvoiceItem.js +13 -2
- package/dist/zuora_api/model/CreateInvoiceRequest.js +48 -2
- package/dist/zuora_api/model/CreateInvoiceScheduleItem.js +12 -1
- package/dist/zuora_api/model/CreateInvoiceScheduleRequest.js +12 -1
- package/dist/zuora_api/model/CreateJournalEntryRequest.js +13 -2
- package/dist/zuora_api/model/CreateJournalEntryRequestItem.js +13 -2
- package/dist/zuora_api/model/CreateJournalEntryRequestSegment.js +13 -2
- package/dist/zuora_api/model/CreateJournalEntryResponse.js +12 -1
- package/dist/zuora_api/model/CreateJournalRunRequest.js +13 -2
- package/dist/zuora_api/model/CreateJournalRunRequestTransactionType.js +13 -2
- package/dist/zuora_api/model/CreateJournalRunResponse.js +12 -1
- package/dist/zuora_api/model/CreateMassUpdateResponse.js +12 -1
- package/dist/zuora_api/model/CreateMassUpdaterRequest.js +13 -2
- package/dist/zuora_api/model/CreateNonRefRefundFinanceInformation.js +12 -1
- package/dist/zuora_api/model/CreateOpenPaymentMethodTypeRequest.js +13 -2
- package/dist/zuora_api/model/CreateOrUpdateCatalogGroupProductRatePlan.js +12 -1
- package/dist/zuora_api/model/CreateOrUpdateEmailTemplatesResponse.js +12 -1
- package/dist/zuora_api/model/CreateOrderAction.js +14 -3
- package/dist/zuora_api/model/CreateOrderAddProduct.js +12 -1
- package/dist/zuora_api/model/CreateOrderAsyncRequest.js +13 -6
- package/dist/zuora_api/model/CreateOrderAsyncResponse.js +12 -1
- package/dist/zuora_api/model/CreateOrderChangePlan.js +13 -2
- package/dist/zuora_api/model/CreateOrderChangePlanRatePlanOverride.js +12 -1
- package/dist/zuora_api/model/CreateOrderChargeUpdate.js +12 -1
- package/dist/zuora_api/model/CreateOrderCreateSubscription.js +25 -1
- package/dist/zuora_api/model/CreateOrderOrderLineItem.js +52 -10
- package/dist/zuora_api/model/CreateOrderPricingUpdate.js +12 -1
- package/dist/zuora_api/model/CreateOrderProductOverride.js +12 -1
- package/dist/zuora_api/model/CreateOrderProductRatePlanOverride.js +12 -1
- package/dist/zuora_api/model/CreateOrderRatePlanFeatureOverride.js +13 -2
- package/dist/zuora_api/model/CreateOrderRatePlanOverride.js +12 -1
- package/dist/zuora_api/model/CreateOrderRatePlanUpdate.js +12 -1
- package/dist/zuora_api/model/CreateOrderRequest.js +13 -6
- package/dist/zuora_api/model/CreateOrderResponse.js +12 -1
- package/dist/zuora_api/model/CreateOrderResponseOrderAction.js +12 -1
- package/dist/zuora_api/model/CreateOrderResponseOrderLineItems.js +12 -1
- package/dist/zuora_api/model/CreateOrderResponseOrderMetric.js +12 -1
- package/dist/zuora_api/model/CreateOrderResponseRamps.js +12 -1
- package/dist/zuora_api/model/CreateOrderResponseRefunds.js +12 -1
- package/dist/zuora_api/model/CreateOrderResponseSubscriptions.js +12 -1
- package/dist/zuora_api/model/CreateOrderResponseWriteOff.js +12 -1
- package/dist/zuora_api/model/CreateOrderResume.js +13 -2
- package/dist/zuora_api/model/CreateOrderSubscription.js +12 -1
- package/dist/zuora_api/model/CreateOrderSubscriptionOwnerAccount.js +13 -2
- package/dist/zuora_api/model/CreateOrderSuspend.js +13 -2
- package/dist/zuora_api/model/CreateOrderTermsAndConditions.js +97 -1
- package/dist/zuora_api/model/CreateOrderUpdateProduct.js +12 -1
- package/dist/zuora_api/model/CreatePaymentDebitMemoApplication.js +13 -2
- package/dist/zuora_api/model/CreatePaymentDebitMemoApplicationItem.js +13 -2
- package/dist/zuora_api/model/CreatePaymentInvoiceApplication.js +13 -2
- package/dist/zuora_api/model/CreatePaymentInvoiceApplicationItem.js +13 -2
- package/dist/zuora_api/model/CreatePaymentMethodACH.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodApplePayAdyen.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodBankTransfer.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodBankTransferAccountHolderInfo.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodCCReferenceTransaction.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodCardholderInfo.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodCommon.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodCreditCard.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodDecryptionRequest.js +13 -2
- package/dist/zuora_api/model/CreatePaymentMethodDecryptionResponse.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodGooglePayAdyenChase.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodPayPalAdaptive.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodPayPalECPayPalNativeECPayPalCP.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodRequest.js +13 -2
- package/dist/zuora_api/model/CreatePaymentMethodResponse.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodResponseReason.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodUpdaterBatchRequest.js +13 -2
- package/dist/zuora_api/model/CreatePaymentMethodUpdaterBatchResponse.js +12 -1
- package/dist/zuora_api/model/CreatePaymentMethodUpdaterBatchResponseReasons.js +12 -1
- package/dist/zuora_api/model/CreatePaymentRequest.js +13 -2
- package/dist/zuora_api/model/CreatePaymentRunData.js +12 -1
- package/dist/zuora_api/model/CreatePaymentRunDataItem.js +12 -1
- package/dist/zuora_api/model/CreatePaymentRunRequest.js +12 -1
- package/dist/zuora_api/model/CreatePaymentScheduleItemsRequest.js +12 -1
- package/dist/zuora_api/model/CreatePaymentScheduleItemsRequestItems.js +13 -2
- package/dist/zuora_api/model/CreatePaymentScheduleRequest.js +12 -1
- package/dist/zuora_api/model/CreatePaymentScheduleRequestItems.js +12 -1
- package/dist/zuora_api/model/CreatePaymentSchedulesRequest.js +12 -1
- package/dist/zuora_api/model/CreatePaymentSchedulesResponse.js +12 -1
- package/dist/zuora_api/model/CreatePaymentSchedulesResponseItems.js +12 -1
- package/dist/zuora_api/model/CreatePaymentSessionInvoice.js +12 -1
- package/dist/zuora_api/model/CreatePaymentSessionRequest.js +12 -1
- package/dist/zuora_api/model/CreatePaymentSessionResponse.js +12 -1
- package/dist/zuora_api/model/CreateProductRatePlanChargeRequest.js +13 -2
- package/dist/zuora_api/model/CreateProductRatePlanRequest.js +13 -2
- package/dist/zuora_api/model/CreateProductRequest.js +13 -2
- package/dist/zuora_api/model/CreateRSASignatureRequest.js +13 -2
- package/dist/zuora_api/model/CreateRamp.js +12 -1
- package/dist/zuora_api/model/CreateRefundRequest.js +13 -2
- package/dist/zuora_api/model/CreateRefundwithAutoUnapply.js +13 -2
- package/dist/zuora_api/model/CreateSequenceSetRequest.js +13 -2
- package/dist/zuora_api/model/CreateSequenceSetsRequest.js +12 -1
- package/dist/zuora_api/model/CreateSequenceSetsResponse.js +12 -1
- package/dist/zuora_api/model/CreateStoredCredentialProfileRequest.js +13 -2
- package/dist/zuora_api/model/CreateSubscribeToProduct.js +12 -1
- package/dist/zuora_api/model/CreateSubscriptionComponent.js +13 -2
- package/dist/zuora_api/model/CreateSubscriptionRatePlan.js +12 -1
- package/dist/zuora_api/model/CreateSubscriptionRequest.js +13 -2
- package/dist/zuora_api/model/CreateSubscriptionResponse.js +12 -1
- package/dist/zuora_api/model/CreateTaxationItem.js +13 -2
- package/dist/zuora_api/model/CreateTaxationItemForCreditMemoFinanceInformation.js +12 -1
- package/dist/zuora_api/model/CreateTaxationItemForCreditMemoRequest.js +13 -2
- package/dist/zuora_api/model/CreateTaxationItemForDebitMemo.js +13 -2
- package/dist/zuora_api/model/CreateTaxationItemForDebitMemoFinanceInformation.js +12 -1
- package/dist/zuora_api/model/CreateTaxationItemForInvoiceRequest.js +13 -2
- package/dist/zuora_api/model/CreateTaxationItemsForDebitMemoRequest.js +12 -1
- package/dist/zuora_api/model/CreateTaxationItemsRequest.js +12 -1
- package/dist/zuora_api/model/CreateTemplateRequestContent.js +13 -2
- package/dist/zuora_api/model/CreateTokenRequest.js +13 -2
- package/dist/zuora_api/model/CreateUpdateOpenPaymentMethodTypeResponse.js +12 -1
- package/dist/zuora_api/model/CreateUpdateStoredCredentialProfileResponse.js +12 -1
- package/dist/zuora_api/model/CreateUsageRequest.js +13 -2
- package/dist/zuora_api/model/CreditCard.js +12 -1
- package/dist/zuora_api/model/CreditMemo.js +25 -1
- package/dist/zuora_api/model/CreditMemoEntityPrefix.js +12 -1
- package/dist/zuora_api/model/CreditMemoItem.js +44 -2
- package/dist/zuora_api/model/CreditMemoItemFinanceInformation.js +38 -1
- package/dist/zuora_api/model/CreditMemoItemFromChargeDetail.js +13 -2
- package/dist/zuora_api/model/CreditMemoItemFromChargeDetailFinanceInformation.js +12 -1
- package/dist/zuora_api/model/CreditMemoItemFromInvoiceItem.js +13 -2
- package/dist/zuora_api/model/CreditMemoItemFromInvoiceItemFinanceInformation.js +12 -1
- package/dist/zuora_api/model/CreditMemoItemFromWriteOffInvoice.js +53 -1
- package/dist/zuora_api/model/CreditMemoItemPart.js +12 -1
- package/dist/zuora_api/model/CreditMemoItemResponse.js +53 -2
- package/dist/zuora_api/model/CreditMemoItemsResponse.js +12 -1
- package/dist/zuora_api/model/CreditMemoObjectNSFields.js +12 -1
- package/dist/zuora_api/model/CreditMemoPart.js +12 -1
- package/dist/zuora_api/model/CreditMemoResponse.js +29 -1
- package/dist/zuora_api/model/CreditMemoTaxItemFromInvoiceTaxItemFinanceInformation.js +12 -1
- package/dist/zuora_api/model/CreditMemoTaxItemFromInvoiceTaxItemRequest.js +12 -1
- package/dist/zuora_api/model/CreditMemoTaxationItemFromWriteOffInvoice.js +111 -0
- package/dist/zuora_api/model/CreditMemosResponse.js +12 -1
- package/dist/zuora_api/model/CustomAccountPaymentMethod.js +12 -1
- package/dist/zuora_api/model/CustomFields.js +12 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinition.js +12 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfCreatedById.js +12 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfCreatedDate.js +12 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfId.js +12 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfUpdatedById.js +12 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfUpdatedDate.js +12 -1
- package/dist/zuora_api/model/CustomObjectBulkDeleteFilter.js +13 -2
- package/dist/zuora_api/model/CustomObjectBulkDeleteFilterCondition.js +13 -2
- package/dist/zuora_api/model/CustomObjectBulkJobErrorResponse.js +12 -1
- package/dist/zuora_api/model/CustomObjectBulkJobErrorResponseCollection.js +13 -2
- package/dist/zuora_api/model/CustomObjectBulkJobRequest.js +13 -2
- package/dist/zuora_api/model/CustomObjectBulkJobResponse.js +12 -1
- package/dist/zuora_api/model/CustomObjectBulkJobResponseCollection.js +13 -2
- package/dist/zuora_api/model/CustomObjectBulkJobResponseError.js +12 -1
- package/dist/zuora_api/model/CustomObjectCustomFieldDefinition.js +12 -1
- package/dist/zuora_api/model/CustomObjectCustomFieldDefinitionUpdate.js +12 -1
- package/dist/zuora_api/model/CustomObjectCustomFieldsDefinition.js +12 -1
- package/dist/zuora_api/model/CustomObjectDefinition.js +12 -1
- package/dist/zuora_api/model/CustomObjectDefinitionSchema.js +12 -1
- package/dist/zuora_api/model/CustomObjectDefinitionUpdateActionRequest.js +13 -2
- package/dist/zuora_api/model/CustomObjectDefinitionUpdateActionResponse.js +12 -1
- package/dist/zuora_api/model/CustomObjectRecordBatchAction.js +13 -2
- package/dist/zuora_api/model/CustomObjectRecordBatchRequest.js +13 -2
- package/dist/zuora_api/model/CustomObjectRecordWithAllFields.js +12 -1
- package/dist/zuora_api/model/CustomObjectRecordWithOnlyCustomFields.js +12 -1
- package/dist/zuora_api/model/CustomObjectRecordsBatchUpdatePartialSuccessResponse.js +12 -1
- package/dist/zuora_api/model/CustomObjectRecordsErrorResponse.js +12 -1
- package/dist/zuora_api/model/CustomObjectRecordsThrottledResponse.js +12 -1
- package/dist/zuora_api/model/CustomObjectRecordsWithError.js +12 -1
- package/dist/zuora_api/model/CustomRates.js +13 -2
- package/dist/zuora_api/model/DailyConsumptionRevRecRequest.js +13 -2
- package/dist/zuora_api/model/DataQueryErrorResponse.js +12 -1
- package/dist/zuora_api/model/DataQueryJob.js +12 -1
- package/dist/zuora_api/model/DataQueryJobCancelled.js +12 -1
- package/dist/zuora_api/model/DataQueryJobCommon.js +12 -1
- package/dist/zuora_api/model/DebitMemo.js +38 -1
- package/dist/zuora_api/model/DebitMemoDueDate.js +12 -1
- package/dist/zuora_api/model/DebitMemoEntityPrefix.js +12 -1
- package/dist/zuora_api/model/DebitMemoItem.js +26 -2
- package/dist/zuora_api/model/DebitMemoItemFromChargeDetail.js +13 -2
- package/dist/zuora_api/model/DebitMemoItemFromChargeDetailFinanceInformation.js +12 -1
- package/dist/zuora_api/model/DebitMemoItemFromInvoiceItemFinanceInformation.js +12 -1
- package/dist/zuora_api/model/DebitMemoItemFromInvoiceItemRequest.js +13 -2
- package/dist/zuora_api/model/DebitMemoItemResponse.js +32 -3
- package/dist/zuora_api/model/DebitMemoItemTaxationItems.js +12 -1
- package/dist/zuora_api/model/DebitMemoItemWriteOffRequest.js +209 -0
- package/dist/zuora_api/model/DebitMemoItemsResponse.js +12 -1
- package/dist/zuora_api/model/DebitMemoObjectNSFields.js +12 -1
- package/dist/zuora_api/model/DebitMemoResponse.js +48 -1
- package/dist/zuora_api/model/DebitMemoTaxItemFromInvoiceTaxItemFinanceInformation.js +12 -1
- package/dist/zuora_api/model/DebitMemoTaxItemFromInvoiceTaxItemRequest.js +12 -1
- package/dist/zuora_api/model/DebitMemoTaxationItemWriteOffRequest.js +111 -0
- package/dist/zuora_api/model/DebitMemosResponse.js +12 -1
- package/dist/zuora_api/model/DecryptRSASignatureRequest.js +13 -2
- package/dist/zuora_api/model/DecryptRSASignatureResponse.js +12 -1
- package/dist/zuora_api/model/DeleteAccountResponse.js +12 -1
- package/dist/zuora_api/model/DeleteAttachmentResponse.js +12 -1
- package/dist/zuora_api/model/DeleteBatchQueryJobResponse.js +12 -1
- package/dist/zuora_api/model/DeleteBatchQueryResponse.js +12 -1
- package/dist/zuora_api/model/DeleteDataQueryJobResponse.js +12 -1
- package/dist/zuora_api/model/DeleteResult.js +12 -1
- package/dist/zuora_api/model/DeleteSubscriptionResponse.js +12 -1
- package/dist/zuora_api/model/DeleteWorkflowError.js +12 -1
- package/dist/zuora_api/model/DeleteWorkflowSuccess.js +12 -1
- package/dist/zuora_api/model/DeletedRecord.js +12 -1
- package/dist/zuora_api/model/DeliverySchedule.js +12 -1
- package/dist/zuora_api/model/DeliveryScheduleParams.js +12 -1
- package/dist/zuora_api/model/DeliveryScheduleProductRatePlanCharge.js +12 -1
- package/dist/zuora_api/model/DetailedWorkflow.js +12 -1
- package/dist/zuora_api/model/DiscountApplyDetail.js +12 -1
- package/dist/zuora_api/model/DiscountPricingOverride.js +12 -5
- package/dist/zuora_api/model/DiscountPricingUpdate.js +12 -5
- package/dist/zuora_api/model/DocumentIdList.js +12 -1
- package/dist/zuora_api/model/ElectronicPaymentOptions.js +12 -1
- package/dist/zuora_api/model/ElectronicPaymentOptionsWithDelayedCapturePayment.js +12 -1
- package/dist/zuora_api/model/EmailBillRunRequest.js +12 -1
- package/dist/zuora_api/model/EmailBillingDocumentRequest.js +12 -1
- package/dist/zuora_api/model/EndConditions.js +12 -1
- package/dist/zuora_api/model/Error401.js +12 -1
- package/dist/zuora_api/model/ErrorResponse.js +12 -1
- package/dist/zuora_api/model/ErrorResponse401Record.js +12 -1
- package/dist/zuora_api/model/ErrorResponseReasonsInner.js +12 -1
- package/dist/zuora_api/model/EventTrigger.js +12 -1
- package/dist/zuora_api/model/EventType.js +13 -2
- package/dist/zuora_api/model/ExecuteInvoiceScheduleRequest.js +12 -1
- package/dist/zuora_api/model/ExpandedAccount.js +12 -1
- package/dist/zuora_api/model/ExpandedAmendment.js +12 -1
- package/dist/zuora_api/model/ExpandedAuthentication.js +12 -1
- package/dist/zuora_api/model/ExpandedBillingRun.js +12 -1
- package/dist/zuora_api/model/ExpandedContact.js +12 -1
- package/dist/zuora_api/model/ExpandedCreditMemo.js +24 -1
- package/dist/zuora_api/model/ExpandedCreditMemoApplication.js +12 -1
- package/dist/zuora_api/model/ExpandedCreditMemoItem.js +36 -1
- package/dist/zuora_api/model/ExpandedDailyConsumptionSummary.js +12 -1
- package/dist/zuora_api/model/ExpandedDebitMemo.js +24 -1
- package/dist/zuora_api/model/ExpandedDebitMemoItem.js +12 -1
- package/dist/zuora_api/model/ExpandedExternalProductRatePlan.js +186 -0
- package/dist/zuora_api/model/ExpandedInvoice.js +12 -1
- package/dist/zuora_api/model/ExpandedInvoiceItem.js +12 -1
- package/dist/zuora_api/model/ExpandedMapping.js +12 -1
- package/dist/zuora_api/model/ExpandedOAuth.js +12 -1
- package/dist/zuora_api/model/ExpandedOAuthError.js +12 -1
- package/dist/zuora_api/model/ExpandedOrderAction.js +12 -1
- package/dist/zuora_api/model/ExpandedOrderLineItem.js +52 -1
- package/dist/zuora_api/model/ExpandedOrders.js +12 -1
- package/dist/zuora_api/model/ExpandedPayment.js +12 -1
- package/dist/zuora_api/model/ExpandedPaymentApplication.js +12 -1
- package/dist/zuora_api/model/ExpandedPaymentMethod.js +72 -1
- package/dist/zuora_api/model/ExpandedPaymentMethodSnapshot.js +12 -1
- package/dist/zuora_api/model/ExpandedPaymentRun.js +12 -1
- package/dist/zuora_api/model/ExpandedPaymentSchedule.js +12 -1
- package/dist/zuora_api/model/ExpandedPaymentScheduleItem.js +12 -1
- package/dist/zuora_api/model/ExpandedPrepaidBalance.js +12 -1
- package/dist/zuora_api/model/ExpandedPrepaidBalanceFund.js +12 -1
- package/dist/zuora_api/model/ExpandedPrepaidBalanceTransaction.js +12 -1
- package/dist/zuora_api/model/ExpandedProcessedUsage.js +12 -1
- package/dist/zuora_api/model/ExpandedProduct.js +12 -1
- package/dist/zuora_api/model/ExpandedProductRatePlan.js +25 -1
- package/dist/zuora_api/model/ExpandedProductRatePlanCharge.js +12 -1
- package/dist/zuora_api/model/ExpandedProductRatePlanChargeTier.js +12 -1
- package/dist/zuora_api/model/ExpandedRatePlan.js +12 -1
- package/dist/zuora_api/model/ExpandedRatePlanCharge.js +12 -1
- package/dist/zuora_api/model/ExpandedRatePlanChargeTier.js +12 -1
- package/dist/zuora_api/model/ExpandedRatingResult.js +12 -1
- package/dist/zuora_api/model/ExpandedRefund.js +12 -1
- package/dist/zuora_api/model/ExpandedRefundApplication.js +12 -1
- package/dist/zuora_api/model/ExpandedRefundApplicationItem.js +12 -1
- package/dist/zuora_api/model/ExpandedReportDownloadError.js +12 -1
- package/dist/zuora_api/model/ExpandedReportGetRecent.js +12 -1
- package/dist/zuora_api/model/ExpandedReportGetRecentDownloadError.js +12 -1
- package/dist/zuora_api/model/ExpandedReportGetRecentNotFoundError.js +12 -1
- package/dist/zuora_api/model/ExpandedReportList.js +12 -1
- package/dist/zuora_api/model/ExpandedReportListError.js +12 -1
- package/dist/zuora_api/model/ExpandedSignedUrl.js +12 -1
- package/dist/zuora_api/model/ExpandedStageError.js +12 -1
- package/dist/zuora_api/model/ExpandedSubscription.js +12 -1
- package/dist/zuora_api/model/ExpandedTaxationItem.js +12 -1
- package/dist/zuora_api/model/ExpandedUploadCsv.js +12 -1
- package/dist/zuora_api/model/ExpandedUploadCsvError.js +12 -1
- package/dist/zuora_api/model/ExpandedUploadCsvErrorStatus.js +12 -1
- package/dist/zuora_api/model/ExpandedUploadCsvResult.js +12 -1
- package/dist/zuora_api/model/ExpandedUploadCsvStatus.js +12 -1
- package/dist/zuora_api/model/ExpandedUploadCsvStatusResult.js +12 -1
- package/dist/zuora_api/model/ExpandedUploadFile.js +12 -1
- package/dist/zuora_api/model/ExpandedUploadFileError.js +12 -1
- package/dist/zuora_api/model/ExpandedUploadFileStatus.js +12 -1
- package/dist/zuora_api/model/ExpandedUsage.js +24 -1
- package/dist/zuora_api/model/ExpandedValidityPeriodSummary.js +24 -1
- package/dist/zuora_api/model/ExportWorkflowVersionResponse.js +12 -1
- package/dist/zuora_api/model/FailedReason.js +12 -1
- package/dist/zuora_api/model/FaultResponse.js +12 -1
- package/dist/zuora_api/model/FilterRuleParameterDefinition.js +12 -1
- package/dist/zuora_api/model/Fulfillment.js +13 -2
- package/dist/zuora_api/model/FulfillmentItem.js +12 -1
- package/dist/zuora_api/model/GETBookingDateBackfillJobById200Response.js +12 -1
- package/dist/zuora_api/model/GETDataBackfillJobById200Response.js +12 -1
- package/dist/zuora_api/model/GETListBookingDateBackfillJobs200Response.js +12 -1
- package/dist/zuora_api/model/GETListDataBackfillJobs200Response.js +12 -1
- package/dist/zuora_api/model/GatewayOptions.js +12 -1
- package/dist/zuora_api/model/GenerateBillingDocumentRequest.js +12 -1
- package/dist/zuora_api/model/GenerateBillingDocumentResponse.js +12 -1
- package/dist/zuora_api/model/GenerateBillingDocumentResponseCreditMemo.js +12 -1
- package/dist/zuora_api/model/GenerateBillingDocumentResponseInvoice.js +12 -1
- package/dist/zuora_api/model/GetAccountPMAccountHolderInfo.js +12 -1
- package/dist/zuora_api/model/GetAccountPaymentMethodResponse.js +12 -1
- package/dist/zuora_api/model/GetAccountingCodeResponse.js +12 -1
- package/dist/zuora_api/model/GetAccountingCodesResponse.js +12 -1
- package/dist/zuora_api/model/GetAccountingPeriodAllOfFieIdsResponse.js +12 -1
- package/dist/zuora_api/model/GetAccountingPeriodResponse.js +12 -1
- package/dist/zuora_api/model/GetAccountingPeriodWithoutSuccessResponse.js +12 -1
- package/dist/zuora_api/model/GetAccountingPeriodsResponse.js +12 -1
- package/dist/zuora_api/model/GetAllCustomObjectDefinitionsInNamespaceResponse.js +12 -1
- package/dist/zuora_api/model/GetApiVolumeSummaryResponse.js +12 -1
- package/dist/zuora_api/model/GetAsyncOrderJobResponse.js +12 -1
- package/dist/zuora_api/model/GetAttachmentResponse.js +12 -1
- package/dist/zuora_api/model/GetAttachmentsResponse.js +12 -1
- package/dist/zuora_api/model/GetBatchQueryJobResponse.js +12 -1
- package/dist/zuora_api/model/GetBatchQueryResponse.js +12 -1
- package/dist/zuora_api/model/GetBillingAdjustmentsBySubscriptionNumberResponse.js +12 -1
- package/dist/zuora_api/model/GetBillingAdjustmentsResponse.js +12 -1
- package/dist/zuora_api/model/GetBillingDocVolumeSummaryResponse.js +12 -1
- package/dist/zuora_api/model/GetBillingDocumentFilesDeletionJobResponse.js +12 -1
- package/dist/zuora_api/model/GetBillingDocumentsResponse.js +12 -1
- package/dist/zuora_api/model/GetBillingPreviewRunResponse.js +12 -1
- package/dist/zuora_api/model/GetBulkPdfGenerationJobResponse.js +46 -1
- package/dist/zuora_api/model/GetBulkUpdateOrderLineItemsResponse.js +12 -1
- package/dist/zuora_api/model/GetCalloutHistoryVOType.js +12 -1
- package/dist/zuora_api/model/GetCalloutHistoryVOsType.js +12 -1
- package/dist/zuora_api/model/GetCatalogGroupResponse.js +12 -5
- package/dist/zuora_api/model/GetCatalogGroupsResponse.js +12 -1
- package/dist/zuora_api/model/GetChargeOverride.js +67 -4
- package/dist/zuora_api/model/GetCreditMemoItemPartResponse.js +12 -1
- package/dist/zuora_api/model/GetCreditMemoItemPartsResponse.js +12 -1
- package/dist/zuora_api/model/GetCreditMemoItemTaxationItems.js +12 -1
- package/dist/zuora_api/model/GetCreditMemoPartResponse.js +12 -1
- package/dist/zuora_api/model/GetCreditMemoPartsResponse.js +12 -1
- package/dist/zuora_api/model/GetCreditMemoPdfStatusBatchResponse.js +12 -1
- package/dist/zuora_api/model/GetCreditMemoPdfStatusResponse.js +51 -1
- package/dist/zuora_api/model/GetCreditMemoTaxItemFinanceInformation.js +12 -1
- package/dist/zuora_api/model/GetCreditMemoTaxItemResponse.js +12 -1
- package/dist/zuora_api/model/GetCreditMemoTaxationItemResponse.js +12 -1
- package/dist/zuora_api/model/GetCustomExchangeRatesDataType.js +12 -1
- package/dist/zuora_api/model/GetCustomExchangeRatesType.js +12 -1
- package/dist/zuora_api/model/GetDataQueryJobResponse.js +12 -1
- package/dist/zuora_api/model/GetDataQueryJobsResponse.js +12 -1
- package/dist/zuora_api/model/GetDebitMemoApplicationPart.js +24 -5
- package/dist/zuora_api/model/GetDebitMemoApplicationPartsResponse.js +12 -1
- package/dist/zuora_api/model/GetDebitMemoItemFinanceInformation.js +12 -1
- package/dist/zuora_api/model/GetDebitMemoPdfStatusBatchResponse.js +12 -1
- package/dist/zuora_api/model/GetDebitMemoPdfStatusResponse.js +51 -1
- package/dist/zuora_api/model/GetDebitMemoTaxItem.js +12 -1
- package/dist/zuora_api/model/GetDebitMemoTaxItemFinanceInformation.js +12 -1
- package/dist/zuora_api/model/GetDebitMemoTaxItemNew.js +12 -1
- package/dist/zuora_api/model/GetEmailHistoryVOType.js +12 -1
- package/dist/zuora_api/model/GetEmailHistoryVOsType.js +12 -1
- package/dist/zuora_api/model/GetEventTriggers200Response.js +12 -1
- package/dist/zuora_api/model/GetFulfillment.js +14 -3
- package/dist/zuora_api/model/GetFulfillmentItem.js +12 -1
- package/dist/zuora_api/model/GetFulfillmentItemResponse.js +12 -1
- package/dist/zuora_api/model/GetFulfillmentResponse.js +12 -1
- package/dist/zuora_api/model/GetInvoiceApplicationPartRequest.js +12 -1
- package/dist/zuora_api/model/GetInvoiceApplicationPartsRequest.js +12 -1
- package/dist/zuora_api/model/GetInvoicePdfStatusBatchResponse.js +12 -1
- package/dist/zuora_api/model/GetInvoicePdfStatusResponse.js +51 -1
- package/dist/zuora_api/model/GetJournalEntriesInJournalRunResponse.js +12 -1
- package/dist/zuora_api/model/GetJournalEntryDetailResponse.js +12 -1
- package/dist/zuora_api/model/GetJournalEntryDetailTypeWithoutSuccess.js +12 -1
- package/dist/zuora_api/model/GetJournalEntryItemResponse.js +12 -1
- package/dist/zuora_api/model/GetJournalEntrySegmentResponse.js +12 -1
- package/dist/zuora_api/model/GetJournalRunResponse.js +12 -1
- package/dist/zuora_api/model/GetJournalRunTransactionResponse.js +12 -1
- package/dist/zuora_api/model/GetMassUpdateResponse.js +12 -1
- package/dist/zuora_api/model/GetMetricsBySubscriptionNumbersResponse.js +12 -1
- package/dist/zuora_api/model/GetOrderActionRatePlanResponse.js +12 -1
- package/dist/zuora_api/model/GetOrderLineItem.js +84 -21
- package/dist/zuora_api/model/GetOrderLineItemResponse.js +12 -1
- package/dist/zuora_api/model/GetOrderResponse.js +12 -1
- package/dist/zuora_api/model/GetOrdersResponse.js +12 -1
- package/dist/zuora_api/model/GetPMAccountHolderInfo.js +12 -1
- package/dist/zuora_api/model/GetPaymentFinanceInformation.js +12 -1
- package/dist/zuora_api/model/GetPaymentItemPartResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentItemPartsResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentMethodForAccountResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentMethodResponseACHForAccount.js +12 -1
- package/dist/zuora_api/model/GetPaymentMethodResponseApplePayForAccount.js +12 -1
- package/dist/zuora_api/model/GetPaymentMethodResponseBankTransferForAccount.js +12 -1
- package/dist/zuora_api/model/GetPaymentMethodResponseCreditCardForAccount.js +12 -1
- package/dist/zuora_api/model/GetPaymentMethodResponseGooglePayForAccount.js +12 -1
- package/dist/zuora_api/model/GetPaymentMethodResponsePayPalForAccount.js +12 -1
- package/dist/zuora_api/model/GetPaymentPartResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentPartsResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentRunDataArrayResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentRunDataElementResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentRunDataTransactionElementResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentRunStatisticResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentRunSummaryResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentRunSummaryTotalValuesResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentRunsResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentScheduleStatisticResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentScheduleStatisticResponsePaymentScheduleItems.js +12 -1
- package/dist/zuora_api/model/GetPaymentSchedulesResponse.js +13 -2
- package/dist/zuora_api/model/GetPaymentVolumeSummaryResponse.js +12 -1
- package/dist/zuora_api/model/GetPaymentsResponse.js +12 -1
- package/dist/zuora_api/model/GetProductRatePlanChargeResponse.js +25 -1
- package/dist/zuora_api/model/GetProductRatePlanChargeTierResponse.js +12 -1
- package/dist/zuora_api/model/GetProductRatePlanResponse.js +12 -1
- package/dist/zuora_api/model/GetProductRatePlansByExternalIdResponse.js +12 -1
- package/dist/zuora_api/model/GetProductRatePlansByProductResponse.js +12 -1
- package/dist/zuora_api/model/GetProductResponse.js +12 -1
- package/dist/zuora_api/model/GetProductsResponse.js +12 -1
- package/dist/zuora_api/model/GetPublicEmailTemplateResponse.js +12 -5
- package/dist/zuora_api/model/GetPublicNotificationDefinitionResponse.js +12 -1
- package/dist/zuora_api/model/GetPublicNotificationDefinitionResponseCallout.js +12 -1
- package/dist/zuora_api/model/GetPublicNotificationDefinitionResponseFilterRule.js +12 -1
- package/dist/zuora_api/model/GetQueryEmailTemplates200Response.js +12 -1
- package/dist/zuora_api/model/GetQueryNotificationDefinitions200Response.js +12 -1
- package/dist/zuora_api/model/GetRampByRampNumberResponse.js +12 -1
- package/dist/zuora_api/model/GetRampMetricsByOrderNumberResponse.js +12 -1
- package/dist/zuora_api/model/GetRampMetricsByRampNumberResponse.js +12 -1
- package/dist/zuora_api/model/GetRampMetricsBySubscriptionKeyResponse.js +12 -1
- package/dist/zuora_api/model/GetRampsBySubscriptionKeyResponse.js +12 -1
- package/dist/zuora_api/model/GetRefundCreditMemoFinanceInformation.js +12 -1
- package/dist/zuora_api/model/GetRefundItemPartResponse.js +12 -1
- package/dist/zuora_api/model/GetRefundItemPartsResponse.js +12 -1
- package/dist/zuora_api/model/GetRefundPartResponse.js +12 -1
- package/dist/zuora_api/model/GetRefundPartsResponse.js +12 -1
- package/dist/zuora_api/model/GetRefundsResponse.js +12 -1
- package/dist/zuora_api/model/GetScheduledEventResponse.js +12 -1
- package/dist/zuora_api/model/GetScheduledEventResponseParametersValue.js +12 -1
- package/dist/zuora_api/model/GetScheduledEvents200Response.js +12 -1
- package/dist/zuora_api/model/GetSequenceSetResponse.js +12 -1
- package/dist/zuora_api/model/GetSequenceSetsResponse.js +12 -1
- package/dist/zuora_api/model/GetSubscriptionChangeLogResponse.js +195 -0
- package/dist/zuora_api/model/GetSubscriptionChangeLogsResponse.js +211 -0
- package/dist/zuora_api/model/GetSubscriptionProductFeature.js +12 -1
- package/dist/zuora_api/model/GetSubscriptionRatePlan.js +12 -1
- package/dist/zuora_api/model/GetSubscriptionRatePlanChargesWithAllSegments.js +20 -1
- package/dist/zuora_api/model/GetSubscriptionResponse.js +58 -1
- package/dist/zuora_api/model/GetSubscriptionsResponse.js +12 -1
- package/dist/zuora_api/model/GetTaxationItemResponse.js +12 -1
- package/dist/zuora_api/model/GetTaxationItemsOfCreditMemoItemResponse.js +12 -1
- package/dist/zuora_api/model/GetTaxationItemsOfDebitMemoItemResponse.js +12 -1
- package/dist/zuora_api/model/GetTaxationItemsResponse.js +12 -1
- package/dist/zuora_api/model/GetUsageRateDetailRequest.js +12 -1
- package/dist/zuora_api/model/GetUsageRateDetailRequestData.js +12 -1
- package/dist/zuora_api/model/GetUsageResponse.js +12 -1
- package/dist/zuora_api/model/GetUsagesByAccountResponse.js +12 -1
- package/dist/zuora_api/model/GetVersionsResponse.js +12 -1
- package/dist/zuora_api/model/GetWorkflowResponse.js +12 -1
- package/dist/zuora_api/model/GetWorkflowResponseTasks.js +12 -1
- package/dist/zuora_api/model/GetWorkflowsResponse.js +12 -1
- package/dist/zuora_api/model/GetWorkflowsResponsePagination.js +12 -1
- package/dist/zuora_api/model/HostedPageResponse.js +12 -1
- package/dist/zuora_api/model/HostedPagesResponse.js +12 -1
- package/dist/zuora_api/model/IneligibleBillingAdjustment.js +12 -1
- package/dist/zuora_api/model/InitialTerm.js +12 -1
- package/dist/zuora_api/model/IntervalPricing.js +12 -1
- package/dist/zuora_api/model/IntervalPricingTier.js +12 -1
- package/dist/zuora_api/model/Invoice.js +38 -1
- package/dist/zuora_api/model/InvoiceEntityPrefix.js +12 -1
- package/dist/zuora_api/model/InvoiceFile.js +12 -1
- package/dist/zuora_api/model/InvoiceFilesResponse.js +12 -1
- package/dist/zuora_api/model/InvoiceItem.js +25 -1
- package/dist/zuora_api/model/InvoiceItemObjectNSFields.js +12 -1
- package/dist/zuora_api/model/InvoiceItemPreviewResult.js +12 -1
- package/dist/zuora_api/model/InvoiceItemPreviewResultAdditionalInfo.js +12 -1
- package/dist/zuora_api/model/InvoiceItemPreviewResultTaxationItems.js +12 -1
- package/dist/zuora_api/model/InvoiceItemsResponse.js +12 -1
- package/dist/zuora_api/model/InvoiceObjectNSFields.js +12 -1
- package/dist/zuora_api/model/InvoicePostResponse.js +12 -1
- package/dist/zuora_api/model/InvoiceResponse.js +48 -1
- package/dist/zuora_api/model/InvoiceSchedule.js +12 -1
- package/dist/zuora_api/model/InvoiceScheduleCustomFields.js +12 -1
- package/dist/zuora_api/model/InvoiceScheduleItem.js +12 -1
- package/dist/zuora_api/model/InvoiceScheduleItemCustomFields.js +12 -1
- package/dist/zuora_api/model/InvoiceScheduleResponse.js +12 -1
- package/dist/zuora_api/model/InvoiceScheduleSubscription.js +12 -1
- package/dist/zuora_api/model/InvoiceTaxationItem.js +12 -1
- package/dist/zuora_api/model/Job.js +12 -1
- package/dist/zuora_api/model/LastTerm.js +13 -2
- package/dist/zuora_api/model/Linkage.js +12 -1
- package/dist/zuora_api/model/ListAllSettingsResponse.js +12 -1
- package/dist/zuora_api/model/ListOfExchangeRates.js +12 -1
- package/dist/zuora_api/model/MemoDetailRevenueImpacting.js +58 -0
- package/dist/zuora_api/model/MemoRevenueImpacting.js +58 -0
- package/dist/zuora_api/model/MemoSourceType.js +10 -0
- package/dist/zuora_api/model/MigrationClientResponse.js +13 -2
- package/dist/zuora_api/model/MigrationComponentContent.js +12 -1
- package/dist/zuora_api/model/MigrationUpdateCustomObjectDefinitionsRequest.js +13 -2
- package/dist/zuora_api/model/MigrationUpdateCustomObjectDefinitionsResponse.js +12 -1
- package/dist/zuora_api/model/NotificationsHistoryDeletionTaskResponse.js +12 -1
- package/dist/zuora_api/model/ObjectPostImportRequest.js +13 -2
- package/dist/zuora_api/model/OneTimeFlatFeePricingOverride.js +13 -2
- package/dist/zuora_api/model/OneTimePerUnitPricingOverride.js +12 -1
- package/dist/zuora_api/model/OneTimeTieredPricingOverride.js +12 -1
- package/dist/zuora_api/model/OneTimeVolumePricingOverride.js +12 -1
- package/dist/zuora_api/model/OpenPaymentMethodTypeRequestFields.js +12 -1
- package/dist/zuora_api/model/OpenPaymentMethodTypeResponse.js +12 -1
- package/dist/zuora_api/model/OpenPaymentMethodTypeResponseFields.js +12 -1
- package/dist/zuora_api/model/OperationJobResponse.js +12 -1
- package/dist/zuora_api/model/Options.js +12 -1
- package/dist/zuora_api/model/Order.js +18 -7
- package/dist/zuora_api/model/OrderAction.js +14 -3
- package/dist/zuora_api/model/OrderActionAddProduct.js +15 -4
- package/dist/zuora_api/model/OrderActionCancelSubscription.js +13 -2
- package/dist/zuora_api/model/OrderActionChangePlan.js +12 -1
- package/dist/zuora_api/model/OrderActionCreateSubscription.js +25 -1
- package/dist/zuora_api/model/OrderActionCreateSubscriptionTerms.js +17 -8
- package/dist/zuora_api/model/OrderActionOwnerTransfer.js +34 -1
- package/dist/zuora_api/model/OrderActionRatePlanAmendment.js +12 -1
- package/dist/zuora_api/model/OrderActionRatePlanBillingUpdate.js +12 -1
- package/dist/zuora_api/model/OrderActionRatePlanChargeModelDataOverride.js +12 -1
- package/dist/zuora_api/model/OrderActionRatePlanChargeOverride.js +13 -2
- package/dist/zuora_api/model/OrderActionRatePlanChargeRemove.js +12 -1
- package/dist/zuora_api/model/OrderActionRatePlanChargeUpdate.js +12 -1
- package/dist/zuora_api/model/OrderActionRatePlanOrder.js +12 -1
- package/dist/zuora_api/model/OrderActionRatePlanOrderAction.js +12 -1
- package/dist/zuora_api/model/OrderActionRatePlanOverride.js +13 -2
- package/dist/zuora_api/model/OrderActionRatePlanPricingUpdate.js +12 -1
- package/dist/zuora_api/model/OrderActionRatePlanRecurringDeliveryPricingOverride.js +12 -5
- package/dist/zuora_api/model/OrderActionRatePlanRecurringDeliveryPricingUpdate.js +12 -5
- package/dist/zuora_api/model/OrderActionRatePlanRecurringFlatFeePricingOverride.js +12 -5
- package/dist/zuora_api/model/OrderActionRatePlanRecurringPerUnitPricingOverride.js +12 -5
- package/dist/zuora_api/model/OrderActionRatePlanRecurringTieredPricingOverride.js +12 -5
- package/dist/zuora_api/model/OrderActionRatePlanRecurringVolumePricingOverride.js +12 -5
- package/dist/zuora_api/model/OrderActionRatePlanRemoveProduct.js +12 -1
- package/dist/zuora_api/model/OrderActionRatePlanUpdate.js +12 -1
- package/dist/zuora_api/model/OrderActionRemoveProduct.js +12 -1
- package/dist/zuora_api/model/OrderActionRenewSubscription.js +34 -1
- package/dist/zuora_api/model/OrderActionResume.js +12 -1
- package/dist/zuora_api/model/OrderActionSuspend.js +12 -1
- package/dist/zuora_api/model/OrderActionTermsAndConditions.js +88 -1
- package/dist/zuora_api/model/OrderActionUpdateProduct.js +12 -1
- package/dist/zuora_api/model/OrderCreateAccount.js +30 -2
- package/dist/zuora_api/model/OrderCreateAccountContact.js +13 -2
- package/dist/zuora_api/model/OrderDeltaMetric.js +12 -1
- package/dist/zuora_api/model/OrderDeltaMrr.js +12 -1
- package/dist/zuora_api/model/OrderDeltaTcb.js +12 -1
- package/dist/zuora_api/model/OrderDeltaTcv.js +12 -1
- package/dist/zuora_api/model/OrderExistingAccountDetails.js +12 -1
- package/dist/zuora_api/model/OrderItem.js +12 -1
- package/dist/zuora_api/model/OrderLineItem.js +64 -21
- package/dist/zuora_api/model/OrderLineItemState.js +2 -2
- package/dist/zuora_api/model/OrderMetric.js +12 -1
- package/dist/zuora_api/model/OrderRampIntervalMetrics.js +12 -1
- package/dist/zuora_api/model/OrderRampMetrics.js +12 -1
- package/dist/zuora_api/model/OrderSchedulingOptions.js +12 -1
- package/dist/zuora_api/model/OrderSubscriptions.js +12 -1
- package/dist/zuora_api/model/OrderSubscriptionsSubscriptionOwnerAccountDetails.js +12 -1
- package/dist/zuora_api/model/OrganizationLabel.js +12 -1
- package/dist/zuora_api/model/OverrideDiscountApplyDetail.js +13 -2
- package/dist/zuora_api/model/PATCHUpdateWorkflowRequest.js +12 -1
- package/dist/zuora_api/model/POSTCreateBookingDateBackfillJob200Response.js +12 -1
- package/dist/zuora_api/model/POSTCreateDataBackfillJob200Response.js +12 -1
- package/dist/zuora_api/model/POSTCreateDataBackfillJobRequest.js +13 -2
- package/dist/zuora_api/model/PUTStopBookingDateBackfillJobByIdRequest.js +13 -2
- package/dist/zuora_api/model/Payment.js +12 -1
- package/dist/zuora_api/model/PaymentData.js +12 -1
- package/dist/zuora_api/model/PaymentEntityPrefix.js +12 -1
- package/dist/zuora_api/model/PaymentGatewaysResponse.js +12 -1
- package/dist/zuora_api/model/PaymentGatwayResponse.js +12 -1
- package/dist/zuora_api/model/PaymentItemPart.js +12 -1
- package/dist/zuora_api/model/PaymentMethodObjectCustomFields.js +12 -1
- package/dist/zuora_api/model/PaymentMethodObjectCustomFieldsForAccount.js +12 -1
- package/dist/zuora_api/model/PaymentMethodRequestMandateInfo.js +12 -1
- package/dist/zuora_api/model/PaymentMethodRequestProcessingOptions.js +12 -1
- package/dist/zuora_api/model/PaymentMethodResponse.js +12 -1
- package/dist/zuora_api/model/PaymentMethodResponseACH.js +12 -1
- package/dist/zuora_api/model/PaymentMethodResponseApplePay.js +12 -1
- package/dist/zuora_api/model/PaymentMethodResponseBankTransfer.js +12 -1
- package/dist/zuora_api/model/PaymentMethodResponseCreditCard.js +12 -1
- package/dist/zuora_api/model/PaymentMethodResponseGooglePay.js +12 -1
- package/dist/zuora_api/model/PaymentMethodResponseMandateInfo.js +12 -1
- package/dist/zuora_api/model/PaymentMethodResponsePayPal.js +12 -1
- package/dist/zuora_api/model/PaymentMethodSnapshotResponse.js +12 -1
- package/dist/zuora_api/model/PaymentMethodTransactionLogResponse.js +12 -1
- package/dist/zuora_api/model/PaymentMethodUpdaterInstanceResponse.js +12 -1
- package/dist/zuora_api/model/PaymentMethodUpdaterInstancesResponse.js +12 -1
- package/dist/zuora_api/model/PaymentPart.js +12 -1
- package/dist/zuora_api/model/PaymentRequestFinanceInformation.js +12 -1
- package/dist/zuora_api/model/PaymentResponse.js +12 -1
- package/dist/zuora_api/model/PaymentRun.js +12 -1
- package/dist/zuora_api/model/PaymentRunResponse.js +12 -1
- package/dist/zuora_api/model/PaymentSchedule.js +12 -1
- package/dist/zuora_api/model/PaymentScheduleBillingDocument.js +13 -2
- package/dist/zuora_api/model/PaymentScheduleItem.js +12 -1
- package/dist/zuora_api/model/PaymentScheduleItemResponse.js +12 -1
- package/dist/zuora_api/model/PaymentScheduleLinkedPaymentID.js +12 -1
- package/dist/zuora_api/model/PaymentSchedulePaymentOptionFields.js +12 -1
- package/dist/zuora_api/model/PaymentSchedulePaymentOptionFieldsDetail.js +12 -1
- package/dist/zuora_api/model/PaymentScheduleResponse.js +12 -1
- package/dist/zuora_api/model/PaymentTransactionLogResponse.js +12 -1
- package/dist/zuora_api/model/PaymentVolumeSummaryRecord.js +12 -1
- package/dist/zuora_api/model/PaymentWithCustomRates.js +13 -2
- package/dist/zuora_api/model/PostAsyncInvoiceRequest.js +12 -1
- package/dist/zuora_api/model/PostAttachmentResponse.js +12 -1
- package/dist/zuora_api/model/PostAttachmentsRequest.js +13 -2
- package/dist/zuora_api/model/PostBillRunRequest.js +13 -2
- package/dist/zuora_api/model/PostBusinessRegionsRequest.js +13 -2
- package/dist/zuora_api/model/PostCompareTemplateRequest.js +12 -1
- package/dist/zuora_api/model/PostCreateOrUpdateEmailTemplateRequest.js +12 -1
- package/dist/zuora_api/model/PostCreateOrUpdateEmailTemplateRequestFormat.js +13 -22
- package/dist/zuora_api/model/PostCreditMemoRequest.js +12 -1
- package/dist/zuora_api/model/PostCustomObjectDefinitionFieldDefinitionRequest.js +13 -2
- package/dist/zuora_api/model/PostCustomObjectDefinitionsRequest.js +12 -1
- package/dist/zuora_api/model/PostCustomObjectDefinitionsRequestDefinition.js +13 -2
- package/dist/zuora_api/model/PostCustomObjectRecordsRequest.js +13 -2
- package/dist/zuora_api/model/PostCustomObjectRecordsResponse.js +12 -1
- package/dist/zuora_api/model/PostEventTriggerRequest.js +13 -2
- package/dist/zuora_api/model/PostInvoiceRequest.js +12 -1
- package/dist/zuora_api/model/PostPublicEmailTemplateRequest.js +13 -10
- package/dist/zuora_api/model/PostPublicNotificationDefinitionRequest.js +13 -2
- package/dist/zuora_api/model/PostPublicNotificationDefinitionRequestCallout.js +13 -2
- package/dist/zuora_api/model/PostPublicNotificationDefinitionRequestFilterRule.js +13 -2
- package/dist/zuora_api/model/PostResendCalloutNotifications.js +13 -2
- package/dist/zuora_api/model/PostResendEmailNotifications.js +13 -2
- package/dist/zuora_api/model/PostRunWorkflow400Response.js +12 -1
- package/dist/zuora_api/model/PostRunWorkflow406Response.js +12 -1
- package/dist/zuora_api/model/PostScheduledEventRequest.js +13 -2
- package/dist/zuora_api/model/PostScheduledEventRequestParametersValue.js +12 -1
- package/dist/zuora_api/model/PostServiceProviderRequest.js +13 -2
- package/dist/zuora_api/model/PostWorkflowDefinitionImportRequest.js +12 -1
- package/dist/zuora_api/model/PostWorkflowVersionsImportRequest.js +12 -1
- package/dist/zuora_api/model/PreviewAccountInfo.js +26 -2
- package/dist/zuora_api/model/PreviewChargeMetrics.js +12 -1
- package/dist/zuora_api/model/PreviewChargeMetricsCmrr.js +12 -1
- package/dist/zuora_api/model/PreviewChargeMetricsTax.js +12 -1
- package/dist/zuora_api/model/PreviewChargeMetricsTcb.js +12 -1
- package/dist/zuora_api/model/PreviewChargeMetricsTcv.js +12 -1
- package/dist/zuora_api/model/PreviewContactInfo.js +12 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionCreditMemoItemResult.js +12 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionDiscountDetails.js +12 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionInvoiceItemResult.js +12 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionRequest.js +12 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionResponse.js +12 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionResultCreditMemos.js +12 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionResultInvoices.js +12 -1
- package/dist/zuora_api/model/PreviewOptions.js +12 -1
- package/dist/zuora_api/model/PreviewOrderAsyncRequest.js +13 -6
- package/dist/zuora_api/model/PreviewOrderAsyncResponse.js +12 -1
- package/dist/zuora_api/model/PreviewOrderChargeOverride.js +13 -2
- package/dist/zuora_api/model/PreviewOrderChargeUpdate.js +12 -1
- package/dist/zuora_api/model/PreviewOrderCreateSubscription.js +25 -1
- package/dist/zuora_api/model/PreviewOrderCreateSubscriptionTerms.js +13 -2
- package/dist/zuora_api/model/PreviewOrderOrderAction.js +13 -2
- package/dist/zuora_api/model/PreviewOrderPricingUpdate.js +12 -1
- package/dist/zuora_api/model/PreviewOrderRatePlanOverride.js +13 -2
- package/dist/zuora_api/model/PreviewOrderRatePlanUpdate.js +12 -1
- package/dist/zuora_api/model/PreviewOrderRequest.js +17 -10
- package/dist/zuora_api/model/PreviewOrderResponse.js +12 -1
- package/dist/zuora_api/model/PreviewOrderResult.js +12 -1
- package/dist/zuora_api/model/PreviewOrderResultChargeMetrics.js +12 -1
- package/dist/zuora_api/model/PreviewOrderResultCreditMemos.js +12 -1
- package/dist/zuora_api/model/PreviewOrderResultDeltaMetrics.js +12 -1
- package/dist/zuora_api/model/PreviewOrderResultInvoices.js +12 -1
- package/dist/zuora_api/model/PreviewOrderSubscriptionOwnerAccount.js +13 -2
- package/dist/zuora_api/model/PreviewOrderSubscriptions.js +174 -0
- package/dist/zuora_api/model/PreviewOrderSubscriptionsAsync.js +43 -1
- package/dist/zuora_api/model/PreviewPaymentSchedule.js +12 -1
- package/dist/zuora_api/model/PreviewResultOrderMetricsInner.js +12 -1
- package/dist/zuora_api/model/PreviewResultOrderMetricsInnerOrderActionsInner.js +12 -1
- package/dist/zuora_api/model/PreviewStartDate.js +12 -1
- package/dist/zuora_api/model/PreviewSubscriptionAccountInfo.js +13 -2
- package/dist/zuora_api/model/PreviewSubscriptionBillToContact.js +12 -1
- package/dist/zuora_api/model/PreviewSubscriptionInvoice.js +12 -1
- package/dist/zuora_api/model/PreviewSubscriptionInvoiceItem.js +12 -1
- package/dist/zuora_api/model/PreviewSubscriptionRequest.js +13 -2
- package/dist/zuora_api/model/PreviewSubscriptionResponse.js +12 -1
- package/dist/zuora_api/model/PreviewThroughDate.js +12 -1
- package/dist/zuora_api/model/PriceChangeParams.js +12 -5
- package/dist/zuora_api/model/PricingUpdate.js +12 -1
- package/dist/zuora_api/model/ProcessingOptions.js +12 -1
- package/dist/zuora_api/model/ProcessingOptionsWithDelayedCapturePayment.js +12 -1
- package/dist/zuora_api/model/Product.js +12 -1
- package/dist/zuora_api/model/ProductFeature.js +12 -1
- package/dist/zuora_api/model/ProductObjectNSFields.js +12 -1
- package/dist/zuora_api/model/ProductRatePlan.js +12 -1
- package/dist/zuora_api/model/ProductRatePlanCharge.js +21 -1
- package/dist/zuora_api/model/ProductRatePlanChargeObjectNSFields.js +12 -1
- package/dist/zuora_api/model/ProductRatePlanChargeTier.js +12 -1
- package/dist/zuora_api/model/ProductRatePlanChargeTierData.js +12 -1
- package/dist/zuora_api/model/ProductRatePlanObjectNSFields.js +12 -1
- package/dist/zuora_api/model/ProductRatePlanWithExternalId.js +12 -1
- package/dist/zuora_api/model/ProrationOption.js +73 -0
- package/dist/zuora_api/model/ProxyActioncreateRequest.js +13 -2
- package/dist/zuora_api/model/ProxyActiondeleteRequest.js +13 -2
- package/dist/zuora_api/model/ProxyActionqueryMoreRequest.js +13 -2
- package/dist/zuora_api/model/ProxyActionqueryMoreRequestConf.js +12 -1
- package/dist/zuora_api/model/ProxyActionqueryMoreResponse.js +12 -1
- package/dist/zuora_api/model/ProxyActionqueryRequest.js +13 -2
- package/dist/zuora_api/model/ProxyActionqueryResponse.js +12 -1
- package/dist/zuora_api/model/ProxyActionupdateRequest.js +13 -2
- package/dist/zuora_api/model/ProxyBadRequestResponse.js +12 -1
- package/dist/zuora_api/model/ProxyBadRequestResponseErrorsInner.js +12 -1
- package/dist/zuora_api/model/ProxyCreateOrModifyResponse.js +12 -1
- package/dist/zuora_api/model/ProxyCreateTaxationItemRequest.js +13 -2
- package/dist/zuora_api/model/ProxyDeleteResponse.js +12 -1
- package/dist/zuora_api/model/ProxyGetImport.js +12 -1
- package/dist/zuora_api/model/ProxyNoDataResponse.js +12 -1
- package/dist/zuora_api/model/ProxyPostImport.js +12 -1
- package/dist/zuora_api/model/ProxyUnauthorizedResponse.js +12 -1
- package/dist/zuora_api/model/PutAttachmentRequest.js +12 -1
- package/dist/zuora_api/model/PutBusinessRegionRequest.js +12 -1
- package/dist/zuora_api/model/PutEventTriggerRequest.js +12 -1
- package/dist/zuora_api/model/PutEventTriggerRequestEventType.js +12 -1
- package/dist/zuora_api/model/PutPublicEmailTemplateRequest.js +12 -5
- package/dist/zuora_api/model/PutPublicNotificationDefinitionRequest.js +12 -1
- package/dist/zuora_api/model/PutPublicNotificationDefinitionRequestCallout.js +13 -2
- package/dist/zuora_api/model/PutPublicNotificationDefinitionRequestFilterRule.js +13 -2
- package/dist/zuora_api/model/PutRevproAccCodeResponse.js +12 -1
- package/dist/zuora_api/model/PutScheduledEventRequest.js +12 -1
- package/dist/zuora_api/model/PutServiceProviderRequest.js +13 -2
- package/dist/zuora_api/model/PutTasksRequest.js +12 -1
- package/dist/zuora_api/model/QuantityForUsageCharges.js +12 -1
- package/dist/zuora_api/model/QueryAccountsResponse.js +23 -12
- package/dist/zuora_api/model/QueryAmendmentsResponse.js +23 -12
- package/dist/zuora_api/model/QueryBillingRunsResponse.js +23 -12
- package/dist/zuora_api/model/QueryContactsResponse.js +23 -12
- package/dist/zuora_api/model/QueryCreditMemoApplicationsResponse.js +23 -12
- package/dist/zuora_api/model/QueryCreditMemoItemsResponse.js +23 -12
- package/dist/zuora_api/model/QueryCreditMemosResponse.js +23 -12
- package/dist/zuora_api/model/QueryCustomObjectRecordsResponse.js +13 -2
- package/dist/zuora_api/model/QueryCustomObjectsResponse.js +23 -12
- package/dist/zuora_api/model/QueryDailyConsumptionSummarysResponse.js +23 -12
- package/dist/zuora_api/model/QueryDebitMemoItemsResponse.js +23 -12
- package/dist/zuora_api/model/QueryDebitMemosResponse.js +23 -12
- package/dist/zuora_api/model/QueryInvoiceItemsResponse.js +23 -12
- package/dist/zuora_api/model/QueryInvoicesResponse.js +23 -12
- package/dist/zuora_api/model/QueryOrderActionsResponse.js +23 -12
- package/dist/zuora_api/model/QueryOrderLineItemsResponse.js +23 -12
- package/dist/zuora_api/model/QueryOrderssResponse.js +23 -12
- package/dist/zuora_api/model/QueryPaymentApplicationsResponse.js +23 -12
- package/dist/zuora_api/model/QueryPaymentMethodSnapshotsResponse.js +23 -12
- package/dist/zuora_api/model/QueryPaymentMethodsResponse.js +23 -12
- package/dist/zuora_api/model/QueryPaymentRunsResponse.js +23 -12
- package/dist/zuora_api/model/QueryPaymentScheduleItemsResponse.js +23 -12
- package/dist/zuora_api/model/QueryPaymentSchedulesResponse.js +23 -12
- package/dist/zuora_api/model/QueryPaymentsResponse.js +23 -12
- package/dist/zuora_api/model/QueryPrepaidBalanceFundsResponse.js +23 -12
- package/dist/zuora_api/model/QueryPrepaidBalanceTransactionsResponse.js +23 -12
- package/dist/zuora_api/model/QueryPrepaidBalancesResponse.js +23 -12
- package/dist/zuora_api/model/QueryProcessedUsagesResponse.js +23 -12
- package/dist/zuora_api/model/QueryProductRatePlanChargeTiersResponse.js +23 -12
- package/dist/zuora_api/model/QueryProductRatePlanChargesResponse.js +23 -12
- package/dist/zuora_api/model/QueryProductRatePlansResponse.js +23 -12
- package/dist/zuora_api/model/QueryProductsResponse.js +23 -12
- package/dist/zuora_api/model/QueryRatePlanChargeTiersResponse.js +23 -12
- package/dist/zuora_api/model/QueryRatePlanChargesResponse.js +23 -12
- package/dist/zuora_api/model/QueryRatePlansResponse.js +23 -12
- package/dist/zuora_api/model/QueryRatingResultsResponse.js +23 -12
- package/dist/zuora_api/model/QueryRefundApplicationItemsResponse.js +23 -12
- package/dist/zuora_api/model/QueryRefundApplicationsResponse.js +23 -12
- package/dist/zuora_api/model/QueryRefundsResponse.js +23 -12
- package/dist/zuora_api/model/QuerySubscriptionsResponse.js +23 -12
- package/dist/zuora_api/model/QueryTaxationItemsResponse.js +23 -12
- package/dist/zuora_api/model/QueryUsagesResponse.js +23 -12
- package/dist/zuora_api/model/QueryValidityPeriodSummarysResponse.js +23 -12
- package/dist/zuora_api/model/QuoteObjectFields.js +12 -1
- package/dist/zuora_api/model/RSASignatureResponse.js +12 -1
- package/dist/zuora_api/model/RampChargeRequest.js +12 -1
- package/dist/zuora_api/model/RampChargeResponse.js +12 -1
- package/dist/zuora_api/model/RampIntervalChargeDeltaMetrics.js +12 -1
- package/dist/zuora_api/model/RampIntervalChargeDeltaMetricsDeltaMrrInner.js +12 -1
- package/dist/zuora_api/model/RampIntervalChargeDeltaMetricsDeltaQuantityInner.js +12 -1
- package/dist/zuora_api/model/RampIntervalChargeMetrics.js +12 -1
- package/dist/zuora_api/model/RampIntervalChargeMetricsMrrInner.js +12 -1
- package/dist/zuora_api/model/RampIntervalMetrics.js +12 -1
- package/dist/zuora_api/model/RampIntervalRequest.js +13 -2
- package/dist/zuora_api/model/RampIntervalResponse.js +12 -1
- package/dist/zuora_api/model/RampMetrics.js +12 -1
- package/dist/zuora_api/model/RampResponse.js +12 -1
- package/dist/zuora_api/model/RatePlan.js +12 -1
- package/dist/zuora_api/model/RatePlanChangeLog.js +167 -0
- package/dist/zuora_api/model/RatePlanChargeChangeLog.js +175 -0
- package/dist/zuora_api/model/RatePlanChargeObjectCustomFields.js +12 -1
- package/dist/zuora_api/model/RatePlanChargeOverridePricing.js +12 -1
- package/dist/zuora_api/model/RatePlanChargeSegment.js +72 -1
- package/dist/zuora_api/model/RatePlanChargeSegmentInfo.js +56 -1
- package/dist/zuora_api/model/RatePlanChargeTier.js +12 -1
- package/dist/zuora_api/model/RatePlanFeatureOverride.js +12 -1
- package/dist/zuora_api/model/RatePlanObjectCustomFields.js +12 -1
- package/dist/zuora_api/model/RatePlanOverride.js +14 -3
- package/dist/zuora_api/model/RatePlanUpdate.js +12 -1
- package/dist/zuora_api/model/RatingGroupsOperatorType.js +58 -0
- package/dist/zuora_api/model/RatingPropertiesOverride.js +124 -0
- package/dist/zuora_api/model/ReconcileRefundRequest.js +12 -1
- package/dist/zuora_api/model/RecurringDeliveryPricingOverride.js +12 -5
- package/dist/zuora_api/model/RecurringDeliveryPricingUpdate.js +12 -5
- package/dist/zuora_api/model/RecurringFlatFeePricingOverride.js +12 -5
- package/dist/zuora_api/model/RecurringFlatFeePricingUpdate.js +12 -5
- package/dist/zuora_api/model/RecurringPerUnitPricingOverride.js +12 -5
- package/dist/zuora_api/model/RecurringPerUnitPricingUpdate.js +12 -5
- package/dist/zuora_api/model/RecurringTieredPricingOverride.js +12 -5
- package/dist/zuora_api/model/RecurringTieredPricingUpdate.js +12 -5
- package/dist/zuora_api/model/RecurringVolumePricingOverride.js +12 -5
- package/dist/zuora_api/model/RecurringVolumePricingUpdate.js +12 -5
- package/dist/zuora_api/model/Refund.js +12 -1
- package/dist/zuora_api/model/RefundCreditMemoItemRequest.js +13 -2
- package/dist/zuora_api/model/RefundCreditMemoRequest.js +13 -2
- package/dist/zuora_api/model/RefundCreditMemoResponse.js +12 -1
- package/dist/zuora_api/model/RefundEntityPrefix.js +12 -1
- package/dist/zuora_api/model/RefundItemPart.js +12 -1
- package/dist/zuora_api/model/RefundObjectCustomFields.js +12 -1
- package/dist/zuora_api/model/RefundObjectNSFields.js +12 -1
- package/dist/zuora_api/model/RefundPart.js +12 -1
- package/dist/zuora_api/model/RefundRequestFinanceInformation.js +12 -1
- package/dist/zuora_api/model/RefundResponse.js +12 -1
- package/dist/zuora_api/model/RegenerateBillingRequest.js +12 -1
- package/dist/zuora_api/model/RegenerateBookingRequest.js +12 -1
- package/dist/zuora_api/model/RegenerateRevRecEventsResponse.js +12 -1
- package/dist/zuora_api/model/RegenerateTransactionObjectResponse.js +12 -1
- package/dist/zuora_api/model/RejectPaymentRequest.js +12 -1
- package/dist/zuora_api/model/RemoveCatalogGroupProductRatePlan.js +12 -1
- package/dist/zuora_api/model/RemoveSubscriptionRatePlan.js +13 -2
- package/dist/zuora_api/model/RenewSubscriptionRequest.js +12 -1
- package/dist/zuora_api/model/RenewSubscriptionResponse.js +12 -1
- package/dist/zuora_api/model/RenewalTerm.js +12 -1
- package/dist/zuora_api/model/ResendCalloutNotificationsFailedResponse.js +12 -1
- package/dist/zuora_api/model/ResendCalloutNotificationsFailedResponseValue.js +12 -1
- package/dist/zuora_api/model/ResendEmailNotificationsFailedResponse.js +12 -1
- package/dist/zuora_api/model/ResendEmailNotificationsFailedResponseValue.js +12 -1
- package/dist/zuora_api/model/ResumeSubscriptionRequest.js +13 -2
- package/dist/zuora_api/model/ResumeSubscriptionResponse.js +12 -1
- package/dist/zuora_api/model/RetryPaymentScheduleItem.js +12 -1
- package/dist/zuora_api/model/RetryPaymentScheduleItemRequest.js +12 -1
- package/dist/zuora_api/model/RetryPaymentScheduleItemResponse.js +12 -1
- package/dist/zuora_api/model/ReverseCreditMemoRequest.js +38 -1
- package/dist/zuora_api/model/ReverseCreditMemoResponse.js +12 -1
- package/dist/zuora_api/model/ReverseCreditMemoResponseCreditMemo.js +12 -1
- package/dist/zuora_api/model/ReverseCreditMemoResponseDebitMemo.js +12 -1
- package/dist/zuora_api/model/ReverseInvoiceRequest.js +38 -1
- package/dist/zuora_api/model/ReverseInvoiceResponse.js +12 -1
- package/dist/zuora_api/model/ReverseInvoiceResponseCreditMemo.js +12 -1
- package/dist/zuora_api/model/ReverseInvoiceResponseDebitMemo.js +12 -1
- package/dist/zuora_api/model/ReversePaymentRequest.js +13 -2
- package/dist/zuora_api/model/RevertOrderRequest.js +120 -0
- package/dist/zuora_api/model/RevertOrderResponse.js +246 -0
- package/dist/zuora_api/model/RevproAccountingCodes.js +13 -2
- package/dist/zuora_api/model/SaveResult.js +12 -1
- package/dist/zuora_api/model/ServiceProvider.js +12 -1
- package/dist/zuora_api/model/ServiceProviderResponse.js +12 -1
- package/dist/zuora_api/model/SettingComponentKeyValue.js +12 -1
- package/dist/zuora_api/model/SettingItemHttpOperation.js +12 -1
- package/dist/zuora_api/model/SettingItemHttpRequestParameter.js +12 -1
- package/dist/zuora_api/model/SettingItemWithOperationsInformation.js +12 -1
- package/dist/zuora_api/model/SettingSourceComponentResponse.js +12 -1
- package/dist/zuora_api/model/SettingValueRequest.js +12 -1
- package/dist/zuora_api/model/SettingValueResponse.js +12 -1
- package/dist/zuora_api/model/SettingValueResponseWrapper.js +12 -1
- package/dist/zuora_api/model/SettingsBatchRequest.js +12 -1
- package/dist/zuora_api/model/SettingsBatchResponse.js +12 -1
- package/dist/zuora_api/model/SettlePaymentRequest.js +12 -1
- package/dist/zuora_api/model/SignUpCreatePMPayPalECPayPalNativeEC.js +12 -1
- package/dist/zuora_api/model/SignUpCreatePaymentMethodCardholderInfo.js +13 -2
- package/dist/zuora_api/model/SignUpCreatePaymentMethodCommon.js +12 -1
- package/dist/zuora_api/model/SignUpCreatePaymentMethodCreditCard.js +12 -1
- package/dist/zuora_api/model/SignUpCreatePaymentMethodCreditCardReferenceTransaction.js +12 -1
- package/dist/zuora_api/model/SignUpCreatePaymentMethodPayPalAdaptive.js +12 -1
- package/dist/zuora_api/model/SignUpPaymentMethod.js +13 -2
- package/dist/zuora_api/model/SignUpPaymentMethodObjectCustomFields.js +12 -1
- package/dist/zuora_api/model/SignUpRequest.js +12 -1
- package/dist/zuora_api/model/SignUpResponse.js +12 -1
- package/dist/zuora_api/model/SignUpResponseReasons.js +12 -1
- package/dist/zuora_api/model/SignUpTaxInfo.js +12 -5
- package/dist/zuora_api/model/StoredCredentialProfileResponse.js +12 -1
- package/dist/zuora_api/model/StoredCredentialProfilesResponse.js +12 -1
- package/dist/zuora_api/model/SubmitDataQueryRequest.js +13 -2
- package/dist/zuora_api/model/SubmitDataQueryRequestOutput.js +13 -2
- package/dist/zuora_api/model/SubmitDataQueryResponse.js +12 -1
- package/dist/zuora_api/model/SubscribeToProduct.js +15 -4
- package/dist/zuora_api/model/SubscriptionChangeLog.js +323 -0
- package/dist/zuora_api/model/SubscriptionCreditMemo.js +12 -1
- package/dist/zuora_api/model/SubscriptionCreditMemoItem.js +12 -1
- package/dist/zuora_api/model/SubscriptionData.js +12 -1
- package/dist/zuora_api/model/SubscriptionMetrics.js +30 -1
- package/dist/zuora_api/model/SubscriptionObjectNSFields.js +12 -1
- package/dist/zuora_api/model/SubscriptionObjectQTFields.js +12 -1
- package/dist/zuora_api/model/SubscriptionProductFeature.js +12 -1
- package/dist/zuora_api/model/SubscriptionRatePlan.js +12 -1
- package/dist/zuora_api/model/SubscriptionStatusHistory.js +12 -1
- package/dist/zuora_api/model/SubscriptionTaxationItem.js +12 -1
- package/dist/zuora_api/model/SuspendSubscriptionRequest.js +13 -2
- package/dist/zuora_api/model/SuspendSubscriptionResponse.js +12 -1
- package/dist/zuora_api/model/SystemHealthErrorResponse.js +12 -1
- package/dist/zuora_api/model/Task.js +13 -2
- package/dist/zuora_api/model/TasksResponse.js +12 -1
- package/dist/zuora_api/model/TasksResponsePagination.js +12 -1
- package/dist/zuora_api/model/TaxInfo.js +12 -5
- package/dist/zuora_api/model/TaxItemsFinanceInformation.js +12 -1
- package/dist/zuora_api/model/TaxationItem.js +12 -1
- package/dist/zuora_api/model/TaxationItemFinanceInformation.js +12 -1
- package/dist/zuora_api/model/TaxationItemsData.js +12 -1
- package/dist/zuora_api/model/TaxationItemsDataResponse.js +12 -1
- package/dist/zuora_api/model/TemplateDetailResponse.js +12 -1
- package/dist/zuora_api/model/TemplateMigrationClientRequest.js +13 -2
- package/dist/zuora_api/model/TemplateResponse.js +12 -1
- package/dist/zuora_api/model/TermInfo.js +13 -2
- package/dist/zuora_api/model/Tier.js +13 -2
- package/dist/zuora_api/model/TimeSlicedElpNetMetrics.js +12 -1
- package/dist/zuora_api/model/TimeSlicedMetrics.js +12 -1
- package/dist/zuora_api/model/TimeSlicedNetMetrics.js +12 -1
- package/dist/zuora_api/model/TimeSlicedTcbNetMetrics.js +12 -1
- package/dist/zuora_api/model/TokenResponse.js +12 -1
- package/dist/zuora_api/model/TransferPayment.js +12 -1
- package/dist/zuora_api/model/TriggerDate.js +12 -1
- package/dist/zuora_api/model/TriggerParams.js +12 -1
- package/dist/zuora_api/model/UnapplyCreditMemoItemToDebitMemoItem.js +13 -2
- package/dist/zuora_api/model/UnapplyCreditMemoItemToInvoiceItem.js +13 -2
- package/dist/zuora_api/model/UnapplyCreditMemoRequest.js +12 -1
- package/dist/zuora_api/model/UnapplyCreditMemoToDebitMemo.js +13 -2
- package/dist/zuora_api/model/UnapplyCreditMemoToInvoice.js +13 -2
- package/dist/zuora_api/model/UnapplyPaymentDebitMemoApplication.js +13 -2
- package/dist/zuora_api/model/UnapplyPaymentDebitMemoApplicationItem.js +13 -2
- package/dist/zuora_api/model/UnapplyPaymentInvoiceApplication.js +13 -2
- package/dist/zuora_api/model/UnapplyPaymentInvoiceApplicationItem.js +13 -2
- package/dist/zuora_api/model/UnapplyPaymentRequest.js +12 -1
- package/dist/zuora_api/model/UpdateAccountContact.js +14 -3
- package/dist/zuora_api/model/UpdateAccountRequest.js +59 -1
- package/dist/zuora_api/model/UpdateAccountingCodeRequest.js +12 -1
- package/dist/zuora_api/model/UpdateAccountingPeriodRequest.js +12 -1
- package/dist/zuora_api/model/UpdateBasicSummaryJournalEntryRequest.js +12 -1
- package/dist/zuora_api/model/UpdateCatalogGroupRequest.js +12 -1
- package/dist/zuora_api/model/UpdateContactRequest.js +39 -1
- package/dist/zuora_api/model/UpdateCreditMemoItem.js +35 -2
- package/dist/zuora_api/model/UpdateCreditMemoRequest.js +12 -1
- package/dist/zuora_api/model/UpdateCreditMemoTaxItemFinanceInformation.js +12 -1
- package/dist/zuora_api/model/UpdateCreditMemoTaxItemRequest.js +13 -2
- package/dist/zuora_api/model/UpdateCreditMemoWithId.js +12 -1
- package/dist/zuora_api/model/UpdateCustomObjectCusotmField.js +12 -1
- package/dist/zuora_api/model/UpdateDebitMemoItem.js +35 -2
- package/dist/zuora_api/model/UpdateDebitMemoRequest.js +12 -1
- package/dist/zuora_api/model/UpdateDebitMemoTaxItemFinanceInformation.js +12 -1
- package/dist/zuora_api/model/UpdateDebitMemoTaxItemRequest.js +13 -2
- package/dist/zuora_api/model/UpdateDebitMemoWithId.js +12 -1
- package/dist/zuora_api/model/UpdateDebitMemosDueDatesRequest.js +12 -1
- package/dist/zuora_api/model/UpdateDiscountInvoiceItem.js +53 -2
- package/dist/zuora_api/model/UpdateFulfillmentItemRequest.js +12 -1
- package/dist/zuora_api/model/UpdateFulfillmentRequest.js +13 -2
- package/dist/zuora_api/model/UpdateInvoiceItem.js +61 -1
- package/dist/zuora_api/model/UpdateInvoiceRequest.js +12 -1
- package/dist/zuora_api/model/UpdateInvoiceResponse.js +12 -1
- package/dist/zuora_api/model/UpdateInvoiceScheduleItem.js +12 -1
- package/dist/zuora_api/model/UpdateInvoiceScheduleRequest.js +12 -1
- package/dist/zuora_api/model/UpdateJournalEntryItemRequest.js +13 -2
- package/dist/zuora_api/model/UpdateOpenPaymentMethodTypeRequest.js +13 -2
- package/dist/zuora_api/model/UpdateOrderAction.js +12 -1
- package/dist/zuora_api/model/UpdateOrderActionChargeTriggerDate.js +12 -1
- package/dist/zuora_api/model/UpdateOrderActionRequest.js +12 -1
- package/dist/zuora_api/model/UpdateOrderActionTriggerDate.js +12 -1
- package/dist/zuora_api/model/UpdateOrderActionTriggerDates.js +13 -2
- package/dist/zuora_api/model/UpdateOrderActionTriggerDatesRequest.js +13 -2
- package/dist/zuora_api/model/UpdateOrderCustomFieldsRequest.js +12 -1
- package/dist/zuora_api/model/UpdateOrderLineItem.js +54 -24
- package/dist/zuora_api/model/UpdateOrderLineItemRequest.js +72 -27
- package/dist/zuora_api/model/UpdateOrderRequest.js +13 -6
- package/dist/zuora_api/model/UpdateOrderSubscriptionsCustomFields.js +12 -1
- package/dist/zuora_api/model/UpdateOrderSubscriptionsOrderActionsCustomFields.js +12 -1
- package/dist/zuora_api/model/UpdateOrderTriggerDateResponse.js +12 -1
- package/dist/zuora_api/model/UpdateOrderTriggerDatesRequest.js +12 -1
- package/dist/zuora_api/model/UpdateOrderTriggerDatesResponse.js +12 -1
- package/dist/zuora_api/model/UpdatePaymentMethodRequest.js +12 -1
- package/dist/zuora_api/model/UpdatePaymentMethodRequestCreditCardInfo.js +12 -1
- package/dist/zuora_api/model/UpdatePaymentMethodResponse.js +12 -1
- package/dist/zuora_api/model/UpdatePaymentRequest.js +12 -1
- package/dist/zuora_api/model/UpdatePaymentRunRequest.js +12 -1
- package/dist/zuora_api/model/UpdatePaymentScheduleItemRequest.js +12 -1
- package/dist/zuora_api/model/UpdatePaymentScheduleRequest.js +12 -1
- package/dist/zuora_api/model/UpdateProductRatePlanChargeRequest.js +13 -2
- package/dist/zuora_api/model/UpdateProductRatePlanChargeTierRequest.js +12 -1
- package/dist/zuora_api/model/UpdateProductRatePlanRequest.js +12 -1
- package/dist/zuora_api/model/UpdateProductRequest.js +12 -1
- package/dist/zuora_api/model/UpdateRatePlanCharge.js +13 -2
- package/dist/zuora_api/model/UpdateRefundRequest.js +12 -1
- package/dist/zuora_api/model/UpdateSequenceSetRequest.js +12 -1
- package/dist/zuora_api/model/UpdateSequenceSetResponse.js +12 -1
- package/dist/zuora_api/model/UpdateSubscriptionChargeCustomFields.js +12 -1
- package/dist/zuora_api/model/UpdateSubscriptionChargeCustomFieldsOfASpecifiedVersion.js +12 -1
- package/dist/zuora_api/model/UpdateSubscriptionCustomFieldsOfASpecifiedVersionRequest.js +12 -1
- package/dist/zuora_api/model/UpdateSubscriptionCustomFieldsRequest.js +12 -1
- package/dist/zuora_api/model/UpdateSubscriptionRatePlan.js +13 -2
- package/dist/zuora_api/model/UpdateSubscriptionRatePlanCustomFields.js +12 -1
- package/dist/zuora_api/model/UpdateSubscriptionRatePlanCustomFieldsOfASpecifiedVersion.js +13 -2
- package/dist/zuora_api/model/UpdateSubscriptionRequest.js +12 -1
- package/dist/zuora_api/model/UpdateSubscriptionResponse.js +12 -1
- package/dist/zuora_api/model/UpdateTask.js +13 -2
- package/dist/zuora_api/model/UpdateTaxationItemForFinanceInformation.js +12 -1
- package/dist/zuora_api/model/UpdateTaxationItemRequest.js +12 -1
- package/dist/zuora_api/model/UpdateUsageRequest.js +12 -1
- package/dist/zuora_api/model/UpdaterPaymentMethodRequestAccountHolderInfo.js +12 -1
- package/dist/zuora_api/model/UploadFileForCreditMemoRequest.js +12 -1
- package/dist/zuora_api/model/UploadFileForDebitMemoRequest.js +12 -1
- package/dist/zuora_api/model/UploadFileForInvoiceRequest.js +12 -1
- package/dist/zuora_api/model/UploadFileResponse.js +12 -1
- package/dist/zuora_api/model/UploadUsageFileRequest.js +13 -2
- package/dist/zuora_api/model/UploadUsageFileResponse.js +12 -1
- package/dist/zuora_api/model/Usage.js +12 -1
- package/dist/zuora_api/model/UsageFlatFeePricingOverride.js +12 -5
- package/dist/zuora_api/model/UsageFlatFeePricingUpdate.js +12 -5
- package/dist/zuora_api/model/UsageItem.js +25 -1
- package/dist/zuora_api/model/UsageOveragePricingOverride.js +12 -5
- package/dist/zuora_api/model/UsageOveragePricingUpdate.js +12 -5
- package/dist/zuora_api/model/UsagePerUnitPricingOverride.js +12 -5
- package/dist/zuora_api/model/UsagePerUnitPricingUpdate.js +12 -5
- package/dist/zuora_api/model/UsageTieredPricingOverride.js +12 -5
- package/dist/zuora_api/model/UsageTieredPricingUpdate.js +12 -5
- package/dist/zuora_api/model/UsageTieredWithOveragePricingOverride.js +12 -5
- package/dist/zuora_api/model/UsageTieredWithOveragePricingUpdate.js +12 -5
- package/dist/zuora_api/model/UsageValues.js +12 -1
- package/dist/zuora_api/model/UsageVolumePricingOverride.js +12 -5
- package/dist/zuora_api/model/UsageVolumePricingUpdate.js +12 -5
- package/dist/zuora_api/model/UsagesResponse.js +12 -1
- package/dist/zuora_api/model/ValidationErrors.js +12 -1
- package/dist/zuora_api/model/ValidationReasons.js +12 -1
- package/dist/zuora_api/model/VerifyPaymentMethodRequest.js +12 -1
- package/dist/zuora_api/model/VerifyPaymentMethodResponse.js +12 -1
- package/dist/zuora_api/model/Workflow.js +12 -1
- package/dist/zuora_api/model/WorkflowDefinition.js +12 -1
- package/dist/zuora_api/model/WorkflowDefinitionActiveVersion.js +12 -1
- package/dist/zuora_api/model/WorkflowDefinitionAndVersions.js +12 -1
- package/dist/zuora_api/model/WorkflowError.js +12 -1
- package/dist/zuora_api/model/WorkflowInstance.js +12 -1
- package/dist/zuora_api/model/WriteOffBehavior.js +12 -1
- package/dist/zuora_api/model/WriteOffBehaviorFinanceInformation.js +12 -1
- package/dist/zuora_api/model/WriteOffCreditMemoRequest.js +12 -1
- package/dist/zuora_api/model/WriteOffCreditMemoResponse.js +12 -1
- package/dist/zuora_api/model/WriteOffCreditMemoResponseDebitMemo.js +12 -1
- package/dist/zuora_api/model/WriteOffDebitMemoRequest.js +306 -0
- package/dist/zuora_api/model/WriteOffDebitMemoResponse.js +195 -0
- package/dist/zuora_api/model/WriteOffInvoiceRequest.js +63 -1
- package/dist/zuora_api/model/WriteOffInvoiceResponse.js +12 -1
- package/dist/zuora_api/model/WriteOffInvoiceResponseCreditMemo.js +12 -1
- package/dist/zuora_api/model/ZObject.js +12 -1
- package/dist/zuora_api/model/ZObjectUpdate.js +13 -2
- package/package.json +1 -1
- package/src/ZuoraClient.js +20 -32
- package/src/zuora_api/ApiClient.js +19 -2
- package/src/zuora_api/api/APIHealthApi.js +1 -1
- package/src/zuora_api/api/AccountingCodesApi.js +1 -1
- package/src/zuora_api/api/AccountingPeriodsApi.js +1 -1
- package/src/zuora_api/api/AccountsApi.js +1 -1
- package/src/zuora_api/api/ActionsApi.js +1 -1
- package/src/zuora_api/api/AdjustmentsApi.js +1 -1
- package/src/zuora_api/api/AggregateQueriesApi.js +1 -1
- package/src/zuora_api/api/AttachmentsApi.js +1 -1
- package/src/zuora_api/api/BillRunApi.js +1 -1
- package/src/zuora_api/api/BillRunHealthApi.js +1 -1
- package/src/zuora_api/api/BillingDocumentsApi.js +1 -1
- package/src/zuora_api/api/BillingPreviewRunApi.js +1 -1
- package/src/zuora_api/api/BookingDateBackfillJobApi.js +1 -1
- package/src/zuora_api/api/CatalogGroupsApi.js +1 -1
- package/src/zuora_api/api/ConfigurationTemplatesApi.js +1 -1
- package/src/zuora_api/api/ContactSnapshotsApi.js +1 -1
- package/src/zuora_api/api/ContactsApi.js +1 -1
- package/src/zuora_api/api/CreditMemosApi.js +1 -1
- package/src/zuora_api/api/CustomEventTriggersApi.js +1 -1
- package/src/zuora_api/api/CustomExchangeRatesApi.js +1 -1
- package/src/zuora_api/api/CustomObjectDefinitionsApi.js +1 -1
- package/src/zuora_api/api/CustomObjectJobsApi.js +1 -1
- package/src/zuora_api/api/CustomObjectRecordsApi.js +1 -1
- package/src/zuora_api/api/CustomPaymentMethodTypesApi.js +1 -1
- package/src/zuora_api/api/CustomScheduledEventsApi.js +1 -1
- package/src/zuora_api/api/DataBackfillJobApi.js +1 -1
- package/src/zuora_api/api/DataQueriesApi.js +1 -1
- package/src/zuora_api/api/DebitMemosApi.js +81 -1
- package/src/zuora_api/api/DescribeApi.js +1 -1
- package/src/zuora_api/api/EInvoicingApi.js +1 -1
- package/src/zuora_api/api/ElectronicPaymentsHealthApi.js +1 -1
- package/src/zuora_api/api/FilesApi.js +2 -2
- package/src/zuora_api/api/FulfillmentsApi.js +1 -1
- package/src/zuora_api/api/HostedPagesApi.js +1 -1
- package/src/zuora_api/api/ImportsApi.js +1 -1
- package/src/zuora_api/api/InvoiceSchedulesApi.js +1 -1
- package/src/zuora_api/api/InvoicesApi.js +1 -1
- package/src/zuora_api/api/JournalRunsApi.js +1 -1
- package/src/zuora_api/api/MassUpdaterApi.js +1 -1
- package/src/zuora_api/api/NotificationsApi.js +1 -1
- package/src/zuora_api/api/OAuthApi.js +1 -1
- package/src/zuora_api/api/ObjectQueriesApi.js +89 -341
- package/src/zuora_api/api/OperationsApi.js +1 -1
- package/src/zuora_api/api/OrderActionsApi.js +1 -1
- package/src/zuora_api/api/OrderLineItemsApi.js +1 -1
- package/src/zuora_api/api/OrdersApi.js +81 -1
- package/src/zuora_api/api/PaymentAuthorizationApi.js +1 -1
- package/src/zuora_api/api/PaymentGatewayReconciliationApi.js +1 -1
- package/src/zuora_api/api/PaymentGatewaysApi.js +1 -1
- package/src/zuora_api/api/PaymentMethodSnapshotsApi.js +1 -1
- package/src/zuora_api/api/PaymentMethodTransactionLogsApi.js +1 -1
- package/src/zuora_api/api/PaymentMethodUpdaterApi.js +1 -1
- package/src/zuora_api/api/PaymentMethodsApi.js +1 -1
- package/src/zuora_api/api/PaymentRunsApi.js +1 -1
- package/src/zuora_api/api/PaymentSchedulesApi.js +1 -1
- package/src/zuora_api/api/PaymentTransactionLogsApi.js +1 -1
- package/src/zuora_api/api/PaymentsApi.js +1 -1
- package/src/zuora_api/api/ProductRatePlanChargeTiersApi.js +1 -1
- package/src/zuora_api/api/ProductRatePlanChargesApi.js +1 -1
- package/src/zuora_api/api/ProductRatePlansApi.js +1 -1
- package/src/zuora_api/api/ProductsApi.js +1 -1
- package/src/zuora_api/api/RSASignaturesApi.js +1 -1
- package/src/zuora_api/api/RampsApi.js +1 -1
- package/src/zuora_api/api/RatePlansApi.js +1 -1
- package/src/zuora_api/api/RefundsApi.js +1 -1
- package/src/zuora_api/api/RegenerateApi.js +1 -1
- package/src/zuora_api/api/{ZuoraRevenueIntegrationApi.js → RevenueAccountingCodesApi.js} +6 -6
- package/src/zuora_api/api/RevenueIntegrationApi.js +826 -0
- package/src/zuora_api/api/SequenceSetsApi.js +1 -1
- package/src/zuora_api/api/SettingsApi.js +1 -1
- package/src/zuora_api/api/SignUpApi.js +1 -1
- package/src/zuora_api/api/SubscriptionChangeLogsApi.js +265 -0
- package/src/zuora_api/api/SubscriptionsApi.js +1 -1
- package/src/zuora_api/api/SummaryJournalEntriesApi.js +1 -1
- package/src/zuora_api/api/TaxationItemsApi.js +1 -1
- package/src/zuora_api/api/UsageApi.js +1 -1
- package/src/zuora_api/api/WorkflowsApi.js +1 -1
- package/src/zuora_api/index.js +171 -45
- package/src/zuora_api/model/AccountBasicInfo.js +11 -1
- package/src/zuora_api/model/AccountBillingAndPayment.js +11 -1
- package/src/zuora_api/model/AccountCreditCardHolder.js +11 -1
- package/src/zuora_api/model/AccountData.js +24 -2
- package/src/zuora_api/model/AccountDetailResponse.js +23 -1
- package/src/zuora_api/model/AccountEInvoiceProfile.js +15 -1
- package/src/zuora_api/model/AccountMetrics.js +11 -1
- package/src/zuora_api/model/AccountObjectNSFields.js +11 -1
- package/src/zuora_api/model/AccountPMMandateInfo.js +11 -1
- package/src/zuora_api/model/AccountSummaryBasicInfo.js +11 -1
- package/src/zuora_api/model/AccountSummaryDefaultPaymentMethod.js +11 -1
- package/src/zuora_api/model/AccountSummaryInvoice.js +11 -1
- package/src/zuora_api/model/AccountSummaryPayment.js +11 -1
- package/src/zuora_api/model/AccountSummaryPaymentInvoice.js +11 -1
- package/src/zuora_api/model/AccountSummaryRatePlan.js +11 -1
- package/src/zuora_api/model/AccountSummaryResponse.js +23 -1
- package/src/zuora_api/model/AccountSummarySubscription.js +11 -1
- package/src/zuora_api/model/AccountSummaryUsage.js +11 -1
- package/src/zuora_api/model/AccountingCodeItemResponse.js +11 -1
- package/src/zuora_api/model/ActionsErrorResponse.js +11 -1
- package/src/zuora_api/model/AddSubscriptionComponent.js +12 -2
- package/src/zuora_api/model/AddSubscriptionRatePlan.js +12 -2
- package/src/zuora_api/model/ApiVolumeSummaryRecord.js +11 -1
- package/src/zuora_api/model/ApplyCreditMemoItemToDebitMemoItem.js +12 -2
- package/src/zuora_api/model/ApplyCreditMemoItemToInvoiceItem.js +12 -2
- package/src/zuora_api/model/ApplyCreditMemoRequest.js +11 -1
- package/src/zuora_api/model/ApplyCreditMemoToDebitMemo.js +12 -2
- package/src/zuora_api/model/ApplyCreditMemoToInvoice.js +12 -2
- package/src/zuora_api/model/ApplyPaymentDebitMemoApplication.js +12 -2
- package/src/zuora_api/model/ApplyPaymentDebitMemoApplicationItem.js +12 -2
- package/src/zuora_api/model/ApplyPaymentInvoiceApplication.js +12 -2
- package/src/zuora_api/model/ApplyPaymentInvoiceApplicationItem.js +12 -2
- package/src/zuora_api/model/ApplyPaymentRequest.js +11 -1
- package/src/zuora_api/model/AsyncOperationResponse.js +11 -1
- package/src/zuora_api/model/AsyncOrderJobResult.js +11 -1
- package/src/zuora_api/model/AsyncOrderProcessingOptions.js +11 -1
- package/src/zuora_api/model/AsyncOrderResultSubscriptions.js +11 -1
- package/src/zuora_api/model/BadRequestErrors.js +11 -1
- package/src/zuora_api/model/BadRequestResponse.js +11 -1
- package/src/zuora_api/model/BillRun.js +11 -1
- package/src/zuora_api/model/BillRunFilter.js +11 -1
- package/src/zuora_api/model/BillRunResponse.js +11 -1
- package/src/zuora_api/model/BillRunSchedule.js +11 -1
- package/src/zuora_api/model/BillingAdjustment.js +11 -1
- package/src/zuora_api/model/BillingAdjustmentExclusion.js +11 -1
- package/src/zuora_api/model/BillingDocVolumeSummaryRecord.js +11 -1
- package/src/zuora_api/model/BillingDocumentItemProcessingType.js +7 -0
- package/src/zuora_api/model/BillingDocumentItemSourceType.js +14 -0
- package/src/zuora_api/model/BillingDocumentQueryResponseElement.js +11 -1
- package/src/zuora_api/model/BillingOptions.js +11 -1
- package/src/zuora_api/model/BillingUpdate.js +11 -1
- package/src/zuora_api/model/BookingDateJob.js +11 -1
- package/src/zuora_api/model/BulkCreateCreditMemosFromChargeRequest.js +12 -2
- package/src/zuora_api/model/BulkCreateCreditMemosFromInvoiceRequest.js +12 -2
- package/src/zuora_api/model/BulkCreateCreditMemosRequest.js +1 -1
- package/src/zuora_api/model/BulkCreateDebitMemosFromChargeRequest.js +12 -2
- package/src/zuora_api/model/BulkCreateDebitMemosFromInvoiceRequest.js +12 -2
- package/src/zuora_api/model/BulkCreateDebitMemosRequest.js +1 -1
- package/src/zuora_api/model/BulkCreateInvoicesRequest.js +11 -1
- package/src/zuora_api/model/BulkCreateInvoicesResponse.js +11 -1
- package/src/zuora_api/model/BulkCreditMemosResponse.js +11 -1
- package/src/zuora_api/model/BulkDebitMemosResponse.js +11 -1
- package/src/zuora_api/model/BulkPDFGenerationJobStatus.js +7 -0
- package/src/zuora_api/model/BulkPdfGenerationJobRequest.js +12 -2
- package/src/zuora_api/model/BulkPdfGenerationJobResponse.js +11 -1
- package/src/zuora_api/model/BulkPostInvoicesRequest.js +11 -1
- package/src/zuora_api/model/BulkPostInvoicesResponse.js +11 -1
- package/src/zuora_api/model/BulkUpdateCreditMemosRequest.js +11 -1
- package/src/zuora_api/model/BulkUpdateDebitMemosRequest.js +11 -1
- package/src/zuora_api/model/BulkUpdateInvoicesRequest.js +11 -1
- package/src/zuora_api/model/BulkUpdateOrderLineItem.js +72 -28
- package/src/zuora_api/model/BulkUpdateOrderLineItemsRequest.js +11 -1
- package/src/zuora_api/model/BusinessRegion.js +11 -1
- package/src/zuora_api/model/BusinessRegionsResponse.js +11 -1
- package/src/zuora_api/model/CalloutAuth.js +11 -1
- package/src/zuora_api/model/CancelAuthorizationRequest.js +12 -2
- package/src/zuora_api/model/CancelAuthorizationResponse.js +11 -1
- package/src/zuora_api/model/CancelBillRunRequest.js +11 -1
- package/src/zuora_api/model/CancelBillRunResponse.js +11 -1
- package/src/zuora_api/model/CancelBillingAdjustmentRequest.js +11 -1
- package/src/zuora_api/model/CancelBillingAdjustmentResponse.js +11 -1
- package/src/zuora_api/model/CancelOrderRequest.js +11 -1
- package/src/zuora_api/model/CancelOrderResponse.js +11 -1
- package/src/zuora_api/model/CancelPaymentSchedule.js +12 -2
- package/src/zuora_api/model/CancelSubscriptionRequest.js +12 -2
- package/src/zuora_api/model/CancelSubscriptionResponse.js +11 -1
- package/src/zuora_api/model/CatalogGroup.js +11 -5
- package/src/zuora_api/model/CatalogGroupProductRatePlan.js +11 -1
- package/src/zuora_api/model/ChangeLogField.js +125 -0
- package/src/zuora_api/model/ChangePlanRatePlanOverride.js +11 -1
- package/src/zuora_api/model/ChangeSubscriptionRatePlan.js +11 -1
- package/src/zuora_api/model/ChargeMetrics.js +11 -1
- package/src/zuora_api/model/ChargeModelConfiguration.js +11 -1
- package/src/zuora_api/model/ChargeModelConfigurationForSubscription.js +11 -1
- package/src/zuora_api/model/ChargeModelConfigurationItem.js +12 -2
- package/src/zuora_api/model/ChargeModelDataOverride.js +11 -1
- package/src/zuora_api/model/ChargeOverride.js +44 -4
- package/src/zuora_api/model/ChargeOverrideBilling.js +11 -1
- package/src/zuora_api/model/ChargeOverridePricing.js +11 -1
- package/src/zuora_api/model/ChargeProrationRuleDaysInMonth.js +53 -0
- package/src/zuora_api/model/ChargeProrationRuleProrationUnit.js +46 -0
- package/src/zuora_api/model/ChargeTier.js +12 -2
- package/src/zuora_api/model/ChargeUpdate.js +11 -1
- package/src/zuora_api/model/ChildrenSettingValueRequest.js +11 -1
- package/src/zuora_api/model/CollectDebitMemoRequest.js +11 -1
- package/src/zuora_api/model/CollectDebitMemoRequestPayment.js +11 -1
- package/src/zuora_api/model/CollectDebitMemoResponse.js +11 -1
- package/src/zuora_api/model/CollectDebitMemoResponseAppliedCreditMemos.js +11 -1
- package/src/zuora_api/model/CollectDebitMemoResponseAppliedPayments.js +11 -1
- package/src/zuora_api/model/CollectDebitMemoResponseDebitMemo.js +11 -1
- package/src/zuora_api/model/CollectDebitMemoResponseProcessedPayment.js +11 -1
- package/src/zuora_api/model/CommonErrorResponse.js +11 -1
- package/src/zuora_api/model/CommonResponse.js +11 -1
- package/src/zuora_api/model/CompareSchemaInfoResponse.js +11 -1
- package/src/zuora_api/model/CompareSchemaKeyValue.js +11 -1
- package/src/zuora_api/model/ConfigTemplateErrorResponse.js +11 -1
- package/src/zuora_api/model/ConfigTemplateErrorResponseReasonsInner.js +11 -1
- package/src/zuora_api/model/ConfigurationTemplateContent.js +11 -1
- package/src/zuora_api/model/Contact.js +38 -1
- package/src/zuora_api/model/ContactInfo.js +12 -2
- package/src/zuora_api/model/ContactResponse.js +53 -1
- package/src/zuora_api/model/ContactSnapshot.js +38 -1
- package/src/zuora_api/model/ContactSnapshotResponse.js +53 -1
- package/src/zuora_api/model/CreateAccountContact.js +13 -3
- package/src/zuora_api/model/CreateAccountCreditCard.js +12 -2
- package/src/zuora_api/model/CreateAccountCreditCardHolderInfo.js +12 -2
- package/src/zuora_api/model/CreateAccountPaymentMethod.js +12 -2
- package/src/zuora_api/model/CreateAccountRequest.js +33 -2
- package/src/zuora_api/model/CreateAccountResponse.js +24 -1
- package/src/zuora_api/model/CreateAccountSubscription.js +12 -2
- package/src/zuora_api/model/CreateAccountingCodeRequest.js +12 -2
- package/src/zuora_api/model/CreateAccountingCodeResponse.js +11 -1
- package/src/zuora_api/model/CreateAccountingPeriodRequest.js +12 -2
- package/src/zuora_api/model/CreateAccountingPeriodResponse.js +11 -1
- package/src/zuora_api/model/CreateAuthorizationRequest.js +12 -2
- package/src/zuora_api/model/CreateAuthorizationResponse.js +11 -1
- package/src/zuora_api/model/CreateAuthorizationResponsePaymentGateway.js +11 -1
- package/src/zuora_api/model/CreateAuthorizationResponseReasons.js +11 -1
- package/src/zuora_api/model/CreateBatchQueryJobRequest.js +11 -1
- package/src/zuora_api/model/CreateBatchQueryJobResponse.js +11 -1
- package/src/zuora_api/model/CreateBatchQueryRequest.js +11 -1
- package/src/zuora_api/model/CreateBatchQueryResponse.js +11 -1
- package/src/zuora_api/model/CreateBillRunRequest.js +31 -1
- package/src/zuora_api/model/CreateBillingAdjustmentRequest.js +21 -2
- package/src/zuora_api/model/CreateBillingDocumentFilesDeletionJobRequest.js +11 -1
- package/src/zuora_api/model/CreateBillingDocumentFilesDeletionJobResponse.js +11 -1
- package/src/zuora_api/model/CreateBillingPreviewCreditMemoItem.js +11 -1
- package/src/zuora_api/model/CreateBillingPreviewInvoiceItem.js +11 -1
- package/src/zuora_api/model/CreateBillingPreviewRequest.js +12 -2
- package/src/zuora_api/model/CreateBillingPreviewResponse.js +11 -1
- package/src/zuora_api/model/CreateBillingPreviewRunRequest.js +12 -2
- package/src/zuora_api/model/CreateBillingPreviewRunResponse.js +11 -1
- package/src/zuora_api/model/CreateCatalogGroupRequest.js +11 -1
- package/src/zuora_api/model/CreateContactRequest.js +39 -2
- package/src/zuora_api/model/CreateCreditMemoFromCharge.js +11 -1
- package/src/zuora_api/model/CreateCreditMemoFromChargeRequest.js +11 -1
- package/src/zuora_api/model/CreateCreditMemoFromInvoice.js +11 -1
- package/src/zuora_api/model/CreateCreditMemoFromInvoiceRequest.js +11 -1
- package/src/zuora_api/model/CreateCreditMemoTaxationItemsRequest.js +11 -1
- package/src/zuora_api/model/CreateDebitMemoFromCharge.js +11 -1
- package/src/zuora_api/model/CreateDebitMemoFromChargeRequest.js +11 -1
- package/src/zuora_api/model/CreateDebitMemoFromInvoiceRequest.js +46 -1
- package/src/zuora_api/model/CreateDebitMemosFromInvoiceRequest.js +61 -1
- package/src/zuora_api/model/CreateDiscountItem.js +12 -2
- package/src/zuora_api/model/CreateFulfillment.js +13 -3
- package/src/zuora_api/model/CreateFulfillmentItem.js +11 -1
- package/src/zuora_api/model/CreateFulfillmentItemResponse.js +11 -1
- package/src/zuora_api/model/CreateFulfillmentItemsRequest.js +11 -1
- package/src/zuora_api/model/CreateFulfillmentItemsResponse.js +11 -1
- package/src/zuora_api/model/CreateFulfillmentResponse.js +11 -1
- package/src/zuora_api/model/CreateFulfillmentsRequest.js +11 -1
- package/src/zuora_api/model/CreateFulfillmentsResponse.js +11 -1
- package/src/zuora_api/model/CreateInvoiceCollectCreditMemos.js +11 -1
- package/src/zuora_api/model/CreateInvoiceCollectInvoices.js +11 -1
- package/src/zuora_api/model/CreateInvoiceCollectRequest.js +12 -2
- package/src/zuora_api/model/CreateInvoiceCollectResponse.js +11 -1
- package/src/zuora_api/model/CreateInvoiceItem.js +12 -2
- package/src/zuora_api/model/CreateInvoiceRequest.js +46 -2
- package/src/zuora_api/model/CreateInvoiceScheduleItem.js +11 -1
- package/src/zuora_api/model/CreateInvoiceScheduleRequest.js +11 -1
- package/src/zuora_api/model/CreateJournalEntryRequest.js +12 -2
- package/src/zuora_api/model/CreateJournalEntryRequestItem.js +12 -2
- package/src/zuora_api/model/CreateJournalEntryRequestSegment.js +12 -2
- package/src/zuora_api/model/CreateJournalEntryResponse.js +11 -1
- package/src/zuora_api/model/CreateJournalRunRequest.js +12 -2
- package/src/zuora_api/model/CreateJournalRunRequestTransactionType.js +12 -2
- package/src/zuora_api/model/CreateJournalRunResponse.js +11 -1
- package/src/zuora_api/model/CreateMassUpdateResponse.js +11 -1
- package/src/zuora_api/model/CreateMassUpdaterRequest.js +12 -2
- package/src/zuora_api/model/CreateNonRefRefundFinanceInformation.js +11 -1
- package/src/zuora_api/model/CreateOpenPaymentMethodTypeRequest.js +12 -2
- package/src/zuora_api/model/CreateOrUpdateCatalogGroupProductRatePlan.js +11 -1
- package/src/zuora_api/model/CreateOrUpdateEmailTemplatesResponse.js +11 -1
- package/src/zuora_api/model/CreateOrderAction.js +13 -3
- package/src/zuora_api/model/CreateOrderAddProduct.js +11 -1
- package/src/zuora_api/model/CreateOrderAsyncRequest.js +12 -6
- package/src/zuora_api/model/CreateOrderAsyncResponse.js +11 -1
- package/src/zuora_api/model/CreateOrderChangePlan.js +12 -2
- package/src/zuora_api/model/CreateOrderChangePlanRatePlanOverride.js +11 -1
- package/src/zuora_api/model/CreateOrderChargeUpdate.js +11 -1
- package/src/zuora_api/model/CreateOrderCreateSubscription.js +24 -1
- package/src/zuora_api/model/CreateOrderOrderLineItem.js +51 -10
- package/src/zuora_api/model/CreateOrderPricingUpdate.js +11 -1
- package/src/zuora_api/model/CreateOrderProductOverride.js +11 -1
- package/src/zuora_api/model/CreateOrderProductRatePlanOverride.js +11 -1
- package/src/zuora_api/model/CreateOrderRatePlanFeatureOverride.js +12 -2
- package/src/zuora_api/model/CreateOrderRatePlanOverride.js +11 -1
- package/src/zuora_api/model/CreateOrderRatePlanUpdate.js +11 -1
- package/src/zuora_api/model/CreateOrderRequest.js +12 -6
- package/src/zuora_api/model/CreateOrderResponse.js +11 -1
- package/src/zuora_api/model/CreateOrderResponseOrderAction.js +11 -1
- package/src/zuora_api/model/CreateOrderResponseOrderLineItems.js +11 -1
- package/src/zuora_api/model/CreateOrderResponseOrderMetric.js +11 -1
- package/src/zuora_api/model/CreateOrderResponseRamps.js +11 -1
- package/src/zuora_api/model/CreateOrderResponseRefunds.js +11 -1
- package/src/zuora_api/model/CreateOrderResponseSubscriptions.js +11 -1
- package/src/zuora_api/model/CreateOrderResponseWriteOff.js +11 -1
- package/src/zuora_api/model/CreateOrderResume.js +12 -2
- package/src/zuora_api/model/CreateOrderSubscription.js +11 -1
- package/src/zuora_api/model/CreateOrderSubscriptionOwnerAccount.js +12 -2
- package/src/zuora_api/model/CreateOrderSuspend.js +12 -2
- package/src/zuora_api/model/CreateOrderTermsAndConditions.js +96 -1
- package/src/zuora_api/model/CreateOrderUpdateProduct.js +11 -1
- package/src/zuora_api/model/CreatePaymentDebitMemoApplication.js +12 -2
- package/src/zuora_api/model/CreatePaymentDebitMemoApplicationItem.js +12 -2
- package/src/zuora_api/model/CreatePaymentInvoiceApplication.js +12 -2
- package/src/zuora_api/model/CreatePaymentInvoiceApplicationItem.js +12 -2
- package/src/zuora_api/model/CreatePaymentMethodACH.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodApplePayAdyen.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodBankTransfer.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodBankTransferAccountHolderInfo.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodCCReferenceTransaction.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodCardholderInfo.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodCommon.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodCreditCard.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodDecryptionRequest.js +12 -2
- package/src/zuora_api/model/CreatePaymentMethodDecryptionResponse.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodGooglePayAdyenChase.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodPayPalAdaptive.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodPayPalECPayPalNativeECPayPalCP.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodRequest.js +12 -2
- package/src/zuora_api/model/CreatePaymentMethodResponse.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodResponseReason.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodUpdaterBatchRequest.js +12 -2
- package/src/zuora_api/model/CreatePaymentMethodUpdaterBatchResponse.js +11 -1
- package/src/zuora_api/model/CreatePaymentMethodUpdaterBatchResponseReasons.js +11 -1
- package/src/zuora_api/model/CreatePaymentRequest.js +12 -2
- package/src/zuora_api/model/CreatePaymentRunData.js +11 -1
- package/src/zuora_api/model/CreatePaymentRunDataItem.js +11 -1
- package/src/zuora_api/model/CreatePaymentRunRequest.js +11 -1
- package/src/zuora_api/model/CreatePaymentScheduleItemsRequest.js +11 -1
- package/src/zuora_api/model/CreatePaymentScheduleItemsRequestItems.js +12 -2
- package/src/zuora_api/model/CreatePaymentScheduleRequest.js +11 -1
- package/src/zuora_api/model/CreatePaymentScheduleRequestItems.js +11 -1
- package/src/zuora_api/model/CreatePaymentSchedulesRequest.js +11 -1
- package/src/zuora_api/model/CreatePaymentSchedulesResponse.js +11 -1
- package/src/zuora_api/model/CreatePaymentSchedulesResponseItems.js +11 -1
- package/src/zuora_api/model/CreatePaymentSessionInvoice.js +11 -1
- package/src/zuora_api/model/CreatePaymentSessionRequest.js +11 -1
- package/src/zuora_api/model/CreatePaymentSessionResponse.js +11 -1
- package/src/zuora_api/model/CreateProductRatePlanChargeRequest.js +12 -2
- package/src/zuora_api/model/CreateProductRatePlanRequest.js +12 -2
- package/src/zuora_api/model/CreateProductRequest.js +12 -2
- package/src/zuora_api/model/CreateRSASignatureRequest.js +12 -2
- package/src/zuora_api/model/CreateRamp.js +11 -1
- package/src/zuora_api/model/CreateRefundRequest.js +12 -2
- package/src/zuora_api/model/CreateRefundwithAutoUnapply.js +12 -2
- package/src/zuora_api/model/CreateSequenceSetRequest.js +12 -2
- package/src/zuora_api/model/CreateSequenceSetsRequest.js +11 -1
- package/src/zuora_api/model/CreateSequenceSetsResponse.js +11 -1
- package/src/zuora_api/model/CreateStoredCredentialProfileRequest.js +12 -2
- package/src/zuora_api/model/CreateSubscribeToProduct.js +11 -1
- package/src/zuora_api/model/CreateSubscriptionComponent.js +12 -2
- package/src/zuora_api/model/CreateSubscriptionRatePlan.js +11 -1
- package/src/zuora_api/model/CreateSubscriptionRequest.js +12 -2
- package/src/zuora_api/model/CreateSubscriptionResponse.js +11 -1
- package/src/zuora_api/model/CreateTaxationItem.js +12 -2
- package/src/zuora_api/model/CreateTaxationItemForCreditMemoFinanceInformation.js +11 -1
- package/src/zuora_api/model/CreateTaxationItemForCreditMemoRequest.js +12 -2
- package/src/zuora_api/model/CreateTaxationItemForDebitMemo.js +12 -2
- package/src/zuora_api/model/CreateTaxationItemForDebitMemoFinanceInformation.js +11 -1
- package/src/zuora_api/model/CreateTaxationItemForInvoiceRequest.js +12 -2
- package/src/zuora_api/model/CreateTaxationItemsForDebitMemoRequest.js +11 -1
- package/src/zuora_api/model/CreateTaxationItemsRequest.js +11 -1
- package/src/zuora_api/model/CreateTemplateRequestContent.js +12 -2
- package/src/zuora_api/model/CreateTokenRequest.js +12 -2
- package/src/zuora_api/model/CreateUpdateOpenPaymentMethodTypeResponse.js +11 -1
- package/src/zuora_api/model/CreateUpdateStoredCredentialProfileResponse.js +11 -1
- package/src/zuora_api/model/CreateUsageRequest.js +12 -2
- package/src/zuora_api/model/CreditCard.js +11 -1
- package/src/zuora_api/model/CreditMemo.js +24 -1
- package/src/zuora_api/model/CreditMemoEntityPrefix.js +11 -1
- package/src/zuora_api/model/CreditMemoItem.js +44 -2
- package/src/zuora_api/model/CreditMemoItemFinanceInformation.js +37 -1
- package/src/zuora_api/model/CreditMemoItemFromChargeDetail.js +12 -2
- package/src/zuora_api/model/CreditMemoItemFromChargeDetailFinanceInformation.js +11 -1
- package/src/zuora_api/model/CreditMemoItemFromInvoiceItem.js +12 -2
- package/src/zuora_api/model/CreditMemoItemFromInvoiceItemFinanceInformation.js +11 -1
- package/src/zuora_api/model/CreditMemoItemFromWriteOffInvoice.js +38 -1
- package/src/zuora_api/model/CreditMemoItemPart.js +11 -1
- package/src/zuora_api/model/CreditMemoItemResponse.js +53 -2
- package/src/zuora_api/model/CreditMemoItemsResponse.js +11 -1
- package/src/zuora_api/model/CreditMemoObjectNSFields.js +11 -1
- package/src/zuora_api/model/CreditMemoPart.js +11 -1
- package/src/zuora_api/model/CreditMemoResponse.js +28 -1
- package/src/zuora_api/model/CreditMemoTaxItemFromInvoiceTaxItemFinanceInformation.js +11 -1
- package/src/zuora_api/model/CreditMemoTaxItemFromInvoiceTaxItemRequest.js +11 -1
- package/src/zuora_api/model/CreditMemoTaxationItemFromWriteOffInvoice.js +110 -0
- package/src/zuora_api/model/CreditMemosResponse.js +11 -1
- package/src/zuora_api/model/CustomAccountPaymentMethod.js +11 -1
- package/src/zuora_api/model/CustomFields.js +11 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinition.js +11 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfCreatedById.js +11 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfCreatedDate.js +11 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfId.js +11 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfUpdatedById.js +11 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfUpdatedDate.js +11 -1
- package/src/zuora_api/model/CustomObjectBulkDeleteFilter.js +12 -2
- package/src/zuora_api/model/CustomObjectBulkDeleteFilterCondition.js +12 -2
- package/src/zuora_api/model/CustomObjectBulkJobErrorResponse.js +11 -1
- package/src/zuora_api/model/CustomObjectBulkJobErrorResponseCollection.js +12 -2
- package/src/zuora_api/model/CustomObjectBulkJobRequest.js +12 -2
- package/src/zuora_api/model/CustomObjectBulkJobResponse.js +11 -1
- package/src/zuora_api/model/CustomObjectBulkJobResponseCollection.js +12 -2
- package/src/zuora_api/model/CustomObjectBulkJobResponseError.js +11 -1
- package/src/zuora_api/model/CustomObjectCustomFieldDefinition.js +11 -1
- package/src/zuora_api/model/CustomObjectCustomFieldDefinitionUpdate.js +11 -1
- package/src/zuora_api/model/CustomObjectCustomFieldsDefinition.js +11 -1
- package/src/zuora_api/model/CustomObjectDefinition.js +11 -1
- package/src/zuora_api/model/CustomObjectDefinitionSchema.js +11 -1
- package/src/zuora_api/model/CustomObjectDefinitionUpdateActionRequest.js +12 -2
- package/src/zuora_api/model/CustomObjectDefinitionUpdateActionResponse.js +11 -1
- package/src/zuora_api/model/CustomObjectRecordBatchAction.js +12 -2
- package/src/zuora_api/model/CustomObjectRecordBatchRequest.js +12 -2
- package/src/zuora_api/model/CustomObjectRecordWithAllFields.js +11 -1
- package/src/zuora_api/model/CustomObjectRecordWithOnlyCustomFields.js +11 -1
- package/src/zuora_api/model/CustomObjectRecordsBatchUpdatePartialSuccessResponse.js +11 -1
- package/src/zuora_api/model/CustomObjectRecordsErrorResponse.js +11 -1
- package/src/zuora_api/model/CustomObjectRecordsThrottledResponse.js +11 -1
- package/src/zuora_api/model/CustomObjectRecordsWithError.js +11 -1
- package/src/zuora_api/model/CustomRates.js +12 -2
- package/src/zuora_api/model/DailyConsumptionRevRecRequest.js +12 -2
- package/src/zuora_api/model/DataQueryErrorResponse.js +11 -1
- package/src/zuora_api/model/DataQueryJob.js +11 -1
- package/src/zuora_api/model/DataQueryJobCancelled.js +11 -1
- package/src/zuora_api/model/DataQueryJobCommon.js +11 -1
- package/src/zuora_api/model/DebitMemo.js +37 -1
- package/src/zuora_api/model/DebitMemoDueDate.js +11 -1
- package/src/zuora_api/model/DebitMemoEntityPrefix.js +11 -1
- package/src/zuora_api/model/DebitMemoItem.js +25 -2
- package/src/zuora_api/model/DebitMemoItemFromChargeDetail.js +12 -2
- package/src/zuora_api/model/DebitMemoItemFromChargeDetailFinanceInformation.js +11 -1
- package/src/zuora_api/model/DebitMemoItemFromInvoiceItemFinanceInformation.js +11 -1
- package/src/zuora_api/model/DebitMemoItemFromInvoiceItemRequest.js +12 -2
- package/src/zuora_api/model/DebitMemoItemResponse.js +31 -3
- package/src/zuora_api/model/DebitMemoItemTaxationItems.js +11 -1
- package/src/zuora_api/model/DebitMemoItemWriteOffRequest.js +194 -0
- package/src/zuora_api/model/DebitMemoItemsResponse.js +11 -1
- package/src/zuora_api/model/DebitMemoObjectNSFields.js +11 -1
- package/src/zuora_api/model/DebitMemoResponse.js +47 -1
- package/src/zuora_api/model/DebitMemoTaxItemFromInvoiceTaxItemFinanceInformation.js +11 -1
- package/src/zuora_api/model/DebitMemoTaxItemFromInvoiceTaxItemRequest.js +11 -1
- package/src/zuora_api/model/DebitMemoTaxationItemWriteOffRequest.js +110 -0
- package/src/zuora_api/model/DebitMemosResponse.js +11 -1
- package/src/zuora_api/model/DecryptRSASignatureRequest.js +12 -2
- package/src/zuora_api/model/DecryptRSASignatureResponse.js +11 -1
- package/src/zuora_api/model/DeleteAccountResponse.js +11 -1
- package/src/zuora_api/model/DeleteAttachmentResponse.js +11 -1
- package/src/zuora_api/model/DeleteBatchQueryJobResponse.js +11 -1
- package/src/zuora_api/model/DeleteBatchQueryResponse.js +11 -1
- package/src/zuora_api/model/DeleteDataQueryJobResponse.js +11 -1
- package/src/zuora_api/model/DeleteResult.js +11 -1
- package/src/zuora_api/model/DeleteSubscriptionResponse.js +11 -1
- package/src/zuora_api/model/DeleteWorkflowError.js +11 -1
- package/src/zuora_api/model/DeleteWorkflowSuccess.js +11 -1
- package/src/zuora_api/model/DeletedRecord.js +11 -1
- package/src/zuora_api/model/DeliverySchedule.js +11 -1
- package/src/zuora_api/model/DeliveryScheduleParams.js +11 -1
- package/src/zuora_api/model/DeliveryScheduleProductRatePlanCharge.js +11 -1
- package/src/zuora_api/model/DetailedWorkflow.js +11 -1
- package/src/zuora_api/model/DiscountApplyDetail.js +11 -1
- package/src/zuora_api/model/DiscountPricingOverride.js +11 -5
- package/src/zuora_api/model/DiscountPricingUpdate.js +11 -5
- package/src/zuora_api/model/DocumentIdList.js +11 -1
- package/src/zuora_api/model/ElectronicPaymentOptions.js +11 -1
- package/src/zuora_api/model/ElectronicPaymentOptionsWithDelayedCapturePayment.js +11 -1
- package/src/zuora_api/model/EmailBillRunRequest.js +11 -1
- package/src/zuora_api/model/EmailBillingDocumentRequest.js +11 -1
- package/src/zuora_api/model/EndConditions.js +11 -1
- package/src/zuora_api/model/Error401.js +11 -1
- package/src/zuora_api/model/ErrorResponse.js +11 -1
- package/src/zuora_api/model/ErrorResponse401Record.js +11 -1
- package/src/zuora_api/model/ErrorResponseReasonsInner.js +11 -1
- package/src/zuora_api/model/EventTrigger.js +11 -1
- package/src/zuora_api/model/EventType.js +12 -2
- package/src/zuora_api/model/ExecuteInvoiceScheduleRequest.js +11 -1
- package/src/zuora_api/model/ExpandedAccount.js +11 -1
- package/src/zuora_api/model/ExpandedAmendment.js +11 -1
- package/src/zuora_api/model/ExpandedAuthentication.js +11 -1
- package/src/zuora_api/model/ExpandedBillingRun.js +11 -1
- package/src/zuora_api/model/ExpandedContact.js +11 -1
- package/src/zuora_api/model/ExpandedCreditMemo.js +23 -1
- package/src/zuora_api/model/ExpandedCreditMemoApplication.js +11 -1
- package/src/zuora_api/model/ExpandedCreditMemoItem.js +35 -1
- package/src/zuora_api/model/ExpandedDailyConsumptionSummary.js +11 -1
- package/src/zuora_api/model/ExpandedDebitMemo.js +23 -1
- package/src/zuora_api/model/ExpandedDebitMemoItem.js +11 -1
- package/src/zuora_api/model/ExpandedExternalProductRatePlan.js +185 -0
- package/src/zuora_api/model/ExpandedInvoice.js +11 -1
- package/src/zuora_api/model/ExpandedInvoiceItem.js +11 -1
- package/src/zuora_api/model/ExpandedMapping.js +11 -1
- package/src/zuora_api/model/ExpandedOAuth.js +11 -1
- package/src/zuora_api/model/ExpandedOAuthError.js +11 -1
- package/src/zuora_api/model/ExpandedOrderAction.js +11 -1
- package/src/zuora_api/model/ExpandedOrderLineItem.js +51 -1
- package/src/zuora_api/model/ExpandedOrders.js +11 -1
- package/src/zuora_api/model/ExpandedPayment.js +11 -1
- package/src/zuora_api/model/ExpandedPaymentApplication.js +11 -1
- package/src/zuora_api/model/ExpandedPaymentMethod.js +71 -1
- package/src/zuora_api/model/ExpandedPaymentMethodSnapshot.js +11 -1
- package/src/zuora_api/model/ExpandedPaymentRun.js +11 -1
- package/src/zuora_api/model/ExpandedPaymentSchedule.js +11 -1
- package/src/zuora_api/model/ExpandedPaymentScheduleItem.js +11 -1
- package/src/zuora_api/model/ExpandedPrepaidBalance.js +11 -1
- package/src/zuora_api/model/ExpandedPrepaidBalanceFund.js +11 -1
- package/src/zuora_api/model/ExpandedPrepaidBalanceTransaction.js +11 -1
- package/src/zuora_api/model/ExpandedProcessedUsage.js +11 -1
- package/src/zuora_api/model/ExpandedProduct.js +11 -1
- package/src/zuora_api/model/ExpandedProductRatePlan.js +24 -1
- package/src/zuora_api/model/ExpandedProductRatePlanCharge.js +11 -1
- package/src/zuora_api/model/ExpandedProductRatePlanChargeTier.js +11 -1
- package/src/zuora_api/model/ExpandedRatePlan.js +11 -1
- package/src/zuora_api/model/ExpandedRatePlanCharge.js +11 -1
- package/src/zuora_api/model/ExpandedRatePlanChargeTier.js +11 -1
- package/src/zuora_api/model/ExpandedRatingResult.js +11 -1
- package/src/zuora_api/model/ExpandedRefund.js +11 -1
- package/src/zuora_api/model/ExpandedRefundApplication.js +11 -1
- package/src/zuora_api/model/ExpandedRefundApplicationItem.js +11 -1
- package/src/zuora_api/model/ExpandedReportDownloadError.js +11 -1
- package/src/zuora_api/model/ExpandedReportGetRecent.js +11 -1
- package/src/zuora_api/model/ExpandedReportGetRecentDownloadError.js +11 -1
- package/src/zuora_api/model/ExpandedReportGetRecentNotFoundError.js +11 -1
- package/src/zuora_api/model/ExpandedReportList.js +11 -1
- package/src/zuora_api/model/ExpandedReportListError.js +11 -1
- package/src/zuora_api/model/ExpandedSignedUrl.js +11 -1
- package/src/zuora_api/model/ExpandedStageError.js +11 -1
- package/src/zuora_api/model/ExpandedSubscription.js +11 -1
- package/src/zuora_api/model/ExpandedTaxationItem.js +11 -1
- package/src/zuora_api/model/ExpandedUploadCsv.js +11 -1
- package/src/zuora_api/model/ExpandedUploadCsvError.js +11 -1
- package/src/zuora_api/model/ExpandedUploadCsvErrorStatus.js +11 -1
- package/src/zuora_api/model/ExpandedUploadCsvResult.js +11 -1
- package/src/zuora_api/model/ExpandedUploadCsvStatus.js +11 -1
- package/src/zuora_api/model/ExpandedUploadCsvStatusResult.js +11 -1
- package/src/zuora_api/model/ExpandedUploadFile.js +11 -1
- package/src/zuora_api/model/ExpandedUploadFileError.js +11 -1
- package/src/zuora_api/model/ExpandedUploadFileStatus.js +11 -1
- package/src/zuora_api/model/ExpandedUsage.js +23 -1
- package/src/zuora_api/model/ExpandedValidityPeriodSummary.js +23 -1
- package/src/zuora_api/model/ExportWorkflowVersionResponse.js +11 -1
- package/src/zuora_api/model/FailedReason.js +11 -1
- package/src/zuora_api/model/FaultResponse.js +11 -1
- package/src/zuora_api/model/FilterRuleParameterDefinition.js +11 -1
- package/src/zuora_api/model/Fulfillment.js +12 -2
- package/src/zuora_api/model/FulfillmentItem.js +11 -1
- package/src/zuora_api/model/GETBookingDateBackfillJobById200Response.js +11 -1
- package/src/zuora_api/model/GETDataBackfillJobById200Response.js +11 -1
- package/src/zuora_api/model/GETListBookingDateBackfillJobs200Response.js +11 -1
- package/src/zuora_api/model/GETListDataBackfillJobs200Response.js +11 -1
- package/src/zuora_api/model/GatewayOptions.js +11 -1
- package/src/zuora_api/model/GenerateBillingDocumentRequest.js +11 -1
- package/src/zuora_api/model/GenerateBillingDocumentResponse.js +11 -1
- package/src/zuora_api/model/GenerateBillingDocumentResponseCreditMemo.js +11 -1
- package/src/zuora_api/model/GenerateBillingDocumentResponseInvoice.js +11 -1
- package/src/zuora_api/model/GetAccountPMAccountHolderInfo.js +11 -1
- package/src/zuora_api/model/GetAccountPaymentMethodResponse.js +11 -1
- package/src/zuora_api/model/GetAccountingCodeResponse.js +11 -1
- package/src/zuora_api/model/GetAccountingCodesResponse.js +11 -1
- package/src/zuora_api/model/GetAccountingPeriodAllOfFieIdsResponse.js +11 -1
- package/src/zuora_api/model/GetAccountingPeriodResponse.js +11 -1
- package/src/zuora_api/model/GetAccountingPeriodWithoutSuccessResponse.js +11 -1
- package/src/zuora_api/model/GetAccountingPeriodsResponse.js +11 -1
- package/src/zuora_api/model/GetAllCustomObjectDefinitionsInNamespaceResponse.js +11 -1
- package/src/zuora_api/model/GetApiVolumeSummaryResponse.js +11 -1
- package/src/zuora_api/model/GetAsyncOrderJobResponse.js +11 -1
- package/src/zuora_api/model/GetAttachmentResponse.js +11 -1
- package/src/zuora_api/model/GetAttachmentsResponse.js +11 -1
- package/src/zuora_api/model/GetBatchQueryJobResponse.js +11 -1
- package/src/zuora_api/model/GetBatchQueryResponse.js +11 -1
- package/src/zuora_api/model/GetBillingAdjustmentsBySubscriptionNumberResponse.js +11 -1
- package/src/zuora_api/model/GetBillingAdjustmentsResponse.js +11 -1
- package/src/zuora_api/model/GetBillingDocVolumeSummaryResponse.js +11 -1
- package/src/zuora_api/model/GetBillingDocumentFilesDeletionJobResponse.js +11 -1
- package/src/zuora_api/model/GetBillingDocumentsResponse.js +11 -1
- package/src/zuora_api/model/GetBillingPreviewRunResponse.js +11 -1
- package/src/zuora_api/model/GetBulkPdfGenerationJobResponse.js +31 -1
- package/src/zuora_api/model/GetBulkUpdateOrderLineItemsResponse.js +11 -1
- package/src/zuora_api/model/GetCalloutHistoryVOType.js +11 -1
- package/src/zuora_api/model/GetCalloutHistoryVOsType.js +11 -1
- package/src/zuora_api/model/GetCatalogGroupResponse.js +11 -5
- package/src/zuora_api/model/GetCatalogGroupsResponse.js +11 -1
- package/src/zuora_api/model/GetChargeOverride.js +66 -4
- package/src/zuora_api/model/GetCreditMemoItemPartResponse.js +11 -1
- package/src/zuora_api/model/GetCreditMemoItemPartsResponse.js +11 -1
- package/src/zuora_api/model/GetCreditMemoItemTaxationItems.js +11 -1
- package/src/zuora_api/model/GetCreditMemoPartResponse.js +11 -1
- package/src/zuora_api/model/GetCreditMemoPartsResponse.js +11 -1
- package/src/zuora_api/model/GetCreditMemoPdfStatusBatchResponse.js +11 -1
- package/src/zuora_api/model/GetCreditMemoPdfStatusResponse.js +50 -1
- package/src/zuora_api/model/GetCreditMemoTaxItemFinanceInformation.js +11 -1
- package/src/zuora_api/model/GetCreditMemoTaxItemResponse.js +11 -1
- package/src/zuora_api/model/GetCreditMemoTaxationItemResponse.js +11 -1
- package/src/zuora_api/model/GetCustomExchangeRatesDataType.js +11 -1
- package/src/zuora_api/model/GetCustomExchangeRatesType.js +11 -1
- package/src/zuora_api/model/GetDataQueryJobResponse.js +11 -1
- package/src/zuora_api/model/GetDataQueryJobsResponse.js +11 -1
- package/src/zuora_api/model/GetDebitMemoApplicationPart.js +23 -5
- package/src/zuora_api/model/GetDebitMemoApplicationPartsResponse.js +11 -1
- package/src/zuora_api/model/GetDebitMemoItemFinanceInformation.js +11 -1
- package/src/zuora_api/model/GetDebitMemoPdfStatusBatchResponse.js +11 -1
- package/src/zuora_api/model/GetDebitMemoPdfStatusResponse.js +50 -1
- package/src/zuora_api/model/GetDebitMemoTaxItem.js +11 -1
- package/src/zuora_api/model/GetDebitMemoTaxItemFinanceInformation.js +11 -1
- package/src/zuora_api/model/GetDebitMemoTaxItemNew.js +11 -1
- package/src/zuora_api/model/GetEmailHistoryVOType.js +11 -1
- package/src/zuora_api/model/GetEmailHistoryVOsType.js +11 -1
- package/src/zuora_api/model/GetEventTriggers200Response.js +11 -1
- package/src/zuora_api/model/GetFulfillment.js +13 -3
- package/src/zuora_api/model/GetFulfillmentItem.js +11 -1
- package/src/zuora_api/model/GetFulfillmentItemResponse.js +11 -1
- package/src/zuora_api/model/GetFulfillmentResponse.js +11 -1
- package/src/zuora_api/model/GetInvoiceApplicationPartRequest.js +11 -1
- package/src/zuora_api/model/GetInvoiceApplicationPartsRequest.js +11 -1
- package/src/zuora_api/model/GetInvoicePdfStatusBatchResponse.js +11 -1
- package/src/zuora_api/model/GetInvoicePdfStatusResponse.js +50 -1
- package/src/zuora_api/model/GetJournalEntriesInJournalRunResponse.js +11 -1
- package/src/zuora_api/model/GetJournalEntryDetailResponse.js +11 -1
- package/src/zuora_api/model/GetJournalEntryDetailTypeWithoutSuccess.js +11 -1
- package/src/zuora_api/model/GetJournalEntryItemResponse.js +11 -1
- package/src/zuora_api/model/GetJournalEntrySegmentResponse.js +11 -1
- package/src/zuora_api/model/GetJournalRunResponse.js +11 -1
- package/src/zuora_api/model/GetJournalRunTransactionResponse.js +11 -1
- package/src/zuora_api/model/GetMassUpdateResponse.js +11 -1
- package/src/zuora_api/model/GetMetricsBySubscriptionNumbersResponse.js +11 -1
- package/src/zuora_api/model/GetOrderActionRatePlanResponse.js +11 -1
- package/src/zuora_api/model/GetOrderLineItem.js +83 -21
- package/src/zuora_api/model/GetOrderLineItemResponse.js +11 -1
- package/src/zuora_api/model/GetOrderResponse.js +11 -1
- package/src/zuora_api/model/GetOrdersResponse.js +11 -1
- package/src/zuora_api/model/GetPMAccountHolderInfo.js +11 -1
- package/src/zuora_api/model/GetPaymentFinanceInformation.js +11 -1
- package/src/zuora_api/model/GetPaymentItemPartResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentItemPartsResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentMethodForAccountResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentMethodResponseACHForAccount.js +11 -1
- package/src/zuora_api/model/GetPaymentMethodResponseApplePayForAccount.js +11 -1
- package/src/zuora_api/model/GetPaymentMethodResponseBankTransferForAccount.js +11 -1
- package/src/zuora_api/model/GetPaymentMethodResponseCreditCardForAccount.js +11 -1
- package/src/zuora_api/model/GetPaymentMethodResponseGooglePayForAccount.js +11 -1
- package/src/zuora_api/model/GetPaymentMethodResponsePayPalForAccount.js +11 -1
- package/src/zuora_api/model/GetPaymentPartResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentPartsResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentRunDataArrayResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentRunDataElementResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentRunDataTransactionElementResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentRunStatisticResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentRunSummaryResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentRunSummaryTotalValuesResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentRunsResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentScheduleStatisticResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentScheduleStatisticResponsePaymentScheduleItems.js +11 -1
- package/src/zuora_api/model/GetPaymentSchedulesResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentVolumeSummaryResponse.js +11 -1
- package/src/zuora_api/model/GetPaymentsResponse.js +11 -1
- package/src/zuora_api/model/GetProductRatePlanChargeResponse.js +24 -1
- package/src/zuora_api/model/GetProductRatePlanChargeTierResponse.js +11 -1
- package/src/zuora_api/model/GetProductRatePlanResponse.js +11 -1
- package/src/zuora_api/model/GetProductRatePlansByExternalIdResponse.js +11 -1
- package/src/zuora_api/model/GetProductRatePlansByProductResponse.js +11 -1
- package/src/zuora_api/model/GetProductResponse.js +11 -1
- package/src/zuora_api/model/GetProductsResponse.js +11 -1
- package/src/zuora_api/model/GetPublicEmailTemplateResponse.js +11 -5
- package/src/zuora_api/model/GetPublicNotificationDefinitionResponse.js +11 -1
- package/src/zuora_api/model/GetPublicNotificationDefinitionResponseCallout.js +11 -1
- package/src/zuora_api/model/GetPublicNotificationDefinitionResponseFilterRule.js +11 -1
- package/src/zuora_api/model/GetQueryEmailTemplates200Response.js +11 -1
- package/src/zuora_api/model/GetQueryNotificationDefinitions200Response.js +11 -1
- package/src/zuora_api/model/GetRampByRampNumberResponse.js +11 -1
- package/src/zuora_api/model/GetRampMetricsByOrderNumberResponse.js +11 -1
- package/src/zuora_api/model/GetRampMetricsByRampNumberResponse.js +11 -1
- package/src/zuora_api/model/GetRampMetricsBySubscriptionKeyResponse.js +11 -1
- package/src/zuora_api/model/GetRampsBySubscriptionKeyResponse.js +11 -1
- package/src/zuora_api/model/GetRefundCreditMemoFinanceInformation.js +11 -1
- package/src/zuora_api/model/GetRefundItemPartResponse.js +11 -1
- package/src/zuora_api/model/GetRefundItemPartsResponse.js +11 -1
- package/src/zuora_api/model/GetRefundPartResponse.js +11 -1
- package/src/zuora_api/model/GetRefundPartsResponse.js +11 -1
- package/src/zuora_api/model/GetRefundsResponse.js +11 -1
- package/src/zuora_api/model/GetScheduledEventResponse.js +11 -1
- package/src/zuora_api/model/GetScheduledEventResponseParametersValue.js +11 -1
- package/src/zuora_api/model/GetScheduledEvents200Response.js +11 -1
- package/src/zuora_api/model/GetSequenceSetResponse.js +11 -1
- package/src/zuora_api/model/GetSequenceSetsResponse.js +11 -1
- package/src/zuora_api/model/GetSubscriptionChangeLogResponse.js +175 -0
- package/src/zuora_api/model/GetSubscriptionChangeLogsResponse.js +181 -0
- package/src/zuora_api/model/GetSubscriptionProductFeature.js +11 -1
- package/src/zuora_api/model/GetSubscriptionRatePlan.js +11 -1
- package/src/zuora_api/model/GetSubscriptionRatePlanChargesWithAllSegments.js +19 -1
- package/src/zuora_api/model/GetSubscriptionResponse.js +56 -1
- package/src/zuora_api/model/GetSubscriptionsResponse.js +11 -1
- package/src/zuora_api/model/GetTaxationItemResponse.js +11 -1
- package/src/zuora_api/model/GetTaxationItemsOfCreditMemoItemResponse.js +11 -1
- package/src/zuora_api/model/GetTaxationItemsOfDebitMemoItemResponse.js +11 -1
- package/src/zuora_api/model/GetTaxationItemsResponse.js +11 -1
- package/src/zuora_api/model/GetUsageRateDetailRequest.js +11 -1
- package/src/zuora_api/model/GetUsageRateDetailRequestData.js +11 -1
- package/src/zuora_api/model/GetUsageResponse.js +11 -1
- package/src/zuora_api/model/GetUsagesByAccountResponse.js +11 -1
- package/src/zuora_api/model/GetVersionsResponse.js +11 -1
- package/src/zuora_api/model/GetWorkflowResponse.js +11 -1
- package/src/zuora_api/model/GetWorkflowResponseTasks.js +11 -1
- package/src/zuora_api/model/GetWorkflowsResponse.js +11 -1
- package/src/zuora_api/model/GetWorkflowsResponsePagination.js +11 -1
- package/src/zuora_api/model/HostedPageResponse.js +11 -1
- package/src/zuora_api/model/HostedPagesResponse.js +11 -1
- package/src/zuora_api/model/IneligibleBillingAdjustment.js +11 -1
- package/src/zuora_api/model/InitialTerm.js +11 -1
- package/src/zuora_api/model/IntervalPricing.js +11 -1
- package/src/zuora_api/model/IntervalPricingTier.js +11 -1
- package/src/zuora_api/model/Invoice.js +37 -1
- package/src/zuora_api/model/InvoiceEntityPrefix.js +11 -1
- package/src/zuora_api/model/InvoiceFile.js +11 -1
- package/src/zuora_api/model/InvoiceFilesResponse.js +11 -1
- package/src/zuora_api/model/InvoiceItem.js +24 -1
- package/src/zuora_api/model/InvoiceItemObjectNSFields.js +11 -1
- package/src/zuora_api/model/InvoiceItemPreviewResult.js +11 -1
- package/src/zuora_api/model/InvoiceItemPreviewResultAdditionalInfo.js +11 -1
- package/src/zuora_api/model/InvoiceItemPreviewResultTaxationItems.js +11 -1
- package/src/zuora_api/model/InvoiceItemsResponse.js +11 -1
- package/src/zuora_api/model/InvoiceObjectNSFields.js +11 -1
- package/src/zuora_api/model/InvoicePostResponse.js +11 -1
- package/src/zuora_api/model/InvoiceResponse.js +47 -1
- package/src/zuora_api/model/InvoiceSchedule.js +11 -1
- package/src/zuora_api/model/InvoiceScheduleCustomFields.js +11 -1
- package/src/zuora_api/model/InvoiceScheduleItem.js +11 -1
- package/src/zuora_api/model/InvoiceScheduleItemCustomFields.js +11 -1
- package/src/zuora_api/model/InvoiceScheduleResponse.js +11 -1
- package/src/zuora_api/model/InvoiceScheduleSubscription.js +11 -1
- package/src/zuora_api/model/InvoiceTaxationItem.js +11 -1
- package/src/zuora_api/model/Job.js +11 -1
- package/src/zuora_api/model/LastTerm.js +12 -2
- package/src/zuora_api/model/Linkage.js +11 -1
- package/src/zuora_api/model/ListAllSettingsResponse.js +11 -1
- package/src/zuora_api/model/ListOfExchangeRates.js +11 -1
- package/src/zuora_api/model/MemoDetailRevenueImpacting.js +46 -0
- package/src/zuora_api/model/MemoRevenueImpacting.js +46 -0
- package/src/zuora_api/model/MemoSourceType.js +14 -0
- package/src/zuora_api/model/MigrationClientResponse.js +12 -2
- package/src/zuora_api/model/MigrationComponentContent.js +11 -1
- package/src/zuora_api/model/MigrationUpdateCustomObjectDefinitionsRequest.js +12 -2
- package/src/zuora_api/model/MigrationUpdateCustomObjectDefinitionsResponse.js +11 -1
- package/src/zuora_api/model/NotificationsHistoryDeletionTaskResponse.js +11 -1
- package/src/zuora_api/model/ObjectPostImportRequest.js +12 -2
- package/src/zuora_api/model/OneTimeFlatFeePricingOverride.js +12 -2
- package/src/zuora_api/model/OneTimePerUnitPricingOverride.js +11 -1
- package/src/zuora_api/model/OneTimeTieredPricingOverride.js +11 -1
- package/src/zuora_api/model/OneTimeVolumePricingOverride.js +11 -1
- package/src/zuora_api/model/OpenPaymentMethodTypeRequestFields.js +11 -1
- package/src/zuora_api/model/OpenPaymentMethodTypeResponse.js +11 -1
- package/src/zuora_api/model/OpenPaymentMethodTypeResponseFields.js +11 -1
- package/src/zuora_api/model/OperationJobResponse.js +11 -1
- package/src/zuora_api/model/Options.js +11 -1
- package/src/zuora_api/model/Order.js +17 -7
- package/src/zuora_api/model/OrderAction.js +13 -3
- package/src/zuora_api/model/OrderActionAddProduct.js +14 -4
- package/src/zuora_api/model/OrderActionCancelSubscription.js +12 -2
- package/src/zuora_api/model/OrderActionChangePlan.js +11 -1
- package/src/zuora_api/model/OrderActionCreateSubscription.js +24 -1
- package/src/zuora_api/model/OrderActionCreateSubscriptionTerms.js +16 -8
- package/src/zuora_api/model/OrderActionOwnerTransfer.js +33 -1
- package/src/zuora_api/model/OrderActionRatePlanAmendment.js +11 -1
- package/src/zuora_api/model/OrderActionRatePlanBillingUpdate.js +11 -1
- package/src/zuora_api/model/OrderActionRatePlanChargeModelDataOverride.js +11 -1
- package/src/zuora_api/model/OrderActionRatePlanChargeOverride.js +12 -2
- package/src/zuora_api/model/OrderActionRatePlanChargeRemove.js +11 -1
- package/src/zuora_api/model/OrderActionRatePlanChargeUpdate.js +11 -1
- package/src/zuora_api/model/OrderActionRatePlanOrder.js +11 -1
- package/src/zuora_api/model/OrderActionRatePlanOrderAction.js +11 -1
- package/src/zuora_api/model/OrderActionRatePlanOverride.js +12 -2
- package/src/zuora_api/model/OrderActionRatePlanPricingUpdate.js +11 -1
- package/src/zuora_api/model/OrderActionRatePlanRecurringDeliveryPricingOverride.js +11 -5
- package/src/zuora_api/model/OrderActionRatePlanRecurringDeliveryPricingUpdate.js +11 -5
- package/src/zuora_api/model/OrderActionRatePlanRecurringFlatFeePricingOverride.js +11 -5
- package/src/zuora_api/model/OrderActionRatePlanRecurringPerUnitPricingOverride.js +11 -5
- package/src/zuora_api/model/OrderActionRatePlanRecurringTieredPricingOverride.js +11 -5
- package/src/zuora_api/model/OrderActionRatePlanRecurringVolumePricingOverride.js +11 -5
- package/src/zuora_api/model/OrderActionRatePlanRemoveProduct.js +11 -1
- package/src/zuora_api/model/OrderActionRatePlanUpdate.js +11 -1
- package/src/zuora_api/model/OrderActionRemoveProduct.js +11 -1
- package/src/zuora_api/model/OrderActionRenewSubscription.js +33 -1
- package/src/zuora_api/model/OrderActionResume.js +11 -1
- package/src/zuora_api/model/OrderActionSuspend.js +11 -1
- package/src/zuora_api/model/OrderActionTermsAndConditions.js +87 -1
- package/src/zuora_api/model/OrderActionUpdateProduct.js +11 -1
- package/src/zuora_api/model/OrderCreateAccount.js +29 -2
- package/src/zuora_api/model/OrderCreateAccountContact.js +12 -2
- package/src/zuora_api/model/OrderDeltaMetric.js +11 -1
- package/src/zuora_api/model/OrderDeltaMrr.js +11 -1
- package/src/zuora_api/model/OrderDeltaTcb.js +11 -1
- package/src/zuora_api/model/OrderDeltaTcv.js +11 -1
- package/src/zuora_api/model/OrderExistingAccountDetails.js +11 -1
- package/src/zuora_api/model/OrderItem.js +11 -1
- package/src/zuora_api/model/OrderLineItem.js +63 -21
- package/src/zuora_api/model/OrderLineItemState.js +2 -2
- package/src/zuora_api/model/OrderMetric.js +11 -1
- package/src/zuora_api/model/OrderRampIntervalMetrics.js +11 -1
- package/src/zuora_api/model/OrderRampMetrics.js +11 -1
- package/src/zuora_api/model/OrderSchedulingOptions.js +11 -1
- package/src/zuora_api/model/OrderSubscriptions.js +11 -1
- package/src/zuora_api/model/OrderSubscriptionsSubscriptionOwnerAccountDetails.js +11 -1
- package/src/zuora_api/model/OrganizationLabel.js +11 -1
- package/src/zuora_api/model/OverrideDiscountApplyDetail.js +12 -2
- package/src/zuora_api/model/PATCHUpdateWorkflowRequest.js +11 -1
- package/src/zuora_api/model/POSTCreateBookingDateBackfillJob200Response.js +11 -1
- package/src/zuora_api/model/POSTCreateDataBackfillJob200Response.js +11 -1
- package/src/zuora_api/model/POSTCreateDataBackfillJobRequest.js +12 -2
- package/src/zuora_api/model/PUTStopBookingDateBackfillJobByIdRequest.js +12 -2
- package/src/zuora_api/model/Payment.js +11 -1
- package/src/zuora_api/model/PaymentData.js +11 -1
- package/src/zuora_api/model/PaymentEntityPrefix.js +11 -1
- package/src/zuora_api/model/PaymentGatewaysResponse.js +11 -1
- package/src/zuora_api/model/PaymentGatwayResponse.js +11 -1
- package/src/zuora_api/model/PaymentItemPart.js +11 -1
- package/src/zuora_api/model/PaymentMethodObjectCustomFields.js +11 -1
- package/src/zuora_api/model/PaymentMethodObjectCustomFieldsForAccount.js +11 -1
- package/src/zuora_api/model/PaymentMethodRequestMandateInfo.js +11 -1
- package/src/zuora_api/model/PaymentMethodRequestProcessingOptions.js +11 -1
- package/src/zuora_api/model/PaymentMethodResponse.js +11 -1
- package/src/zuora_api/model/PaymentMethodResponseACH.js +11 -1
- package/src/zuora_api/model/PaymentMethodResponseApplePay.js +11 -1
- package/src/zuora_api/model/PaymentMethodResponseBankTransfer.js +11 -1
- package/src/zuora_api/model/PaymentMethodResponseCreditCard.js +11 -1
- package/src/zuora_api/model/PaymentMethodResponseGooglePay.js +11 -1
- package/src/zuora_api/model/PaymentMethodResponseMandateInfo.js +11 -1
- package/src/zuora_api/model/PaymentMethodResponsePayPal.js +11 -1
- package/src/zuora_api/model/PaymentMethodSnapshotResponse.js +11 -1
- package/src/zuora_api/model/PaymentMethodTransactionLogResponse.js +11 -1
- package/src/zuora_api/model/PaymentMethodUpdaterInstanceResponse.js +11 -1
- package/src/zuora_api/model/PaymentMethodUpdaterInstancesResponse.js +11 -1
- package/src/zuora_api/model/PaymentPart.js +11 -1
- package/src/zuora_api/model/PaymentRequestFinanceInformation.js +11 -1
- package/src/zuora_api/model/PaymentResponse.js +11 -1
- package/src/zuora_api/model/PaymentRun.js +11 -1
- package/src/zuora_api/model/PaymentRunResponse.js +11 -1
- package/src/zuora_api/model/PaymentSchedule.js +11 -1
- package/src/zuora_api/model/PaymentScheduleBillingDocument.js +12 -2
- package/src/zuora_api/model/PaymentScheduleItem.js +11 -1
- package/src/zuora_api/model/PaymentScheduleItemResponse.js +11 -1
- package/src/zuora_api/model/PaymentScheduleLinkedPaymentID.js +11 -1
- package/src/zuora_api/model/PaymentSchedulePaymentOptionFields.js +11 -1
- package/src/zuora_api/model/PaymentSchedulePaymentOptionFieldsDetail.js +11 -1
- package/src/zuora_api/model/PaymentScheduleResponse.js +11 -1
- package/src/zuora_api/model/PaymentTransactionLogResponse.js +11 -1
- package/src/zuora_api/model/PaymentVolumeSummaryRecord.js +11 -1
- package/src/zuora_api/model/PaymentWithCustomRates.js +12 -2
- package/src/zuora_api/model/PostAsyncInvoiceRequest.js +11 -1
- package/src/zuora_api/model/PostAttachmentResponse.js +11 -1
- package/src/zuora_api/model/PostAttachmentsRequest.js +12 -2
- package/src/zuora_api/model/PostBillRunRequest.js +12 -2
- package/src/zuora_api/model/PostBusinessRegionsRequest.js +12 -2
- package/src/zuora_api/model/PostCompareTemplateRequest.js +11 -1
- package/src/zuora_api/model/PostCreateOrUpdateEmailTemplateRequest.js +11 -1
- package/src/zuora_api/model/PostCreateOrUpdateEmailTemplateRequestFormat.js +12 -22
- package/src/zuora_api/model/PostCreditMemoRequest.js +11 -1
- package/src/zuora_api/model/PostCustomObjectDefinitionFieldDefinitionRequest.js +12 -2
- package/src/zuora_api/model/PostCustomObjectDefinitionsRequest.js +11 -1
- package/src/zuora_api/model/PostCustomObjectDefinitionsRequestDefinition.js +12 -2
- package/src/zuora_api/model/PostCustomObjectRecordsRequest.js +12 -2
- package/src/zuora_api/model/PostCustomObjectRecordsResponse.js +11 -1
- package/src/zuora_api/model/PostEventTriggerRequest.js +12 -2
- package/src/zuora_api/model/PostInvoiceRequest.js +11 -1
- package/src/zuora_api/model/PostPublicEmailTemplateRequest.js +12 -10
- package/src/zuora_api/model/PostPublicNotificationDefinitionRequest.js +12 -2
- package/src/zuora_api/model/PostPublicNotificationDefinitionRequestCallout.js +12 -2
- package/src/zuora_api/model/PostPublicNotificationDefinitionRequestFilterRule.js +12 -2
- package/src/zuora_api/model/PostResendCalloutNotifications.js +11 -1
- package/src/zuora_api/model/PostResendEmailNotifications.js +11 -1
- package/src/zuora_api/model/PostRunWorkflow400Response.js +11 -1
- package/src/zuora_api/model/PostRunWorkflow406Response.js +11 -1
- package/src/zuora_api/model/PostScheduledEventRequest.js +12 -2
- package/src/zuora_api/model/PostScheduledEventRequestParametersValue.js +11 -1
- package/src/zuora_api/model/PostServiceProviderRequest.js +12 -2
- package/src/zuora_api/model/PostWorkflowDefinitionImportRequest.js +11 -1
- package/src/zuora_api/model/PostWorkflowVersionsImportRequest.js +11 -1
- package/src/zuora_api/model/PreviewAccountInfo.js +24 -2
- package/src/zuora_api/model/PreviewChargeMetrics.js +11 -1
- package/src/zuora_api/model/PreviewChargeMetricsCmrr.js +11 -1
- package/src/zuora_api/model/PreviewChargeMetricsTax.js +11 -1
- package/src/zuora_api/model/PreviewChargeMetricsTcb.js +11 -1
- package/src/zuora_api/model/PreviewChargeMetricsTcv.js +11 -1
- package/src/zuora_api/model/PreviewContactInfo.js +11 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionCreditMemoItemResult.js +11 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionDiscountDetails.js +11 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionInvoiceItemResult.js +11 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionRequest.js +11 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionResponse.js +11 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionResultCreditMemos.js +11 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionResultInvoices.js +11 -1
- package/src/zuora_api/model/PreviewOptions.js +11 -1
- package/src/zuora_api/model/PreviewOrderAsyncRequest.js +12 -6
- package/src/zuora_api/model/PreviewOrderAsyncResponse.js +11 -1
- package/src/zuora_api/model/PreviewOrderChargeOverride.js +12 -2
- package/src/zuora_api/model/PreviewOrderChargeUpdate.js +11 -1
- package/src/zuora_api/model/PreviewOrderCreateSubscription.js +24 -1
- package/src/zuora_api/model/PreviewOrderCreateSubscriptionTerms.js +12 -2
- package/src/zuora_api/model/PreviewOrderOrderAction.js +12 -2
- package/src/zuora_api/model/PreviewOrderPricingUpdate.js +11 -1
- package/src/zuora_api/model/PreviewOrderRatePlanOverride.js +12 -2
- package/src/zuora_api/model/PreviewOrderRatePlanUpdate.js +11 -1
- package/src/zuora_api/model/PreviewOrderRequest.js +16 -10
- package/src/zuora_api/model/PreviewOrderResponse.js +11 -1
- package/src/zuora_api/model/PreviewOrderResult.js +11 -1
- package/src/zuora_api/model/PreviewOrderResultChargeMetrics.js +11 -1
- package/src/zuora_api/model/PreviewOrderResultCreditMemos.js +11 -1
- package/src/zuora_api/model/PreviewOrderResultDeltaMetrics.js +11 -1
- package/src/zuora_api/model/PreviewOrderResultInvoices.js +11 -1
- package/src/zuora_api/model/PreviewOrderSubscriptionOwnerAccount.js +12 -2
- package/src/zuora_api/model/PreviewOrderSubscriptions.js +153 -0
- package/src/zuora_api/model/PreviewOrderSubscriptionsAsync.js +41 -2
- package/src/zuora_api/model/PreviewPaymentSchedule.js +11 -1
- package/src/zuora_api/model/PreviewResultOrderMetricsInner.js +11 -1
- package/src/zuora_api/model/PreviewResultOrderMetricsInnerOrderActionsInner.js +11 -1
- package/src/zuora_api/model/PreviewStartDate.js +11 -1
- package/src/zuora_api/model/PreviewSubscriptionAccountInfo.js +12 -2
- package/src/zuora_api/model/PreviewSubscriptionBillToContact.js +11 -1
- package/src/zuora_api/model/PreviewSubscriptionInvoice.js +11 -1
- package/src/zuora_api/model/PreviewSubscriptionInvoiceItem.js +11 -1
- package/src/zuora_api/model/PreviewSubscriptionRequest.js +12 -2
- package/src/zuora_api/model/PreviewSubscriptionResponse.js +11 -1
- package/src/zuora_api/model/PreviewThroughDate.js +11 -1
- package/src/zuora_api/model/PriceChangeParams.js +11 -5
- package/src/zuora_api/model/PricingUpdate.js +11 -1
- package/src/zuora_api/model/ProcessingOptions.js +11 -1
- package/src/zuora_api/model/ProcessingOptionsWithDelayedCapturePayment.js +11 -1
- package/src/zuora_api/model/Product.js +11 -1
- package/src/zuora_api/model/ProductFeature.js +11 -1
- package/src/zuora_api/model/ProductObjectNSFields.js +11 -1
- package/src/zuora_api/model/ProductRatePlan.js +11 -1
- package/src/zuora_api/model/ProductRatePlanCharge.js +20 -1
- package/src/zuora_api/model/ProductRatePlanChargeObjectNSFields.js +11 -1
- package/src/zuora_api/model/ProductRatePlanChargeTier.js +11 -1
- package/src/zuora_api/model/ProductRatePlanChargeTierData.js +11 -1
- package/src/zuora_api/model/ProductRatePlanObjectNSFields.js +11 -1
- package/src/zuora_api/model/ProductRatePlanWithExternalId.js +11 -1
- package/src/zuora_api/model/ProrationOption.js +67 -0
- package/src/zuora_api/model/ProxyActioncreateRequest.js +12 -2
- package/src/zuora_api/model/ProxyActiondeleteRequest.js +12 -2
- package/src/zuora_api/model/ProxyActionqueryMoreRequest.js +12 -2
- package/src/zuora_api/model/ProxyActionqueryMoreRequestConf.js +11 -1
- package/src/zuora_api/model/ProxyActionqueryMoreResponse.js +11 -1
- package/src/zuora_api/model/ProxyActionqueryRequest.js +12 -2
- package/src/zuora_api/model/ProxyActionqueryResponse.js +11 -1
- package/src/zuora_api/model/ProxyActionupdateRequest.js +12 -2
- package/src/zuora_api/model/ProxyBadRequestResponse.js +11 -1
- package/src/zuora_api/model/ProxyBadRequestResponseErrorsInner.js +11 -1
- package/src/zuora_api/model/ProxyCreateOrModifyResponse.js +11 -1
- package/src/zuora_api/model/ProxyCreateTaxationItemRequest.js +12 -2
- package/src/zuora_api/model/ProxyDeleteResponse.js +11 -1
- package/src/zuora_api/model/ProxyGetImport.js +11 -1
- package/src/zuora_api/model/ProxyNoDataResponse.js +11 -1
- package/src/zuora_api/model/ProxyPostImport.js +11 -1
- package/src/zuora_api/model/ProxyUnauthorizedResponse.js +11 -1
- package/src/zuora_api/model/PutAttachmentRequest.js +11 -1
- package/src/zuora_api/model/PutBusinessRegionRequest.js +11 -1
- package/src/zuora_api/model/PutEventTriggerRequest.js +11 -1
- package/src/zuora_api/model/PutEventTriggerRequestEventType.js +11 -1
- package/src/zuora_api/model/PutPublicEmailTemplateRequest.js +11 -5
- package/src/zuora_api/model/PutPublicNotificationDefinitionRequest.js +11 -1
- package/src/zuora_api/model/PutPublicNotificationDefinitionRequestCallout.js +12 -2
- package/src/zuora_api/model/PutPublicNotificationDefinitionRequestFilterRule.js +12 -2
- package/src/zuora_api/model/PutRevproAccCodeResponse.js +11 -1
- package/src/zuora_api/model/PutScheduledEventRequest.js +11 -1
- package/src/zuora_api/model/PutServiceProviderRequest.js +12 -2
- package/src/zuora_api/model/PutTasksRequest.js +11 -1
- package/src/zuora_api/model/QuantityForUsageCharges.js +11 -1
- package/src/zuora_api/model/QueryAccountsResponse.js +22 -12
- package/src/zuora_api/model/QueryAmendmentsResponse.js +22 -12
- package/src/zuora_api/model/QueryBillingRunsResponse.js +22 -12
- package/src/zuora_api/model/QueryContactsResponse.js +22 -12
- package/src/zuora_api/model/QueryCreditMemoApplicationsResponse.js +22 -12
- package/src/zuora_api/model/QueryCreditMemoItemsResponse.js +22 -12
- package/src/zuora_api/model/QueryCreditMemosResponse.js +22 -12
- package/src/zuora_api/model/QueryCustomObjectRecordsResponse.js +12 -2
- package/src/zuora_api/model/QueryCustomObjectsResponse.js +22 -12
- package/src/zuora_api/model/QueryDailyConsumptionSummarysResponse.js +22 -12
- package/src/zuora_api/model/QueryDebitMemoItemsResponse.js +22 -12
- package/src/zuora_api/model/QueryDebitMemosResponse.js +22 -12
- package/src/zuora_api/model/QueryInvoiceItemsResponse.js +22 -12
- package/src/zuora_api/model/QueryInvoicesResponse.js +22 -12
- package/src/zuora_api/model/QueryOrderActionsResponse.js +22 -12
- package/src/zuora_api/model/QueryOrderLineItemsResponse.js +22 -12
- package/src/zuora_api/model/QueryOrderssResponse.js +22 -12
- package/src/zuora_api/model/QueryPaymentApplicationsResponse.js +22 -12
- package/src/zuora_api/model/QueryPaymentMethodSnapshotsResponse.js +22 -12
- package/src/zuora_api/model/QueryPaymentMethodsResponse.js +22 -12
- package/src/zuora_api/model/QueryPaymentRunsResponse.js +22 -12
- package/src/zuora_api/model/QueryPaymentScheduleItemsResponse.js +22 -12
- package/src/zuora_api/model/QueryPaymentSchedulesResponse.js +22 -12
- package/src/zuora_api/model/QueryPaymentsResponse.js +22 -12
- package/src/zuora_api/model/QueryPrepaidBalanceFundsResponse.js +22 -12
- package/src/zuora_api/model/QueryPrepaidBalanceTransactionsResponse.js +22 -12
- package/src/zuora_api/model/QueryPrepaidBalancesResponse.js +22 -12
- package/src/zuora_api/model/QueryProcessedUsagesResponse.js +22 -12
- package/src/zuora_api/model/QueryProductRatePlanChargeTiersResponse.js +22 -12
- package/src/zuora_api/model/QueryProductRatePlanChargesResponse.js +22 -12
- package/src/zuora_api/model/QueryProductRatePlansResponse.js +22 -12
- package/src/zuora_api/model/QueryProductsResponse.js +22 -12
- package/src/zuora_api/model/QueryRatePlanChargeTiersResponse.js +22 -12
- package/src/zuora_api/model/QueryRatePlanChargesResponse.js +22 -12
- package/src/zuora_api/model/QueryRatePlansResponse.js +22 -12
- package/src/zuora_api/model/QueryRatingResultsResponse.js +22 -12
- package/src/zuora_api/model/QueryRefundApplicationItemsResponse.js +22 -12
- package/src/zuora_api/model/QueryRefundApplicationsResponse.js +22 -12
- package/src/zuora_api/model/QueryRefundsResponse.js +22 -12
- package/src/zuora_api/model/QuerySubscriptionsResponse.js +22 -12
- package/src/zuora_api/model/QueryTaxationItemsResponse.js +22 -12
- package/src/zuora_api/model/QueryUsagesResponse.js +22 -12
- package/src/zuora_api/model/QueryValidityPeriodSummarysResponse.js +22 -12
- package/src/zuora_api/model/QuoteObjectFields.js +11 -1
- package/src/zuora_api/model/RSASignatureResponse.js +11 -1
- package/src/zuora_api/model/RampChargeRequest.js +11 -1
- package/src/zuora_api/model/RampChargeResponse.js +11 -1
- package/src/zuora_api/model/RampIntervalChargeDeltaMetrics.js +11 -1
- package/src/zuora_api/model/RampIntervalChargeDeltaMetricsDeltaMrrInner.js +11 -1
- package/src/zuora_api/model/RampIntervalChargeDeltaMetricsDeltaQuantityInner.js +11 -1
- package/src/zuora_api/model/RampIntervalChargeMetrics.js +11 -1
- package/src/zuora_api/model/RampIntervalChargeMetricsMrrInner.js +11 -1
- package/src/zuora_api/model/RampIntervalMetrics.js +11 -1
- package/src/zuora_api/model/RampIntervalRequest.js +12 -2
- package/src/zuora_api/model/RampIntervalResponse.js +11 -1
- package/src/zuora_api/model/RampMetrics.js +11 -1
- package/src/zuora_api/model/RampResponse.js +11 -1
- package/src/zuora_api/model/RatePlan.js +11 -1
- package/src/zuora_api/model/RatePlanChangeLog.js +139 -0
- package/src/zuora_api/model/RatePlanChargeChangeLog.js +158 -0
- package/src/zuora_api/model/RatePlanChargeObjectCustomFields.js +11 -1
- package/src/zuora_api/model/RatePlanChargeOverridePricing.js +11 -1
- package/src/zuora_api/model/RatePlanChargeSegment.js +71 -1
- package/src/zuora_api/model/RatePlanChargeSegmentInfo.js +55 -1
- package/src/zuora_api/model/RatePlanChargeTier.js +11 -1
- package/src/zuora_api/model/RatePlanFeatureOverride.js +11 -1
- package/src/zuora_api/model/RatePlanObjectCustomFields.js +11 -1
- package/src/zuora_api/model/RatePlanOverride.js +13 -3
- package/src/zuora_api/model/RatePlanUpdate.js +11 -1
- package/src/zuora_api/model/RatingGroupsOperatorType.js +46 -0
- package/src/zuora_api/model/RatingPropertiesOverride.js +121 -0
- package/src/zuora_api/model/ReconcileRefundRequest.js +11 -1
- package/src/zuora_api/model/RecurringDeliveryPricingOverride.js +11 -5
- package/src/zuora_api/model/RecurringDeliveryPricingUpdate.js +11 -5
- package/src/zuora_api/model/RecurringFlatFeePricingOverride.js +11 -5
- package/src/zuora_api/model/RecurringFlatFeePricingUpdate.js +11 -5
- package/src/zuora_api/model/RecurringPerUnitPricingOverride.js +11 -5
- package/src/zuora_api/model/RecurringPerUnitPricingUpdate.js +11 -5
- package/src/zuora_api/model/RecurringTieredPricingOverride.js +11 -5
- package/src/zuora_api/model/RecurringTieredPricingUpdate.js +11 -5
- package/src/zuora_api/model/RecurringVolumePricingOverride.js +11 -5
- package/src/zuora_api/model/RecurringVolumePricingUpdate.js +11 -5
- package/src/zuora_api/model/Refund.js +11 -1
- package/src/zuora_api/model/RefundCreditMemoItemRequest.js +12 -2
- package/src/zuora_api/model/RefundCreditMemoRequest.js +12 -2
- package/src/zuora_api/model/RefundCreditMemoResponse.js +11 -1
- package/src/zuora_api/model/RefundEntityPrefix.js +11 -1
- package/src/zuora_api/model/RefundItemPart.js +11 -1
- package/src/zuora_api/model/RefundObjectCustomFields.js +11 -1
- package/src/zuora_api/model/RefundObjectNSFields.js +11 -1
- package/src/zuora_api/model/RefundPart.js +11 -1
- package/src/zuora_api/model/RefundRequestFinanceInformation.js +11 -1
- package/src/zuora_api/model/RefundResponse.js +11 -1
- package/src/zuora_api/model/RegenerateBillingRequest.js +11 -1
- package/src/zuora_api/model/RegenerateBookingRequest.js +11 -1
- package/src/zuora_api/model/RegenerateRevRecEventsResponse.js +11 -1
- package/src/zuora_api/model/RegenerateTransactionObjectResponse.js +11 -1
- package/src/zuora_api/model/RejectPaymentRequest.js +11 -1
- package/src/zuora_api/model/RemoveCatalogGroupProductRatePlan.js +11 -1
- package/src/zuora_api/model/RemoveSubscriptionRatePlan.js +12 -2
- package/src/zuora_api/model/RenewSubscriptionRequest.js +11 -1
- package/src/zuora_api/model/RenewSubscriptionResponse.js +11 -1
- package/src/zuora_api/model/RenewalTerm.js +11 -1
- package/src/zuora_api/model/ResendCalloutNotificationsFailedResponse.js +11 -1
- package/src/zuora_api/model/ResendCalloutNotificationsFailedResponseValue.js +11 -1
- package/src/zuora_api/model/ResendEmailNotificationsFailedResponse.js +11 -1
- package/src/zuora_api/model/ResendEmailNotificationsFailedResponseValue.js +11 -1
- package/src/zuora_api/model/ResumeSubscriptionRequest.js +12 -2
- package/src/zuora_api/model/ResumeSubscriptionResponse.js +11 -1
- package/src/zuora_api/model/RetryPaymentScheduleItem.js +11 -1
- package/src/zuora_api/model/RetryPaymentScheduleItemRequest.js +11 -1
- package/src/zuora_api/model/RetryPaymentScheduleItemResponse.js +11 -1
- package/src/zuora_api/model/ReverseCreditMemoRequest.js +37 -1
- package/src/zuora_api/model/ReverseCreditMemoResponse.js +11 -1
- package/src/zuora_api/model/ReverseCreditMemoResponseCreditMemo.js +11 -1
- package/src/zuora_api/model/ReverseCreditMemoResponseDebitMemo.js +11 -1
- package/src/zuora_api/model/ReverseInvoiceRequest.js +37 -1
- package/src/zuora_api/model/ReverseInvoiceResponse.js +11 -1
- package/src/zuora_api/model/ReverseInvoiceResponseCreditMemo.js +11 -1
- package/src/zuora_api/model/ReverseInvoiceResponseDebitMemo.js +11 -1
- package/src/zuora_api/model/ReversePaymentRequest.js +12 -2
- package/src/zuora_api/model/RevertOrderRequest.js +102 -0
- package/src/zuora_api/model/RevertOrderResponse.js +229 -0
- package/src/zuora_api/model/RevproAccountingCodes.js +12 -2
- package/src/zuora_api/model/SaveResult.js +11 -1
- package/src/zuora_api/model/ServiceProvider.js +11 -1
- package/src/zuora_api/model/ServiceProviderResponse.js +11 -1
- package/src/zuora_api/model/SettingComponentKeyValue.js +11 -1
- package/src/zuora_api/model/SettingItemHttpOperation.js +11 -1
- package/src/zuora_api/model/SettingItemHttpRequestParameter.js +11 -1
- package/src/zuora_api/model/SettingItemWithOperationsInformation.js +11 -1
- package/src/zuora_api/model/SettingSourceComponentResponse.js +11 -1
- package/src/zuora_api/model/SettingValueRequest.js +11 -1
- package/src/zuora_api/model/SettingValueResponse.js +11 -1
- package/src/zuora_api/model/SettingValueResponseWrapper.js +11 -1
- package/src/zuora_api/model/SettingsBatchRequest.js +11 -1
- package/src/zuora_api/model/SettingsBatchResponse.js +11 -1
- package/src/zuora_api/model/SettlePaymentRequest.js +11 -1
- package/src/zuora_api/model/SignUpCreatePMPayPalECPayPalNativeEC.js +11 -1
- package/src/zuora_api/model/SignUpCreatePaymentMethodCardholderInfo.js +12 -2
- package/src/zuora_api/model/SignUpCreatePaymentMethodCommon.js +11 -1
- package/src/zuora_api/model/SignUpCreatePaymentMethodCreditCard.js +11 -1
- package/src/zuora_api/model/SignUpCreatePaymentMethodCreditCardReferenceTransaction.js +11 -1
- package/src/zuora_api/model/SignUpCreatePaymentMethodPayPalAdaptive.js +11 -1
- package/src/zuora_api/model/SignUpPaymentMethod.js +12 -2
- package/src/zuora_api/model/SignUpPaymentMethodObjectCustomFields.js +11 -1
- package/src/zuora_api/model/SignUpRequest.js +11 -1
- package/src/zuora_api/model/SignUpResponse.js +11 -1
- package/src/zuora_api/model/SignUpResponseReasons.js +11 -1
- package/src/zuora_api/model/SignUpTaxInfo.js +11 -5
- package/src/zuora_api/model/StoredCredentialProfileResponse.js +11 -1
- package/src/zuora_api/model/StoredCredentialProfilesResponse.js +11 -1
- package/src/zuora_api/model/SubmitDataQueryRequest.js +12 -2
- package/src/zuora_api/model/SubmitDataQueryRequestOutput.js +12 -2
- package/src/zuora_api/model/SubmitDataQueryResponse.js +11 -1
- package/src/zuora_api/model/SubscribeToProduct.js +14 -4
- package/src/zuora_api/model/SubscriptionChangeLog.js +295 -0
- package/src/zuora_api/model/SubscriptionCreditMemo.js +11 -1
- package/src/zuora_api/model/SubscriptionCreditMemoItem.js +11 -1
- package/src/zuora_api/model/SubscriptionData.js +11 -1
- package/src/zuora_api/model/SubscriptionMetrics.js +29 -1
- package/src/zuora_api/model/SubscriptionObjectNSFields.js +11 -1
- package/src/zuora_api/model/SubscriptionObjectQTFields.js +11 -1
- package/src/zuora_api/model/SubscriptionProductFeature.js +11 -1
- package/src/zuora_api/model/SubscriptionRatePlan.js +11 -1
- package/src/zuora_api/model/SubscriptionStatusHistory.js +11 -1
- package/src/zuora_api/model/SubscriptionTaxationItem.js +11 -1
- package/src/zuora_api/model/SuspendSubscriptionRequest.js +12 -2
- package/src/zuora_api/model/SuspendSubscriptionResponse.js +11 -1
- package/src/zuora_api/model/SystemHealthErrorResponse.js +11 -1
- package/src/zuora_api/model/Task.js +12 -2
- package/src/zuora_api/model/TasksResponse.js +11 -1
- package/src/zuora_api/model/TasksResponsePagination.js +11 -1
- package/src/zuora_api/model/TaxInfo.js +11 -5
- package/src/zuora_api/model/TaxItemsFinanceInformation.js +11 -1
- package/src/zuora_api/model/TaxationItem.js +11 -1
- package/src/zuora_api/model/TaxationItemFinanceInformation.js +11 -1
- package/src/zuora_api/model/TaxationItemsData.js +11 -1
- package/src/zuora_api/model/TaxationItemsDataResponse.js +11 -1
- package/src/zuora_api/model/TemplateDetailResponse.js +11 -1
- package/src/zuora_api/model/TemplateMigrationClientRequest.js +12 -2
- package/src/zuora_api/model/TemplateResponse.js +11 -1
- package/src/zuora_api/model/TermInfo.js +12 -2
- package/src/zuora_api/model/Tier.js +12 -2
- package/src/zuora_api/model/TimeSlicedElpNetMetrics.js +11 -1
- package/src/zuora_api/model/TimeSlicedMetrics.js +11 -1
- package/src/zuora_api/model/TimeSlicedNetMetrics.js +11 -1
- package/src/zuora_api/model/TimeSlicedTcbNetMetrics.js +11 -1
- package/src/zuora_api/model/TokenResponse.js +11 -1
- package/src/zuora_api/model/TransferPayment.js +11 -1
- package/src/zuora_api/model/TriggerDate.js +11 -1
- package/src/zuora_api/model/TriggerParams.js +11 -1
- package/src/zuora_api/model/UnapplyCreditMemoItemToDebitMemoItem.js +12 -2
- package/src/zuora_api/model/UnapplyCreditMemoItemToInvoiceItem.js +12 -2
- package/src/zuora_api/model/UnapplyCreditMemoRequest.js +11 -1
- package/src/zuora_api/model/UnapplyCreditMemoToDebitMemo.js +12 -2
- package/src/zuora_api/model/UnapplyCreditMemoToInvoice.js +12 -2
- package/src/zuora_api/model/UnapplyPaymentDebitMemoApplication.js +12 -2
- package/src/zuora_api/model/UnapplyPaymentDebitMemoApplicationItem.js +12 -2
- package/src/zuora_api/model/UnapplyPaymentInvoiceApplication.js +12 -2
- package/src/zuora_api/model/UnapplyPaymentInvoiceApplicationItem.js +12 -2
- package/src/zuora_api/model/UnapplyPaymentRequest.js +11 -1
- package/src/zuora_api/model/UpdateAccountContact.js +13 -3
- package/src/zuora_api/model/UpdateAccountRequest.js +58 -1
- package/src/zuora_api/model/UpdateAccountingCodeRequest.js +11 -1
- package/src/zuora_api/model/UpdateAccountingPeriodRequest.js +11 -1
- package/src/zuora_api/model/UpdateBasicSummaryJournalEntryRequest.js +11 -1
- package/src/zuora_api/model/UpdateCatalogGroupRequest.js +11 -1
- package/src/zuora_api/model/UpdateContactRequest.js +38 -1
- package/src/zuora_api/model/UpdateCreditMemoItem.js +34 -2
- package/src/zuora_api/model/UpdateCreditMemoRequest.js +11 -1
- package/src/zuora_api/model/UpdateCreditMemoTaxItemFinanceInformation.js +11 -1
- package/src/zuora_api/model/UpdateCreditMemoTaxItemRequest.js +12 -2
- package/src/zuora_api/model/UpdateCreditMemoWithId.js +11 -1
- package/src/zuora_api/model/UpdateCustomObjectCusotmField.js +11 -1
- package/src/zuora_api/model/UpdateDebitMemoItem.js +34 -2
- package/src/zuora_api/model/UpdateDebitMemoRequest.js +11 -1
- package/src/zuora_api/model/UpdateDebitMemoTaxItemFinanceInformation.js +11 -1
- package/src/zuora_api/model/UpdateDebitMemoTaxItemRequest.js +12 -2
- package/src/zuora_api/model/UpdateDebitMemoWithId.js +11 -1
- package/src/zuora_api/model/UpdateDebitMemosDueDatesRequest.js +11 -1
- package/src/zuora_api/model/UpdateDiscountInvoiceItem.js +52 -2
- package/src/zuora_api/model/UpdateFulfillmentItemRequest.js +11 -1
- package/src/zuora_api/model/UpdateFulfillmentRequest.js +12 -2
- package/src/zuora_api/model/UpdateInvoiceItem.js +60 -1
- package/src/zuora_api/model/UpdateInvoiceRequest.js +11 -1
- package/src/zuora_api/model/UpdateInvoiceResponse.js +11 -1
- package/src/zuora_api/model/UpdateInvoiceScheduleItem.js +11 -1
- package/src/zuora_api/model/UpdateInvoiceScheduleRequest.js +11 -1
- package/src/zuora_api/model/UpdateJournalEntryItemRequest.js +12 -2
- package/src/zuora_api/model/UpdateOpenPaymentMethodTypeRequest.js +12 -2
- package/src/zuora_api/model/UpdateOrderAction.js +11 -1
- package/src/zuora_api/model/UpdateOrderActionChargeTriggerDate.js +11 -1
- package/src/zuora_api/model/UpdateOrderActionRequest.js +11 -1
- package/src/zuora_api/model/UpdateOrderActionTriggerDate.js +11 -1
- package/src/zuora_api/model/UpdateOrderActionTriggerDates.js +12 -2
- package/src/zuora_api/model/UpdateOrderActionTriggerDatesRequest.js +12 -2
- package/src/zuora_api/model/UpdateOrderCustomFieldsRequest.js +11 -1
- package/src/zuora_api/model/UpdateOrderLineItem.js +53 -24
- package/src/zuora_api/model/UpdateOrderLineItemRequest.js +71 -27
- package/src/zuora_api/model/UpdateOrderRequest.js +12 -6
- package/src/zuora_api/model/UpdateOrderSubscriptionsCustomFields.js +11 -1
- package/src/zuora_api/model/UpdateOrderSubscriptionsOrderActionsCustomFields.js +11 -1
- package/src/zuora_api/model/UpdateOrderTriggerDateResponse.js +11 -1
- package/src/zuora_api/model/UpdateOrderTriggerDatesRequest.js +11 -1
- package/src/zuora_api/model/UpdateOrderTriggerDatesResponse.js +11 -1
- package/src/zuora_api/model/UpdatePaymentMethodRequest.js +11 -1
- package/src/zuora_api/model/UpdatePaymentMethodRequestCreditCardInfo.js +11 -1
- package/src/zuora_api/model/UpdatePaymentMethodResponse.js +11 -1
- package/src/zuora_api/model/UpdatePaymentRequest.js +11 -1
- package/src/zuora_api/model/UpdatePaymentRunRequest.js +11 -1
- package/src/zuora_api/model/UpdatePaymentScheduleItemRequest.js +11 -1
- package/src/zuora_api/model/UpdatePaymentScheduleRequest.js +11 -1
- package/src/zuora_api/model/UpdateProductRatePlanChargeRequest.js +12 -2
- package/src/zuora_api/model/UpdateProductRatePlanChargeTierRequest.js +11 -1
- package/src/zuora_api/model/UpdateProductRatePlanRequest.js +11 -1
- package/src/zuora_api/model/UpdateProductRequest.js +11 -1
- package/src/zuora_api/model/UpdateRatePlanCharge.js +12 -2
- package/src/zuora_api/model/UpdateRefundRequest.js +11 -1
- package/src/zuora_api/model/UpdateSequenceSetRequest.js +11 -1
- package/src/zuora_api/model/UpdateSequenceSetResponse.js +11 -1
- package/src/zuora_api/model/UpdateSubscriptionChargeCustomFields.js +11 -1
- package/src/zuora_api/model/UpdateSubscriptionChargeCustomFieldsOfASpecifiedVersion.js +11 -1
- package/src/zuora_api/model/UpdateSubscriptionCustomFieldsOfASpecifiedVersionRequest.js +11 -1
- package/src/zuora_api/model/UpdateSubscriptionCustomFieldsRequest.js +11 -1
- package/src/zuora_api/model/UpdateSubscriptionRatePlan.js +12 -2
- package/src/zuora_api/model/UpdateSubscriptionRatePlanCustomFields.js +11 -1
- package/src/zuora_api/model/UpdateSubscriptionRatePlanCustomFieldsOfASpecifiedVersion.js +12 -2
- package/src/zuora_api/model/UpdateSubscriptionRequest.js +11 -1
- package/src/zuora_api/model/UpdateSubscriptionResponse.js +11 -1
- package/src/zuora_api/model/UpdateTask.js +12 -2
- package/src/zuora_api/model/UpdateTaxationItemForFinanceInformation.js +11 -1
- package/src/zuora_api/model/UpdateTaxationItemRequest.js +11 -1
- package/src/zuora_api/model/UpdateUsageRequest.js +11 -1
- package/src/zuora_api/model/UpdaterPaymentMethodRequestAccountHolderInfo.js +11 -1
- package/src/zuora_api/model/UploadFileForCreditMemoRequest.js +11 -1
- package/src/zuora_api/model/UploadFileForDebitMemoRequest.js +11 -1
- package/src/zuora_api/model/UploadFileForInvoiceRequest.js +11 -1
- package/src/zuora_api/model/UploadFileResponse.js +11 -1
- package/src/zuora_api/model/UploadUsageFileRequest.js +12 -2
- package/src/zuora_api/model/UploadUsageFileResponse.js +11 -1
- package/src/zuora_api/model/Usage.js +11 -1
- package/src/zuora_api/model/UsageFlatFeePricingOverride.js +11 -5
- package/src/zuora_api/model/UsageFlatFeePricingUpdate.js +11 -5
- package/src/zuora_api/model/UsageItem.js +24 -1
- package/src/zuora_api/model/UsageOveragePricingOverride.js +11 -5
- package/src/zuora_api/model/UsageOveragePricingUpdate.js +11 -5
- package/src/zuora_api/model/UsagePerUnitPricingOverride.js +11 -5
- package/src/zuora_api/model/UsagePerUnitPricingUpdate.js +11 -5
- package/src/zuora_api/model/UsageTieredPricingOverride.js +11 -5
- package/src/zuora_api/model/UsageTieredPricingUpdate.js +11 -5
- package/src/zuora_api/model/UsageTieredWithOveragePricingOverride.js +11 -5
- package/src/zuora_api/model/UsageTieredWithOveragePricingUpdate.js +11 -5
- package/src/zuora_api/model/UsageValues.js +11 -1
- package/src/zuora_api/model/UsageVolumePricingOverride.js +11 -5
- package/src/zuora_api/model/UsageVolumePricingUpdate.js +11 -5
- package/src/zuora_api/model/UsagesResponse.js +11 -1
- package/src/zuora_api/model/ValidationErrors.js +11 -1
- package/src/zuora_api/model/ValidationReasons.js +11 -1
- package/src/zuora_api/model/VerifyPaymentMethodRequest.js +11 -1
- package/src/zuora_api/model/VerifyPaymentMethodResponse.js +11 -1
- package/src/zuora_api/model/Workflow.js +11 -1
- package/src/zuora_api/model/WorkflowDefinition.js +11 -1
- package/src/zuora_api/model/WorkflowDefinitionActiveVersion.js +11 -1
- package/src/zuora_api/model/WorkflowDefinitionAndVersions.js +11 -1
- package/src/zuora_api/model/WorkflowError.js +11 -1
- package/src/zuora_api/model/WorkflowInstance.js +11 -1
- package/src/zuora_api/model/WriteOffBehavior.js +11 -1
- package/src/zuora_api/model/WriteOffBehaviorFinanceInformation.js +11 -1
- package/src/zuora_api/model/WriteOffCreditMemoRequest.js +11 -1
- package/src/zuora_api/model/WriteOffCreditMemoResponse.js +11 -1
- package/src/zuora_api/model/WriteOffCreditMemoResponseDebitMemo.js +11 -1
- package/src/zuora_api/model/WriteOffDebitMemoRequest.js +292 -0
- package/src/zuora_api/model/WriteOffDebitMemoResponse.js +175 -0
- package/src/zuora_api/model/WriteOffInvoiceRequest.js +65 -1
- package/src/zuora_api/model/WriteOffInvoiceResponse.js +11 -1
- package/src/zuora_api/model/WriteOffInvoiceResponseCreditMemo.js +11 -1
- package/src/zuora_api/model/ZObject.js +11 -1
- package/src/zuora_api/model/ZObjectUpdate.js +12 -2
- package/dist/zuora_api/api/AuthenticationApi.js +0 -146
- package/dist/zuora_api/api/MappingApi.js +0 -92
- package/dist/zuora_api/api/ReportsApi.js +0 -238
- package/dist/zuora_api/api/SignedUrlApi.js +0 -92
- package/dist/zuora_api/api/StageErrorApi.js +0 -92
- package/dist/zuora_api/api/UploadApi.js +0 -307
- package/src/zuora_api/api/AuthenticationApi.js +0 -153
- package/src/zuora_api/api/MappingApi.js +0 -91
- package/src/zuora_api/api/ReportsApi.js +0 -255
- package/src/zuora_api/api/SignedUrlApi.js +0 -91
- package/src/zuora_api/api/StageErrorApi.js +0 -91
- package/src/zuora_api/api/UploadApi.js +0 -330
|
@@ -9,10 +9,10 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*
|
|
12
|
-
|
|
12
|
+
*//**
|
|
13
13
|
* ObjectQueries service.
|
|
14
14
|
* @module api/ObjectQueriesApi
|
|
15
|
-
* @version 3.0.0
|
|
15
|
+
* @version 3.2.0-beta.0
|
|
16
16
|
*/var ObjectQueriesApi=exports["default"]=/*#__PURE__*/function(){/**
|
|
17
17
|
* Constructs a new ObjectQueriesApi.
|
|
18
18
|
* @alias module:api/ObjectQueriesApi
|
|
@@ -30,7 +30,6 @@
|
|
|
30
30
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
31
31
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
32
32
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
33
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
34
33
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
35
34
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
36
35
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -38,7 +37,7 @@
|
|
|
38
37
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
39
38
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedAccount} and HTTP response
|
|
40
39
|
*/return _createClass(ObjectQueriesApi,[{key:"queryAccountByKeyWithHttpInfo",value:function queryAccountByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
41
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryAccountByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
40
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryAccountByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedAccount["default"];return this.apiClient.callApi('/object-query/accounts/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
42
41
|
* Query Account by key with filters, expands, sort capabilities. Supported expands: billto,soldto,defaultpaymentmethod,subscriptions,payments,refunds,creditmemos,debitmemos,invoices,usages,paymentmethods,subscriptions.rateplans,subscriptions.rateplans.rateplancharges.
|
|
43
42
|
* @param {String} key Object ID or Number.
|
|
44
43
|
* @param {Object} opts Optional parameters
|
|
@@ -49,7 +48,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
49
48
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
50
49
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
51
50
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
52
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
53
51
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
54
52
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
55
53
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -66,14 +64,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
66
64
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
67
65
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
68
66
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
69
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
70
67
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
71
68
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
72
69
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
73
70
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
74
71
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
75
72
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryAccountsResponse} and HTTP response
|
|
76
|
-
*/},{key:"queryAccountsWithHttpInfo",value:function queryAccountsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
73
|
+
*/},{key:"queryAccountsWithHttpInfo",value:function queryAccountsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryAccountsResponse["default"];return this.apiClient.callApi('/object-query/accounts','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
77
74
|
* Query Accounts with filters, expands, sort capabilities. Supported expands: billto,soldto,defaultpaymentmethod,subscriptions,payments,refunds,creditmemos,debitmemos,invoices,usages,paymentmethods,subscriptions.rateplans,subscriptions.rateplans.rateplancharges.
|
|
78
75
|
* @param {Object} opts Optional parameters
|
|
79
76
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -83,7 +80,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
83
80
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
84
81
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
85
82
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
86
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
87
83
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
88
84
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
89
85
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -101,7 +97,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
101
97
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
102
98
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
103
99
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
104
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
105
100
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
106
101
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
107
102
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -109,7 +104,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
109
104
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
110
105
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedAmendment} and HTTP response
|
|
111
106
|
*/},{key:"queryAmendmentByKeyWithHttpInfo",value:function queryAmendmentByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
112
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryAmendmentByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
107
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryAmendmentByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedAmendment["default"];return this.apiClient.callApi('/object-query/amendments/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
113
108
|
* Query Amendment by key with filters, expands, sort capabilities. Supported expands: N/A.
|
|
114
109
|
* @param {String} key Object ID or Number.
|
|
115
110
|
* @param {Object} opts Optional parameters
|
|
@@ -120,7 +115,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
120
115
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
121
116
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
122
117
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
123
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
124
118
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
125
119
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
126
120
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -137,14 +131,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
137
131
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
138
132
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
139
133
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
140
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
141
134
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
142
135
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
143
136
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
144
137
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
145
138
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
146
139
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryAmendmentsResponse} and HTTP response
|
|
147
|
-
*/},{key:"queryAmendmentsWithHttpInfo",value:function queryAmendmentsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
140
|
+
*/},{key:"queryAmendmentsWithHttpInfo",value:function queryAmendmentsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryAmendmentsResponse["default"];return this.apiClient.callApi('/object-query/amendments','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
148
141
|
* Query Amendments with filters, expands, sort capabilities. Supported expands: N/A.
|
|
149
142
|
* @param {Object} opts Optional parameters
|
|
150
143
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -154,7 +147,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
154
147
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
155
148
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
156
149
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
157
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
158
150
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
159
151
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
160
152
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -172,7 +164,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
172
164
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
173
165
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
174
166
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
175
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
176
167
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
177
168
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
178
169
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -180,7 +171,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
180
171
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
181
172
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedBillingRun} and HTTP response
|
|
182
173
|
*/},{key:"queryBillingRunByKeyWithHttpInfo",value:function queryBillingRunByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
183
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryBillingRunByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
174
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryBillingRunByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedBillingRun["default"];return this.apiClient.callApi('/object-query/billing-runs/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
184
175
|
* Query BillingRun by key with filters, expands, sort capabilities. Supported expands: N/A.
|
|
185
176
|
* @param {String} key Object ID or Number.
|
|
186
177
|
* @param {Object} opts Optional parameters
|
|
@@ -191,7 +182,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
191
182
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
192
183
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
193
184
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
194
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
195
185
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
196
186
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
197
187
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -208,14 +198,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
208
198
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
209
199
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
210
200
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
211
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
212
201
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
213
202
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
214
203
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
215
204
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
216
205
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
217
206
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryBillingRunsResponse} and HTTP response
|
|
218
|
-
*/},{key:"queryBillingRunsWithHttpInfo",value:function queryBillingRunsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
207
|
+
*/},{key:"queryBillingRunsWithHttpInfo",value:function queryBillingRunsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryBillingRunsResponse["default"];return this.apiClient.callApi('/object-query/billing-runs','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
219
208
|
* Query BillingRuns with filters, expands, sort capabilities. Supported expands: N/A.
|
|
220
209
|
* @param {Object} opts Optional parameters
|
|
221
210
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -225,7 +214,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
225
214
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
226
215
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
227
216
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
228
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
229
217
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
230
218
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
231
219
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -243,7 +231,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
243
231
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
244
232
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
245
233
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
246
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
247
234
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
248
235
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
249
236
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -251,7 +238,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
251
238
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
252
239
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedContact} and HTTP response
|
|
253
240
|
*/},{key:"queryContactByKeyWithHttpInfo",value:function queryContactByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
254
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryContactByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
241
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryContactByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedContact["default"];return this.apiClient.callApi('/object-query/contacts/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
255
242
|
* Query Contact by key with filters, expands, sort capabilities. Supported expands: N/A.
|
|
256
243
|
* @param {String} key Object ID or Number.
|
|
257
244
|
* @param {Object} opts Optional parameters
|
|
@@ -262,7 +249,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
262
249
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
263
250
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
264
251
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
265
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
266
252
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
267
253
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
268
254
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -279,14 +265,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
279
265
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
280
266
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
281
267
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
282
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
283
268
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
284
269
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
285
270
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
286
271
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
287
272
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
288
273
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryContactsResponse} and HTTP response
|
|
289
|
-
*/},{key:"queryContactsWithHttpInfo",value:function queryContactsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
274
|
+
*/},{key:"queryContactsWithHttpInfo",value:function queryContactsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryContactsResponse["default"];return this.apiClient.callApi('/object-query/contacts','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
290
275
|
* Query Contacts with filters, expands, sort capabilities. Supported expands: N/A.
|
|
291
276
|
* @param {Object} opts Optional parameters
|
|
292
277
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -296,7 +281,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
296
281
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
297
282
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
298
283
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
299
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
300
284
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
301
285
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
302
286
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -314,7 +298,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
314
298
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
315
299
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
316
300
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
317
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
318
301
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
319
302
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
320
303
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -322,7 +305,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
322
305
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
323
306
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedCreditMemoApplication} and HTTP response
|
|
324
307
|
*/},{key:"queryCreditMemoApplicationByKeyWithHttpInfo",value:function queryCreditMemoApplicationByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
325
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryCreditMemoApplicationByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
308
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryCreditMemoApplicationByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedCreditMemoApplication["default"];return this.apiClient.callApi('/object-query/credit-memo-applications/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
326
309
|
* Query CreditMemoApplication by key with filters, expands, sort capabilities. Supported expands: creditmemo.
|
|
327
310
|
* @param {String} key Object ID or Number.
|
|
328
311
|
* @param {Object} opts Optional parameters
|
|
@@ -333,7 +316,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
333
316
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
334
317
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
335
318
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
336
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
337
319
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
338
320
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
339
321
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -350,14 +332,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
350
332
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
351
333
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
352
334
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
353
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
354
335
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
355
336
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
356
337
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
357
338
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
358
339
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
359
340
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryCreditMemoApplicationsResponse} and HTTP response
|
|
360
|
-
*/},{key:"queryCreditMemoApplicationsWithHttpInfo",value:function queryCreditMemoApplicationsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
341
|
+
*/},{key:"queryCreditMemoApplicationsWithHttpInfo",value:function queryCreditMemoApplicationsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryCreditMemoApplicationsResponse["default"];return this.apiClient.callApi('/object-query/credit-memo-applications','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
361
342
|
* Query CreditMemoApplications with filters, expands, sort capabilities. Supported expands: creditmemo.
|
|
362
343
|
* @param {Object} opts Optional parameters
|
|
363
344
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -367,7 +348,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
367
348
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
368
349
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
369
350
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
370
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
371
351
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
372
352
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
373
353
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -385,7 +365,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
385
365
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
386
366
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
387
367
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
388
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
389
368
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
390
369
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
391
370
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -393,7 +372,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
393
372
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
394
373
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedCreditMemo} and HTTP response
|
|
395
374
|
*/},{key:"queryCreditMemoByKeyWithHttpInfo",value:function queryCreditMemoByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
396
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryCreditMemoByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
375
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryCreditMemoByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedCreditMemo["default"];return this.apiClient.callApi('/object-query/credit-memos/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
397
376
|
* Query CreditMemo by key with filters, expands, sort capabilities. Supported expands: account,billtocontact,creditmemoitems,creditmemoitems.subscription,creditmemoitems.subscription.account,creditmemoapplications.
|
|
398
377
|
* @param {String} key Object ID or Number.
|
|
399
378
|
* @param {Object} opts Optional parameters
|
|
@@ -404,7 +383,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
404
383
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
405
384
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
406
385
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
407
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
408
386
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
409
387
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
410
388
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -422,7 +400,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
422
400
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
423
401
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
424
402
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
425
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
426
403
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
427
404
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
428
405
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -430,7 +407,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
430
407
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
431
408
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedCreditMemoItem} and HTTP response
|
|
432
409
|
*/},{key:"queryCreditMemoItemByKeyWithHttpInfo",value:function queryCreditMemoItemByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
433
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryCreditMemoItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
410
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryCreditMemoItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedCreditMemoItem["default"];return this.apiClient.callApi('/object-query/credit-memo-items/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
434
411
|
* Query CreditMemoItem by key with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
|
|
435
412
|
* @param {String} key Object ID or Number.
|
|
436
413
|
* @param {Object} opts Optional parameters
|
|
@@ -441,7 +418,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
441
418
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
442
419
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
443
420
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
444
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
445
421
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
446
422
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
447
423
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -458,14 +434,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
458
434
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
459
435
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
460
436
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
461
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
462
437
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
463
438
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
464
439
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
465
440
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
466
441
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
467
442
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryCreditMemoItemsResponse} and HTTP response
|
|
468
|
-
*/},{key:"queryCreditMemoItemsWithHttpInfo",value:function queryCreditMemoItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
443
|
+
*/},{key:"queryCreditMemoItemsWithHttpInfo",value:function queryCreditMemoItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryCreditMemoItemsResponse["default"];return this.apiClient.callApi('/object-query/credit-memo-items','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
469
444
|
* Query CreditMemoItems with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
|
|
470
445
|
* @param {Object} opts Optional parameters
|
|
471
446
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -475,7 +450,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
475
450
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
476
451
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
477
452
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
478
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
479
453
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
480
454
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
481
455
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -492,14 +466,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
492
466
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
493
467
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
494
468
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
495
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
496
469
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
497
470
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
498
471
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
499
472
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
500
473
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
501
474
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryCreditMemosResponse} and HTTP response
|
|
502
|
-
*/},{key:"queryCreditMemosWithHttpInfo",value:function queryCreditMemosWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
475
|
+
*/},{key:"queryCreditMemosWithHttpInfo",value:function queryCreditMemosWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryCreditMemosResponse["default"];return this.apiClient.callApi('/object-query/credit-memos','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
503
476
|
* Query CreditMemos with filters, expands, sort capabilities. Supported expands: account,billtocontact,creditmemoitems,creditmemoitems.subscription,creditmemoitems.subscription.account,creditmemoapplications.
|
|
504
477
|
* @param {Object} opts Optional parameters
|
|
505
478
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -509,7 +482,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
509
482
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
510
483
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
511
484
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
512
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
513
485
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
514
486
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
515
487
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -528,7 +500,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
528
500
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
529
501
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
530
502
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
531
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
532
503
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
533
504
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
534
505
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -537,7 +508,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
537
508
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object.<String, {String: Object}>} and HTTP response
|
|
538
509
|
*/},{key:"queryCustomObjectBykeyWithHttpInfo",value:function queryCustomObjectBykeyWithHttpInfo(custom_object_name,key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'custom_object_name' is set
|
|
539
510
|
if(custom_object_name===undefined||custom_object_name===null){throw new Error("Missing the required parameter 'custom_object_name' when calling queryCustomObjectBykey");}// verify the required parameter 'key' is set
|
|
540
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryCustomObjectBykey");}var pathParams={'custom-object-name':custom_object_name,'key':key};var queryParams={'page_size':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
511
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryCustomObjectBykey");}var pathParams={'custom-object-name':custom_object_name,'key':key};var queryParams={'page_size':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType={'String':Object};return this.apiClient.callApi('/object-query/{custom-object-name}/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
541
512
|
* Query Custom Object by key with filters, expands, sort capabilities. Custom Object name is {namespace}__{objectname}s, e.g. default__cars
|
|
542
513
|
* @param {String} custom_object_name Custom Object Name with NameSpace, e.g. default__cars
|
|
543
514
|
* @param {String} key Object ID.
|
|
@@ -549,7 +520,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
549
520
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
550
521
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
551
522
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
552
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
553
523
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
554
524
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
555
525
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -567,7 +537,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
567
537
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
568
538
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
569
539
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
570
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
571
540
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
572
541
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
573
542
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -575,7 +544,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
575
544
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
576
545
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryCustomObjectsResponse} and HTTP response
|
|
577
546
|
*/},{key:"queryCustomObjectsWithHttpInfo",value:function queryCustomObjectsWithHttpInfo(custom_object_name,opts){opts=opts||{};var postBody=null;// verify the required parameter 'custom_object_name' is set
|
|
578
|
-
if(custom_object_name===undefined||custom_object_name===null){throw new Error("Missing the required parameter 'custom_object_name' when calling queryCustomObjects");}var pathParams={'custom-object-name':custom_object_name};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
547
|
+
if(custom_object_name===undefined||custom_object_name===null){throw new Error("Missing the required parameter 'custom_object_name' when calling queryCustomObjects");}var pathParams={'custom-object-name':custom_object_name};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryCustomObjectsResponse["default"];return this.apiClient.callApi('/object-query/{custom-object-name}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
579
548
|
* Query Custom Objects with filters, expands, sort capabilities. Custom Object name is {namespace}__{objectname}s, e.g. default_cars
|
|
580
549
|
* @param {String} custom_object_name Custom Object Name with NameSpace, e.g. default__cars
|
|
581
550
|
* @param {Object} opts Optional parameters
|
|
@@ -586,7 +555,6 @@ if(custom_object_name===undefined||custom_object_name===null){throw new Error("M
|
|
|
586
555
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
587
556
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
588
557
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
589
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
590
558
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
591
559
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
592
560
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -604,7 +572,6 @@ if(custom_object_name===undefined||custom_object_name===null){throw new Error("M
|
|
|
604
572
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
605
573
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
606
574
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
607
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
608
575
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
609
576
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
610
577
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -612,7 +579,7 @@ if(custom_object_name===undefined||custom_object_name===null){throw new Error("M
|
|
|
612
579
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
613
580
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedDailyConsumptionSummary} and HTTP response
|
|
614
581
|
*/},{key:"queryDailyConsumptionSummaryByKeyWithHttpInfo",value:function queryDailyConsumptionSummaryByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
615
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryDailyConsumptionSummaryByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
582
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryDailyConsumptionSummaryByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedDailyConsumptionSummary["default"];return this.apiClient.callApi('/object-query/daily-consumption-summaries/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
616
583
|
* Query DailyConsumptionSummary by key with filters, expands, sort capabilities. Supported expands: N/A.
|
|
617
584
|
* @param {String} key Object ID or Number.
|
|
618
585
|
* @param {Object} opts Optional parameters
|
|
@@ -623,7 +590,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
623
590
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
624
591
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
625
592
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
626
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
627
593
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
628
594
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
629
595
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -640,14 +606,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
640
606
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
641
607
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
642
608
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
643
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
644
609
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
645
610
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
646
611
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
647
612
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
648
613
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
649
614
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryDailyConsumptionSummarysResponse} and HTTP response
|
|
650
|
-
*/},{key:"queryDailyConsumptionSummarysWithHttpInfo",value:function queryDailyConsumptionSummarysWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
615
|
+
*/},{key:"queryDailyConsumptionSummarysWithHttpInfo",value:function queryDailyConsumptionSummarysWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryDailyConsumptionSummarysResponse["default"];return this.apiClient.callApi('/object-query/daily-consumption-summaries','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
651
616
|
* Query DailyConsumptionSummarys with filters, expands, sort capabilities. Supported expands: N/A.
|
|
652
617
|
* @param {Object} opts Optional parameters
|
|
653
618
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -657,7 +622,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
657
622
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
658
623
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
659
624
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
660
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
661
625
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
662
626
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
663
627
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -675,7 +639,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
675
639
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
676
640
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
677
641
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
678
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
679
642
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
680
643
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
681
644
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -683,7 +646,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
683
646
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
684
647
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedDebitMemo} and HTTP response
|
|
685
648
|
*/},{key:"queryDebitMemoByKeyWithHttpInfo",value:function queryDebitMemoByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
686
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryDebitMemoByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
649
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryDebitMemoByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedDebitMemo["default"];return this.apiClient.callApi('/object-query/debit-memos/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
687
650
|
* Query DebitMemo by key with filters, expands, sort capabilities. Supported expands: account,billtocontact,debitmemoitems,debitmemoitems.subscription,debitmemoitems.subscription.account.
|
|
688
651
|
* @param {String} key Object ID or Number.
|
|
689
652
|
* @param {Object} opts Optional parameters
|
|
@@ -694,7 +657,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
694
657
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
695
658
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
696
659
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
697
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
698
660
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
699
661
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
700
662
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -712,7 +674,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
712
674
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
713
675
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
714
676
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
715
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
716
677
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
717
678
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
718
679
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -720,7 +681,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
720
681
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
721
682
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedDebitMemoItem} and HTTP response
|
|
722
683
|
*/},{key:"queryDebitMemoItemByKeyWithHttpInfo",value:function queryDebitMemoItemByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
723
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryDebitMemoItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
684
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryDebitMemoItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedDebitMemoItem["default"];return this.apiClient.callApi('/object-query/debit-memo-items/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
724
685
|
* Query DebitMemoItem by key with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
|
|
725
686
|
* @param {String} key Object ID or Number.
|
|
726
687
|
* @param {Object} opts Optional parameters
|
|
@@ -731,7 +692,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
731
692
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
732
693
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
733
694
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
734
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
735
695
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
736
696
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
737
697
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -748,14 +708,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
748
708
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
749
709
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
750
710
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
751
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
752
711
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
753
712
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
754
713
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
755
714
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
756
715
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
757
716
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryDebitMemoItemsResponse} and HTTP response
|
|
758
|
-
*/},{key:"queryDebitMemoItemsWithHttpInfo",value:function queryDebitMemoItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
717
|
+
*/},{key:"queryDebitMemoItemsWithHttpInfo",value:function queryDebitMemoItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryDebitMemoItemsResponse["default"];return this.apiClient.callApi('/object-query/debit-memo-items','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
759
718
|
* Query DebitMemoItems with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
|
|
760
719
|
* @param {Object} opts Optional parameters
|
|
761
720
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -765,7 +724,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
765
724
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
766
725
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
767
726
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
768
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
769
727
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
770
728
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
771
729
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -782,14 +740,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
782
740
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
783
741
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
784
742
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
785
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
786
743
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
787
744
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
788
745
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
789
746
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
790
747
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
791
748
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryDebitMemosResponse} and HTTP response
|
|
792
|
-
*/},{key:"queryDebitMemosWithHttpInfo",value:function queryDebitMemosWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
749
|
+
*/},{key:"queryDebitMemosWithHttpInfo",value:function queryDebitMemosWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryDebitMemosResponse["default"];return this.apiClient.callApi('/object-query/debit-memos','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
793
750
|
* Query DebitMemos with filters, expands, sort capabilities. Supported expands: account,billtocontact,debitmemoitems,debitmemoitems.subscription,debitmemoitems.subscription.account.
|
|
794
751
|
* @param {Object} opts Optional parameters
|
|
795
752
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -799,7 +756,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
799
756
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
800
757
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
801
758
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
802
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
803
759
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
804
760
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
805
761
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -817,7 +773,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
817
773
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
818
774
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
819
775
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
820
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
821
776
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
822
777
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
823
778
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -825,7 +780,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
825
780
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
826
781
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedInvoice} and HTTP response
|
|
827
782
|
*/},{key:"queryInvoiceByKeyWithHttpInfo",value:function queryInvoiceByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
828
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryInvoiceByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
783
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryInvoiceByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedInvoice["default"];return this.apiClient.callApi('/object-query/invoices/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
829
784
|
* Query Invoice by key with filters, expands, sort capabilities. Supported expands: account,billtocontact,invoiceitems,invoiceitems.subscription,invoiceitems.subscription.account.
|
|
830
785
|
* @param {String} key Object ID or Number.
|
|
831
786
|
* @param {Object} opts Optional parameters
|
|
@@ -836,7 +791,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
836
791
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
837
792
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
838
793
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
839
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
840
794
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
841
795
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
842
796
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -854,7 +808,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
854
808
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
855
809
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
856
810
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
857
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
858
811
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
859
812
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
860
813
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -862,7 +815,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
862
815
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
863
816
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedInvoiceItem} and HTTP response
|
|
864
817
|
*/},{key:"queryInvoiceItemByKeyWithHttpInfo",value:function queryInvoiceItemByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
865
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryInvoiceItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
818
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryInvoiceItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedInvoiceItem["default"];return this.apiClient.callApi('/object-query/invoice-items/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
866
819
|
* Query InvoiceItem by key with filters, expands, sort capabilities. Supported expands: invoice,subscription,taxationitems,rateplancharge,orderlineitem.
|
|
867
820
|
* @param {String} key Object ID or Number.
|
|
868
821
|
* @param {Object} opts Optional parameters
|
|
@@ -873,7 +826,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
873
826
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
874
827
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
875
828
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
876
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
877
829
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
878
830
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
879
831
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -890,14 +842,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
890
842
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
891
843
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
892
844
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
893
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
894
845
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
895
846
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
896
847
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
897
848
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
898
849
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
899
850
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryInvoiceItemsResponse} and HTTP response
|
|
900
|
-
*/},{key:"queryInvoiceItemsWithHttpInfo",value:function queryInvoiceItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
851
|
+
*/},{key:"queryInvoiceItemsWithHttpInfo",value:function queryInvoiceItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryInvoiceItemsResponse["default"];return this.apiClient.callApi('/object-query/invoice-items','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
901
852
|
* Query InvoiceItems with filters, expands, sort capabilities. Supported expands: invoice,subscription,taxationitems,rateplancharge,orderlineitem.
|
|
902
853
|
* @param {Object} opts Optional parameters
|
|
903
854
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -907,7 +858,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
907
858
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
908
859
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
909
860
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
910
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
911
861
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
912
862
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
913
863
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -924,14 +874,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
924
874
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
925
875
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
926
876
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
927
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
928
877
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
929
878
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
930
879
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
931
880
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
932
881
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
933
882
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryInvoicesResponse} and HTTP response
|
|
934
|
-
*/},{key:"queryInvoicesWithHttpInfo",value:function queryInvoicesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
883
|
+
*/},{key:"queryInvoicesWithHttpInfo",value:function queryInvoicesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryInvoicesResponse["default"];return this.apiClient.callApi('/object-query/invoices','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
935
884
|
* Query Invoices with filters, expands, sort capabilities. Supported expands: account,billtocontact,invoiceitems,invoiceitems.subscription,invoiceitems.subscription.account.
|
|
936
885
|
* @param {Object} opts Optional parameters
|
|
937
886
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -941,7 +890,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
941
890
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
942
891
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
943
892
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
944
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
945
893
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
946
894
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
947
895
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -959,7 +907,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
959
907
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
960
908
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
961
909
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
962
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
963
910
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
964
911
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
965
912
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -967,7 +914,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
967
914
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
968
915
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedOrderAction} and HTTP response
|
|
969
916
|
*/},{key:"queryOrderActionByKeyWithHttpInfo",value:function queryOrderActionByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
970
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryOrderActionByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
917
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryOrderActionByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedOrderAction["default"];return this.apiClient.callApi('/object-query/order-actions/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
971
918
|
* Query OrderAction by key with filters, expands, sort capabilities. Supported expands: subscription,order.
|
|
972
919
|
* @param {String} key Object ID or Number.
|
|
973
920
|
* @param {Object} opts Optional parameters
|
|
@@ -978,7 +925,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
978
925
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
979
926
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
980
927
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
981
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
982
928
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
983
929
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
984
930
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -995,14 +941,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
995
941
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
996
942
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
997
943
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
998
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
999
944
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1000
945
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1001
946
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1002
947
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1003
948
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1004
949
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryOrderActionsResponse} and HTTP response
|
|
1005
|
-
*/},{key:"queryOrderActionsWithHttpInfo",value:function queryOrderActionsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
950
|
+
*/},{key:"queryOrderActionsWithHttpInfo",value:function queryOrderActionsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryOrderActionsResponse["default"];return this.apiClient.callApi('/object-query/order-actions','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1006
951
|
* Query OrderActions with filters, expands, sort capabilities. Supported expands: subscription,order.
|
|
1007
952
|
* @param {Object} opts Optional parameters
|
|
1008
953
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1012,7 +957,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1012
957
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1013
958
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1014
959
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1015
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1016
960
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1017
961
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1018
962
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1030,7 +974,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1030
974
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1031
975
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1032
976
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1033
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1034
977
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1035
978
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1036
979
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1038,7 +981,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1038
981
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1039
982
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedOrderLineItem} and HTTP response
|
|
1040
983
|
*/},{key:"queryOrderLineItemByKeyWithHttpInfo",value:function queryOrderLineItemByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1041
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryOrderLineItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
984
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryOrderLineItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedOrderLineItem["default"];return this.apiClient.callApi('/object-query/order-line-items/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1042
985
|
* Query OrderLineItem by key with filters, expands, sort capabilities. Supported expands: invoiceitems.
|
|
1043
986
|
* @param {String} key Object ID or Number.
|
|
1044
987
|
* @param {Object} opts Optional parameters
|
|
@@ -1049,7 +992,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1049
992
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1050
993
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1051
994
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1052
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1053
995
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1054
996
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1055
997
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1066,14 +1008,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1066
1008
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1067
1009
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1068
1010
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1069
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1070
1011
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1071
1012
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1072
1013
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1073
1014
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1074
1015
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1075
1016
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryOrderLineItemsResponse} and HTTP response
|
|
1076
|
-
*/},{key:"queryOrderLineItemsWithHttpInfo",value:function queryOrderLineItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1017
|
+
*/},{key:"queryOrderLineItemsWithHttpInfo",value:function queryOrderLineItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryOrderLineItemsResponse["default"];return this.apiClient.callApi('/object-query/order-line-items','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1077
1018
|
* Query OrderLineItems with filters, expands, sort capabilities. Supported expands: invoiceitems.
|
|
1078
1019
|
* @param {Object} opts Optional parameters
|
|
1079
1020
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1083,7 +1024,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1083
1024
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1084
1025
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1085
1026
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1086
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1087
1027
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1088
1028
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1089
1029
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1101,7 +1041,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1101
1041
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1102
1042
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1103
1043
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1104
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1105
1044
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1106
1045
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1107
1046
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1109,7 +1048,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1109
1048
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1110
1049
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedOrders} and HTTP response
|
|
1111
1050
|
*/},{key:"queryOrdersByKeyWithHttpInfo",value:function queryOrdersByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1112
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryOrdersByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1051
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryOrdersByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedOrders["default"];return this.apiClient.callApi('/object-query/orders/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1113
1052
|
* Query Orders by key with filters, expands, sort capabilities. Supported expands: account,orderlineitems,orderlineitems.invoiceitems,orderactions,orderactions.subscription,orderactions.subscription.rateplans,orderactions.subscription.rateplans.rateplancharges.
|
|
1114
1053
|
* @param {String} key Object ID or Number.
|
|
1115
1054
|
* @param {Object} opts Optional parameters
|
|
@@ -1120,7 +1059,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1120
1059
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1121
1060
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1122
1061
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1123
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1124
1062
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1125
1063
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1126
1064
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1137,14 +1075,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1137
1075
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1138
1076
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1139
1077
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1140
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1141
1078
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1142
1079
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1143
1080
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1144
1081
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1145
1082
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1146
1083
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryOrderssResponse} and HTTP response
|
|
1147
|
-
*/},{key:"queryOrderssWithHttpInfo",value:function queryOrderssWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1084
|
+
*/},{key:"queryOrderssWithHttpInfo",value:function queryOrderssWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryOrderssResponse["default"];return this.apiClient.callApi('/object-query/orders','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1148
1085
|
* Query Orderss with filters, expands, sort capabilities. Supported expands: account,orderlineitems,orderlineitems.invoiceitems,orderactions,orderactions.subscription,orderactions.subscription.rateplans,orderactions.subscription.rateplans.rateplancharges.
|
|
1149
1086
|
* @param {Object} opts Optional parameters
|
|
1150
1087
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1154,7 +1091,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1154
1091
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1155
1092
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1156
1093
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1157
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1158
1094
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1159
1095
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1160
1096
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1172,7 +1108,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1172
1108
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1173
1109
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1174
1110
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1175
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1176
1111
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1177
1112
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1178
1113
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1180,7 +1115,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1180
1115
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1181
1116
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedPaymentApplication} and HTTP response
|
|
1182
1117
|
*/},{key:"queryPaymentApplicationByKeyWithHttpInfo",value:function queryPaymentApplicationByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1183
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentApplicationByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1118
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentApplicationByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedPaymentApplication["default"];return this.apiClient.callApi('/object-query/payment-applications/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1184
1119
|
* Query PaymentApplication by key with filters, expands, sort capabilities. Supported expands: payment.
|
|
1185
1120
|
* @param {String} key Object ID or Number.
|
|
1186
1121
|
* @param {Object} opts Optional parameters
|
|
@@ -1191,7 +1126,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1191
1126
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1192
1127
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1193
1128
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1194
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1195
1129
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1196
1130
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1197
1131
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1208,14 +1142,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1208
1142
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1209
1143
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1210
1144
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1211
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1212
1145
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1213
1146
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1214
1147
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1215
1148
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1216
1149
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1217
1150
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryPaymentApplicationsResponse} and HTTP response
|
|
1218
|
-
*/},{key:"queryPaymentApplicationsWithHttpInfo",value:function queryPaymentApplicationsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1151
|
+
*/},{key:"queryPaymentApplicationsWithHttpInfo",value:function queryPaymentApplicationsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryPaymentApplicationsResponse["default"];return this.apiClient.callApi('/object-query/payment-applications','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1219
1152
|
* Query PaymentApplications with filters, expands, sort capabilities. Supported expands: payment.
|
|
1220
1153
|
* @param {Object} opts Optional parameters
|
|
1221
1154
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1225,7 +1158,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1225
1158
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1226
1159
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1227
1160
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1228
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1229
1161
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1230
1162
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1231
1163
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1243,7 +1175,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1243
1175
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1244
1176
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1245
1177
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1246
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1247
1178
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1248
1179
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1249
1180
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1251,7 +1182,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1251
1182
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1252
1183
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedPayment} and HTTP response
|
|
1253
1184
|
*/},{key:"queryPaymentByKeyWithHttpInfo",value:function queryPaymentByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1254
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1185
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedPayment["default"];return this.apiClient.callApi('/object-query/payments/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1255
1186
|
* Query Payment by key with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,paymentapplications.
|
|
1256
1187
|
* @param {String} key Object ID or Number.
|
|
1257
1188
|
* @param {Object} opts Optional parameters
|
|
@@ -1262,7 +1193,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1262
1193
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1263
1194
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1264
1195
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1265
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1266
1196
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1267
1197
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1268
1198
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1280,7 +1210,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1280
1210
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1281
1211
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1282
1212
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1283
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1284
1213
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1285
1214
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1286
1215
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1288,7 +1217,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1288
1217
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1289
1218
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedPaymentMethod} and HTTP response
|
|
1290
1219
|
*/},{key:"queryPaymentMethodByKeyWithHttpInfo",value:function queryPaymentMethodByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1291
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentMethodByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1220
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentMethodByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedPaymentMethod["default"];return this.apiClient.callApi('/object-query/payment-methods/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1292
1221
|
* Query PaymentMethod by key with filters, expands, sort capabilities. Supported expands: account.
|
|
1293
1222
|
* @param {String} key Object ID or Number.
|
|
1294
1223
|
* @param {Object} opts Optional parameters
|
|
@@ -1299,7 +1228,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1299
1228
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1300
1229
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1301
1230
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1302
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1303
1231
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1304
1232
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1305
1233
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1317,7 +1245,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1317
1245
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1318
1246
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1319
1247
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1320
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1321
1248
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1322
1249
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1323
1250
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1325,7 +1252,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1325
1252
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1326
1253
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedPaymentMethodSnapshot} and HTTP response
|
|
1327
1254
|
*/},{key:"queryPaymentMethodSnapshotByKeyWithHttpInfo",value:function queryPaymentMethodSnapshotByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1328
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentMethodSnapshotByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1255
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentMethodSnapshotByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedPaymentMethodSnapshot["default"];return this.apiClient.callApi('/object-query/payment-method-snapshots/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1329
1256
|
* Query PaymentMethodSnapshot by key with filters, expands, sort capabilities. Supported expands: N/A.
|
|
1330
1257
|
* @param {String} key Object ID or Number.
|
|
1331
1258
|
* @param {Object} opts Optional parameters
|
|
@@ -1336,7 +1263,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1336
1263
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1337
1264
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1338
1265
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1339
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1340
1266
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1341
1267
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1342
1268
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1353,14 +1279,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1353
1279
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1354
1280
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1355
1281
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1356
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1357
1282
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1358
1283
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1359
1284
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1360
1285
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1361
1286
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1362
1287
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryPaymentMethodSnapshotsResponse} and HTTP response
|
|
1363
|
-
*/},{key:"queryPaymentMethodSnapshotsWithHttpInfo",value:function queryPaymentMethodSnapshotsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1288
|
+
*/},{key:"queryPaymentMethodSnapshotsWithHttpInfo",value:function queryPaymentMethodSnapshotsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryPaymentMethodSnapshotsResponse["default"];return this.apiClient.callApi('/object-query/payment-method-snapshots','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1364
1289
|
* Query PaymentMethodSnapshots with filters, expands, sort capabilities. Supported expands: N/A.
|
|
1365
1290
|
* @param {Object} opts Optional parameters
|
|
1366
1291
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1370,7 +1295,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1370
1295
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1371
1296
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1372
1297
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1373
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1374
1298
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1375
1299
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1376
1300
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1387,14 +1311,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1387
1311
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1388
1312
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1389
1313
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1390
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1391
1314
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1392
1315
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1393
1316
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1394
1317
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1395
1318
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1396
1319
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryPaymentMethodsResponse} and HTTP response
|
|
1397
|
-
*/},{key:"queryPaymentMethodsWithHttpInfo",value:function queryPaymentMethodsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1320
|
+
*/},{key:"queryPaymentMethodsWithHttpInfo",value:function queryPaymentMethodsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryPaymentMethodsResponse["default"];return this.apiClient.callApi('/object-query/payment-methods','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1398
1321
|
* Query PaymentMethods with filters, expands, sort capabilities. Supported expands: account.
|
|
1399
1322
|
* @param {Object} opts Optional parameters
|
|
1400
1323
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1404,7 +1327,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1404
1327
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1405
1328
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1406
1329
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1407
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1408
1330
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1409
1331
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1410
1332
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1422,7 +1344,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1422
1344
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1423
1345
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1424
1346
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1425
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1426
1347
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1427
1348
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1428
1349
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1430,7 +1351,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1430
1351
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1431
1352
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedPaymentRun} and HTTP response
|
|
1432
1353
|
*/},{key:"queryPaymentRunByKeyWithHttpInfo",value:function queryPaymentRunByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1433
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentRunByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1354
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentRunByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedPaymentRun["default"];return this.apiClient.callApi('/object-query/payment-runs/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1434
1355
|
* Query PaymentRun by key with filters, expands, sort capabilities. Supported expands: N/A.
|
|
1435
1356
|
* @param {String} key Object ID or Number.
|
|
1436
1357
|
* @param {Object} opts Optional parameters
|
|
@@ -1441,7 +1362,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1441
1362
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1442
1363
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1443
1364
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1444
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1445
1365
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1446
1366
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1447
1367
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1458,14 +1378,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1458
1378
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1459
1379
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1460
1380
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1461
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1462
1381
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1463
1382
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1464
1383
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1465
1384
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1466
1385
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1467
1386
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryPaymentRunsResponse} and HTTP response
|
|
1468
|
-
*/},{key:"queryPaymentRunsWithHttpInfo",value:function queryPaymentRunsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1387
|
+
*/},{key:"queryPaymentRunsWithHttpInfo",value:function queryPaymentRunsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryPaymentRunsResponse["default"];return this.apiClient.callApi('/object-query/payment-runs','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1469
1388
|
* Query PaymentRuns with filters, expands, sort capabilities. Supported expands: N/A.
|
|
1470
1389
|
* @param {Object} opts Optional parameters
|
|
1471
1390
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1475,7 +1394,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1475
1394
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1476
1395
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1477
1396
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1478
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1479
1397
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1480
1398
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1481
1399
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1493,7 +1411,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1493
1411
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1494
1412
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1495
1413
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1496
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1497
1414
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1498
1415
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1499
1416
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1501,7 +1418,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1501
1418
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1502
1419
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedPaymentSchedule} and HTTP response
|
|
1503
1420
|
*/},{key:"queryPaymentScheduleByKeyWithHttpInfo",value:function queryPaymentScheduleByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1504
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentScheduleByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1421
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentScheduleByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedPaymentSchedule["default"];return this.apiClient.callApi('/object-query/payment-schedules/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1505
1422
|
* Query PaymentSchedule by key with filters, expands, sort capabilities. Supported expands: N/A.
|
|
1506
1423
|
* @param {String} key Object ID or Number.
|
|
1507
1424
|
* @param {Object} opts Optional parameters
|
|
@@ -1512,7 +1429,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1512
1429
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1513
1430
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1514
1431
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1515
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1516
1432
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1517
1433
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1518
1434
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1530,7 +1446,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1530
1446
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1531
1447
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1532
1448
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1533
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1534
1449
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1535
1450
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1536
1451
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1538,7 +1453,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1538
1453
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1539
1454
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedPaymentScheduleItem} and HTTP response
|
|
1540
1455
|
*/},{key:"queryPaymentScheduleItemByKeyWithHttpInfo",value:function queryPaymentScheduleItemByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1541
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentScheduleItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1456
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPaymentScheduleItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedPaymentScheduleItem["default"];return this.apiClient.callApi('/object-query/payment-schedule-items/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1542
1457
|
* Query PaymentScheduleItem by key with filters, expands, sort capabilities. Supported expands: N/A.
|
|
1543
1458
|
* @param {String} key Object ID or Number.
|
|
1544
1459
|
* @param {Object} opts Optional parameters
|
|
@@ -1549,7 +1464,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1549
1464
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1550
1465
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1551
1466
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1552
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1553
1467
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1554
1468
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1555
1469
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1566,14 +1480,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1566
1480
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1567
1481
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1568
1482
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1569
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1570
1483
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1571
1484
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1572
1485
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1573
1486
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1574
1487
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1575
1488
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryPaymentScheduleItemsResponse} and HTTP response
|
|
1576
|
-
*/},{key:"queryPaymentScheduleItemsWithHttpInfo",value:function queryPaymentScheduleItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1489
|
+
*/},{key:"queryPaymentScheduleItemsWithHttpInfo",value:function queryPaymentScheduleItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryPaymentScheduleItemsResponse["default"];return this.apiClient.callApi('/object-query/payment-schedule-items','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1577
1490
|
* Query PaymentScheduleItems with filters, expands, sort capabilities. Supported expands: N/A.
|
|
1578
1491
|
* @param {Object} opts Optional parameters
|
|
1579
1492
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1583,7 +1496,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1583
1496
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1584
1497
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1585
1498
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1586
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1587
1499
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1588
1500
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1589
1501
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1600,14 +1512,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1600
1512
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1601
1513
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1602
1514
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1603
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1604
1515
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1605
1516
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1606
1517
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1607
1518
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1608
1519
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1609
1520
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryPaymentSchedulesResponse} and HTTP response
|
|
1610
|
-
*/},{key:"queryPaymentSchedulesWithHttpInfo",value:function queryPaymentSchedulesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1521
|
+
*/},{key:"queryPaymentSchedulesWithHttpInfo",value:function queryPaymentSchedulesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryPaymentSchedulesResponse["default"];return this.apiClient.callApi('/object-query/payment-schedules','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1611
1522
|
* Query PaymentSchedules with filters, expands, sort capabilities. Supported expands: N/A.
|
|
1612
1523
|
* @param {Object} opts Optional parameters
|
|
1613
1524
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1617,7 +1528,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1617
1528
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1618
1529
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1619
1530
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1620
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1621
1531
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1622
1532
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1623
1533
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1634,14 +1544,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1634
1544
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1635
1545
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1636
1546
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1637
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1638
1547
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1639
1548
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1640
1549
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1641
1550
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1642
1551
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1643
1552
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryPaymentsResponse} and HTTP response
|
|
1644
|
-
*/},{key:"queryPaymentsWithHttpInfo",value:function queryPaymentsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1553
|
+
*/},{key:"queryPaymentsWithHttpInfo",value:function queryPaymentsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryPaymentsResponse["default"];return this.apiClient.callApi('/object-query/payments','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1645
1554
|
* Query Payments with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,paymentapplications.
|
|
1646
1555
|
* @param {Object} opts Optional parameters
|
|
1647
1556
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1651,7 +1560,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1651
1560
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1652
1561
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1653
1562
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1654
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1655
1563
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1656
1564
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1657
1565
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1669,7 +1577,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1669
1577
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1670
1578
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1671
1579
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1672
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1673
1580
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1674
1581
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1675
1582
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1677,7 +1584,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1677
1584
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1678
1585
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedPrepaidBalance} and HTTP response
|
|
1679
1586
|
*/},{key:"queryPrepaidBalanceByKeyWithHttpInfo",value:function queryPrepaidBalanceByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1680
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPrepaidBalanceByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1587
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPrepaidBalanceByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedPrepaidBalance["default"];return this.apiClient.callApi('/object-query/prepaid-balances/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1681
1588
|
* Query PrepaidBalance by key with filters, expands, sort capabilities. Supported expands: account,origsubscription.
|
|
1682
1589
|
* @param {String} key Object ID or Number.
|
|
1683
1590
|
* @param {Object} opts Optional parameters
|
|
@@ -1688,7 +1595,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1688
1595
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1689
1596
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1690
1597
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1691
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1692
1598
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1693
1599
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1694
1600
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1706,7 +1612,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1706
1612
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1707
1613
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1708
1614
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1709
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1710
1615
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1711
1616
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1712
1617
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1714,7 +1619,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1714
1619
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1715
1620
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedPrepaidBalanceFund} and HTTP response
|
|
1716
1621
|
*/},{key:"queryPrepaidBalanceFundByKeyWithHttpInfo",value:function queryPrepaidBalanceFundByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1717
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPrepaidBalanceFundByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1622
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPrepaidBalanceFundByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedPrepaidBalanceFund["default"];return this.apiClient.callApi('/object-query/prepaid-balance-funds/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1718
1623
|
* Query PrepaidBalanceFund by key with filters, expands, sort capabilities. Supported expands: account,prepaidbalance,source,vpsummary.
|
|
1719
1624
|
* @param {String} key Object ID or Number.
|
|
1720
1625
|
* @param {Object} opts Optional parameters
|
|
@@ -1725,7 +1630,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1725
1630
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1726
1631
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1727
1632
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1728
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1729
1633
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1730
1634
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1731
1635
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1742,14 +1646,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1742
1646
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1743
1647
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1744
1648
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1745
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1746
1649
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1747
1650
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1748
1651
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1749
1652
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1750
1653
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1751
1654
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryPrepaidBalanceFundsResponse} and HTTP response
|
|
1752
|
-
*/},{key:"queryPrepaidBalanceFundsWithHttpInfo",value:function queryPrepaidBalanceFundsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1655
|
+
*/},{key:"queryPrepaidBalanceFundsWithHttpInfo",value:function queryPrepaidBalanceFundsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryPrepaidBalanceFundsResponse["default"];return this.apiClient.callApi('/object-query/prepaid-balance-funds','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1753
1656
|
* Query PrepaidBalanceFunds with filters, expands, sort capabilities. Supported expands: account,prepaidbalance,source,vpsummary.
|
|
1754
1657
|
* @param {Object} opts Optional parameters
|
|
1755
1658
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1759,7 +1662,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1759
1662
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1760
1663
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1761
1664
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1762
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1763
1665
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1764
1666
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1765
1667
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1777,7 +1679,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1777
1679
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1778
1680
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1779
1681
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1780
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1781
1682
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1782
1683
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1783
1684
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1785,7 +1686,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1785
1686
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1786
1687
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedPrepaidBalanceTransaction} and HTTP response
|
|
1787
1688
|
*/},{key:"queryPrepaidBalanceTransactionByKeyWithHttpInfo",value:function queryPrepaidBalanceTransactionByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1788
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPrepaidBalanceTransactionByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1689
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryPrepaidBalanceTransactionByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedPrepaidBalanceTransaction["default"];return this.apiClient.callApi('/object-query/prepaid-balance-transactions/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1789
1690
|
* Query PrepaidBalanceTransaction by key with filters, expands, sort capabilities. Supported expands: account,prepaidbalance,fund,fund.source.
|
|
1790
1691
|
* @param {String} key Object ID or Number.
|
|
1791
1692
|
* @param {Object} opts Optional parameters
|
|
@@ -1796,7 +1697,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1796
1697
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1797
1698
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1798
1699
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1799
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1800
1700
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1801
1701
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1802
1702
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1813,14 +1713,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1813
1713
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1814
1714
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1815
1715
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1816
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1817
1716
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1818
1717
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1819
1718
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1820
1719
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1821
1720
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1822
1721
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryPrepaidBalanceTransactionsResponse} and HTTP response
|
|
1823
|
-
*/},{key:"queryPrepaidBalanceTransactionsWithHttpInfo",value:function queryPrepaidBalanceTransactionsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1722
|
+
*/},{key:"queryPrepaidBalanceTransactionsWithHttpInfo",value:function queryPrepaidBalanceTransactionsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryPrepaidBalanceTransactionsResponse["default"];return this.apiClient.callApi('/object-query/prepaid-balance-transactions','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1824
1723
|
* Query PrepaidBalanceTransactions with filters, expands, sort capabilities. Supported expands: account,prepaidbalance,fund,fund.source.
|
|
1825
1724
|
* @param {Object} opts Optional parameters
|
|
1826
1725
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1830,7 +1729,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1830
1729
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1831
1730
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1832
1731
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1833
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1834
1732
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1835
1733
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1836
1734
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1847,14 +1745,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1847
1745
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1848
1746
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1849
1747
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1850
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1851
1748
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1852
1749
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1853
1750
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1854
1751
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1855
1752
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1856
1753
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryPrepaidBalancesResponse} and HTTP response
|
|
1857
|
-
*/},{key:"queryPrepaidBalancesWithHttpInfo",value:function queryPrepaidBalancesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1754
|
+
*/},{key:"queryPrepaidBalancesWithHttpInfo",value:function queryPrepaidBalancesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryPrepaidBalancesResponse["default"];return this.apiClient.callApi('/object-query/prepaid-balances','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1858
1755
|
* Query PrepaidBalances with filters, expands, sort capabilities. Supported expands: account,origsubscription.
|
|
1859
1756
|
* @param {Object} opts Optional parameters
|
|
1860
1757
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1864,7 +1761,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1864
1761
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1865
1762
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1866
1763
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1867
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1868
1764
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1869
1765
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1870
1766
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1882,7 +1778,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1882
1778
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1883
1779
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1884
1780
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1885
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1886
1781
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1887
1782
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1888
1783
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1890,7 +1785,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1890
1785
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1891
1786
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedProcessedUsage} and HTTP response
|
|
1892
1787
|
*/},{key:"queryProcessedUsageByKeyWithHttpInfo",value:function queryProcessedUsageByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1893
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryProcessedUsageByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1788
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryProcessedUsageByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedProcessedUsage["default"];return this.apiClient.callApi('/object-query/processed-usages/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1894
1789
|
* Query ProcessedUsage by key with filters, expands, sort capabilities. Supported expands: usage,invoiceitem,creditmemoitem.
|
|
1895
1790
|
* @param {String} key Object ID or Number.
|
|
1896
1791
|
* @param {Object} opts Optional parameters
|
|
@@ -1901,7 +1796,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1901
1796
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1902
1797
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1903
1798
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1904
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1905
1799
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1906
1800
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1907
1801
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1918,14 +1812,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1918
1812
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1919
1813
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1920
1814
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1921
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1922
1815
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1923
1816
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1924
1817
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
1925
1818
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
1926
1819
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1927
1820
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryProcessedUsagesResponse} and HTTP response
|
|
1928
|
-
*/},{key:"queryProcessedUsagesWithHttpInfo",value:function queryProcessedUsagesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1821
|
+
*/},{key:"queryProcessedUsagesWithHttpInfo",value:function queryProcessedUsagesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryProcessedUsagesResponse["default"];return this.apiClient.callApi('/object-query/processed-usages','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1929
1822
|
* Query ProcessedUsages with filters, expands, sort capabilities. Supported expands: usage,invoiceitem,creditmemoitem.
|
|
1930
1823
|
* @param {Object} opts Optional parameters
|
|
1931
1824
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1935,7 +1828,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1935
1828
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1936
1829
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1937
1830
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1938
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1939
1831
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1940
1832
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1941
1833
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1953,7 +1845,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1953
1845
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1954
1846
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1955
1847
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1956
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1957
1848
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1958
1849
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1959
1850
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1961,7 +1852,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1961
1852
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1962
1853
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedProduct} and HTTP response
|
|
1963
1854
|
*/},{key:"queryProductByKeyWithHttpInfo",value:function queryProductByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
1964
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryProductByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1855
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryProductByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedProduct["default"];return this.apiClient.callApi('/object-query/products/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1965
1856
|
* Query Product by key with filters, expands, sort capabilities. Supported expands: productrateplans,productrateplans.productrateplancharges,productrateplans.productrateplancharges.productrateplanchargetiers.
|
|
1966
1857
|
* @param {String} key Object ID or Number.
|
|
1967
1858
|
* @param {Object} opts Optional parameters
|
|
@@ -1972,7 +1863,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1972
1863
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1973
1864
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1974
1865
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
1975
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1976
1866
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1977
1867
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1978
1868
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1980,7 +1870,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1980
1870
|
* @param {Array.<String>} opts.filter A case-sensitive filter on the list.
|
|
1981
1871
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ExpandedProduct}
|
|
1982
1872
|
*/},{key:"queryProductByKey",value:function queryProductByKey(key,opts){return this.queryProductByKeyWithHttpInfo(key,opts).then(function(response_and_data){return response_and_data.data;});}/**
|
|
1983
|
-
* Query ProductRatePlan by key with filters, expands, sort capabilities. Supported expands: product,productrateplancharges,productrateplancharges.productrateplanchargetiers.
|
|
1873
|
+
* Query ProductRatePlan by key with filters, expands, sort capabilities. Supported expands: product,productrateplancharges,productrateplancharges.productrateplanchargetiers,externalproductrateplans.
|
|
1984
1874
|
* @param {String} key Object ID or Number.
|
|
1985
1875
|
* @param {Object} opts Optional parameters
|
|
1986
1876
|
* @param {String} [idempotency_key] Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -1990,7 +1880,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1990
1880
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1991
1881
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1992
1882
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
1993
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1994
1883
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
1995
1884
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
1996
1885
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -1998,8 +1887,8 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
1998
1887
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
1999
1888
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedProductRatePlan} and HTTP response
|
|
2000
1889
|
*/},{key:"queryProductRatePlanByKeyWithHttpInfo",value:function queryProductRatePlanByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2001
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryProductRatePlanByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2002
|
-
* Query ProductRatePlan by key with filters, expands, sort capabilities. Supported expands: product,productrateplancharges,productrateplancharges.productrateplanchargetiers.
|
|
1890
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryProductRatePlanByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedProductRatePlan["default"];return this.apiClient.callApi('/object-query/product-rate-plans/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
1891
|
+
* Query ProductRatePlan by key with filters, expands, sort capabilities. Supported expands: product,productrateplancharges,productrateplancharges.productrateplanchargetiers,externalproductrateplans.
|
|
2003
1892
|
* @param {String} key Object ID or Number.
|
|
2004
1893
|
* @param {Object} opts Optional parameters
|
|
2005
1894
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2009,7 +1898,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2009
1898
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2010
1899
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2011
1900
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2012
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2013
1901
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2014
1902
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2015
1903
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2027,7 +1915,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2027
1915
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2028
1916
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2029
1917
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2030
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2031
1918
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2032
1919
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2033
1920
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2035,7 +1922,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2035
1922
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2036
1923
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedProductRatePlanCharge} and HTTP response
|
|
2037
1924
|
*/},{key:"queryProductRatePlanChargeByKeyWithHttpInfo",value:function queryProductRatePlanChargeByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2038
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryProductRatePlanChargeByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1925
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryProductRatePlanChargeByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedProductRatePlanCharge["default"];return this.apiClient.callApi('/object-query/product-rate-plan-charges/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2039
1926
|
* Query ProductRatePlanCharge by key with filters, expands, sort capabilities. Supported expands: productrateplan,productrateplanchargetiers.
|
|
2040
1927
|
* @param {String} key Object ID or Number.
|
|
2041
1928
|
* @param {Object} opts Optional parameters
|
|
@@ -2046,7 +1933,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2046
1933
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2047
1934
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2048
1935
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2049
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2050
1936
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2051
1937
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2052
1938
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2064,7 +1950,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2064
1950
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2065
1951
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2066
1952
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2067
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2068
1953
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2069
1954
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2070
1955
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2072,7 +1957,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2072
1957
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2073
1958
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedProductRatePlanChargeTier} and HTTP response
|
|
2074
1959
|
*/},{key:"queryProductRatePlanChargeTierByKeyWithHttpInfo",value:function queryProductRatePlanChargeTierByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2075
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryProductRatePlanChargeTierByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1960
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryProductRatePlanChargeTierByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedProductRatePlanChargeTier["default"];return this.apiClient.callApi('/object-query/product-rate-plan-charge-tiers/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2076
1961
|
* Query ProductRatePlanChargeTier by key with filters, expands, sort capabilities. Supported expands: productrateplancharge.
|
|
2077
1962
|
* @param {String} key Object ID or Number.
|
|
2078
1963
|
* @param {Object} opts Optional parameters
|
|
@@ -2083,7 +1968,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2083
1968
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2084
1969
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2085
1970
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2086
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2087
1971
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2088
1972
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2089
1973
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2100,14 +1984,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2100
1984
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2101
1985
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2102
1986
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2103
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2104
1987
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2105
1988
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2106
1989
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2107
1990
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2108
1991
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2109
1992
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryProductRatePlanChargeTiersResponse} and HTTP response
|
|
2110
|
-
*/},{key:"queryProductRatePlanChargeTiersWithHttpInfo",value:function queryProductRatePlanChargeTiersWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
1993
|
+
*/},{key:"queryProductRatePlanChargeTiersWithHttpInfo",value:function queryProductRatePlanChargeTiersWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryProductRatePlanChargeTiersResponse["default"];return this.apiClient.callApi('/object-query/product-rate-plan-charge-tiers','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2111
1994
|
* Query ProductRatePlanChargeTiers with filters, expands, sort capabilities. Supported expands: productrateplancharge.
|
|
2112
1995
|
* @param {Object} opts Optional parameters
|
|
2113
1996
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2117,7 +2000,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2117
2000
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2118
2001
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2119
2002
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2120
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2121
2003
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2122
2004
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2123
2005
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2134,14 +2016,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2134
2016
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2135
2017
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2136
2018
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2137
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2138
2019
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2139
2020
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2140
2021
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2141
2022
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2142
2023
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2143
2024
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryProductRatePlanChargesResponse} and HTTP response
|
|
2144
|
-
*/},{key:"queryProductRatePlanChargesWithHttpInfo",value:function queryProductRatePlanChargesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2025
|
+
*/},{key:"queryProductRatePlanChargesWithHttpInfo",value:function queryProductRatePlanChargesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryProductRatePlanChargesResponse["default"];return this.apiClient.callApi('/object-query/product-rate-plan-charges','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2145
2026
|
* Query ProductRatePlanCharges with filters, expands, sort capabilities. Supported expands: productrateplan,productrateplanchargetiers.
|
|
2146
2027
|
* @param {Object} opts Optional parameters
|
|
2147
2028
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2151,7 +2032,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2151
2032
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2152
2033
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2153
2034
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2154
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2155
2035
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2156
2036
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2157
2037
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2159,7 +2039,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2159
2039
|
* @param {Array.<String>} opts.filter A case-sensitive filter on the list.
|
|
2160
2040
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/QueryProductRatePlanChargesResponse}
|
|
2161
2041
|
*/},{key:"queryProductRatePlanCharges",value:function queryProductRatePlanCharges(opts){return this.queryProductRatePlanChargesWithHttpInfo(opts).then(function(response_and_data){return response_and_data.data;});}/**
|
|
2162
|
-
* Query ProductRatePlans with filters, expands, sort capabilities. Supported expands: product,productrateplancharges,productrateplancharges.productrateplanchargetiers.
|
|
2042
|
+
* Query ProductRatePlans with filters, expands, sort capabilities. Supported expands: product,productrateplancharges,productrateplancharges.productrateplanchargetiers,externalproductrateplans.
|
|
2163
2043
|
* @param {Object} opts Optional parameters
|
|
2164
2044
|
* @param {String} [idempotency_key] Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
2165
2045
|
* @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
@@ -2168,15 +2048,14 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2168
2048
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2169
2049
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2170
2050
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2171
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2172
2051
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2173
2052
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2174
2053
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2175
2054
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2176
2055
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2177
2056
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryProductRatePlansResponse} and HTTP response
|
|
2178
|
-
*/},{key:"queryProductRatePlansWithHttpInfo",value:function queryProductRatePlansWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2179
|
-
* Query ProductRatePlans with filters, expands, sort capabilities. Supported expands: product,productrateplancharges,productrateplancharges.productrateplanchargetiers.
|
|
2057
|
+
*/},{key:"queryProductRatePlansWithHttpInfo",value:function queryProductRatePlansWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryProductRatePlansResponse["default"];return this.apiClient.callApi('/object-query/product-rate-plans','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2058
|
+
* Query ProductRatePlans with filters, expands, sort capabilities. Supported expands: product,productrateplancharges,productrateplancharges.productrateplanchargetiers,externalproductrateplans.
|
|
2180
2059
|
* @param {Object} opts Optional parameters
|
|
2181
2060
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
2182
2061
|
* @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
@@ -2185,7 +2064,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2185
2064
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2186
2065
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2187
2066
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2188
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2189
2067
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2190
2068
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2191
2069
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2202,14 +2080,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2202
2080
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2203
2081
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2204
2082
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2205
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2206
2083
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2207
2084
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2208
2085
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2209
2086
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2210
2087
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2211
2088
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryProductsResponse} and HTTP response
|
|
2212
|
-
*/},{key:"queryProductsWithHttpInfo",value:function queryProductsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2089
|
+
*/},{key:"queryProductsWithHttpInfo",value:function queryProductsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryProductsResponse["default"];return this.apiClient.callApi('/object-query/products','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2213
2090
|
* Query Products with filters, expands, sort capabilities. Supported expands: productrateplans,productrateplans.productrateplancharges,productrateplans.productrateplancharges.productrateplanchargetiers.
|
|
2214
2091
|
* @param {Object} opts Optional parameters
|
|
2215
2092
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2219,7 +2096,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2219
2096
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2220
2097
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2221
2098
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2222
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2223
2099
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2224
2100
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2225
2101
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2237,7 +2113,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2237
2113
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2238
2114
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2239
2115
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2240
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2241
2116
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2242
2117
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2243
2118
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2245,7 +2120,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2245
2120
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2246
2121
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedRatePlan} and HTTP response
|
|
2247
2122
|
*/},{key:"queryRatePlanByKeyWithHttpInfo",value:function queryRatePlanByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2248
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRatePlanByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2123
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRatePlanByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedRatePlan["default"];return this.apiClient.callApi('/object-query/rate-plans/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2249
2124
|
* Query RatePlan by key with filters, expands, sort capabilities. Supported expands: subscription,productrateplan,rateplancharges,rateplancharges.rateplanchargetiers.
|
|
2250
2125
|
* @param {String} key Object ID or Number.
|
|
2251
2126
|
* @param {Object} opts Optional parameters
|
|
@@ -2256,7 +2131,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2256
2131
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2257
2132
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2258
2133
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2259
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2260
2134
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2261
2135
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2262
2136
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2274,7 +2148,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2274
2148
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2275
2149
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2276
2150
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2277
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2278
2151
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2279
2152
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2280
2153
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2282,7 +2155,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2282
2155
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2283
2156
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedRatePlanCharge} and HTTP response
|
|
2284
2157
|
*/},{key:"queryRatePlanChargeByKeyWithHttpInfo",value:function queryRatePlanChargeByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2285
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRatePlanChargeByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2158
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRatePlanChargeByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedRatePlanCharge["default"];return this.apiClient.callApi('/object-query/rate-plan-charges/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2286
2159
|
* Query RatePlanCharge by key with filters, expands, sort capabilities. Supported expands: rateplan,productrateplancharge,rateplanchargetiers.
|
|
2287
2160
|
* @param {String} key Object ID or Number.
|
|
2288
2161
|
* @param {Object} opts Optional parameters
|
|
@@ -2293,7 +2166,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2293
2166
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2294
2167
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2295
2168
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2296
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2297
2169
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2298
2170
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2299
2171
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2311,7 +2183,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2311
2183
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2312
2184
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2313
2185
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2314
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2315
2186
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2316
2187
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2317
2188
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2319,7 +2190,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2319
2190
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2320
2191
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedRatePlanChargeTier} and HTTP response
|
|
2321
2192
|
*/},{key:"queryRatePlanChargeTierByKeyWithHttpInfo",value:function queryRatePlanChargeTierByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2322
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRatePlanChargeTierByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2193
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRatePlanChargeTierByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedRatePlanChargeTier["default"];return this.apiClient.callApi('/object-query/rate-plan-charge-tiers/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2323
2194
|
* Query RatePlanChargeTier by key with filters, expands, sort capabilities. Supported expands: rateplancharge.
|
|
2324
2195
|
* @param {String} key Object ID or Number.
|
|
2325
2196
|
* @param {Object} opts Optional parameters
|
|
@@ -2330,7 +2201,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2330
2201
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2331
2202
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2332
2203
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2333
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2334
2204
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2335
2205
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2336
2206
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2347,14 +2217,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2347
2217
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2348
2218
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2349
2219
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2350
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2351
2220
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2352
2221
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2353
2222
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2354
2223
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2355
2224
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2356
2225
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryRatePlanChargeTiersResponse} and HTTP response
|
|
2357
|
-
*/},{key:"queryRatePlanChargeTiersWithHttpInfo",value:function queryRatePlanChargeTiersWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2226
|
+
*/},{key:"queryRatePlanChargeTiersWithHttpInfo",value:function queryRatePlanChargeTiersWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryRatePlanChargeTiersResponse["default"];return this.apiClient.callApi('/object-query/rate-plan-charge-tiers','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2358
2227
|
* Query RatePlanChargeTiers with filters, expands, sort capabilities. Supported expands: rateplancharge.
|
|
2359
2228
|
* @param {Object} opts Optional parameters
|
|
2360
2229
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2364,7 +2233,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2364
2233
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2365
2234
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2366
2235
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2367
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2368
2236
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2369
2237
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2370
2238
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2381,14 +2249,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2381
2249
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2382
2250
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2383
2251
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2384
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2385
2252
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2386
2253
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2387
2254
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2388
2255
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2389
2256
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2390
2257
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryRatePlanChargesResponse} and HTTP response
|
|
2391
|
-
*/},{key:"queryRatePlanChargesWithHttpInfo",value:function queryRatePlanChargesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2258
|
+
*/},{key:"queryRatePlanChargesWithHttpInfo",value:function queryRatePlanChargesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryRatePlanChargesResponse["default"];return this.apiClient.callApi('/object-query/rate-plan-charges','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2392
2259
|
* Query RatePlanCharges with filters, expands, sort capabilities. Supported expands: rateplan,productrateplancharge,rateplanchargetiers.
|
|
2393
2260
|
* @param {Object} opts Optional parameters
|
|
2394
2261
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2398,7 +2265,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2398
2265
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2399
2266
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2400
2267
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2401
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2402
2268
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2403
2269
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2404
2270
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2415,14 +2281,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2415
2281
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2416
2282
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2417
2283
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2418
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2419
2284
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2420
2285
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2421
2286
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2422
2287
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2423
2288
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2424
2289
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryRatePlansResponse} and HTTP response
|
|
2425
|
-
*/},{key:"queryRatePlansWithHttpInfo",value:function queryRatePlansWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2290
|
+
*/},{key:"queryRatePlansWithHttpInfo",value:function queryRatePlansWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryRatePlansResponse["default"];return this.apiClient.callApi('/object-query/rate-plans','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2426
2291
|
* Query RatePlans with filters, expands, sort capabilities. Supported expands: subscription,productrateplan,rateplancharges,rateplancharges.rateplanchargetiers.
|
|
2427
2292
|
* @param {Object} opts Optional parameters
|
|
2428
2293
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2432,7 +2297,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2432
2297
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2433
2298
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2434
2299
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2435
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2436
2300
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2437
2301
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2438
2302
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2450,7 +2314,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2450
2314
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2451
2315
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2452
2316
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2453
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2454
2317
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2455
2318
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2456
2319
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2458,7 +2321,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2458
2321
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2459
2322
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedRatingResult} and HTTP response
|
|
2460
2323
|
*/},{key:"queryRatingResultByKeyWithHttpInfo",value:function queryRatingResultByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2461
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRatingResultByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2324
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRatingResultByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedRatingResult["default"];return this.apiClient.callApi('/object-query/rating-results/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2462
2325
|
* Query RatingResult by key with filters, expands, sort capabilities. Supported expands: account,rateplancharge,subscription,invoiceitem.
|
|
2463
2326
|
* @param {String} key Object ID or Number.
|
|
2464
2327
|
* @param {Object} opts Optional parameters
|
|
@@ -2469,7 +2332,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2469
2332
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2470
2333
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2471
2334
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2472
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2473
2335
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2474
2336
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2475
2337
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2486,14 +2348,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2486
2348
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2487
2349
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2488
2350
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2489
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2490
2351
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2491
2352
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2492
2353
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2493
2354
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2494
2355
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2495
2356
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryRatingResultsResponse} and HTTP response
|
|
2496
|
-
*/},{key:"queryRatingResultsWithHttpInfo",value:function queryRatingResultsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2357
|
+
*/},{key:"queryRatingResultsWithHttpInfo",value:function queryRatingResultsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryRatingResultsResponse["default"];return this.apiClient.callApi('/object-query/rating-results','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2497
2358
|
* Query RatingResults with filters, expands, sort capabilities. Supported expands: account,rateplancharge,subscription,invoiceitem.
|
|
2498
2359
|
* @param {Object} opts Optional parameters
|
|
2499
2360
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2503,7 +2364,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2503
2364
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2504
2365
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2505
2366
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2506
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2507
2367
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2508
2368
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2509
2369
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2521,7 +2381,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2521
2381
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2522
2382
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2523
2383
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2524
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2525
2384
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2526
2385
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2527
2386
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2529,7 +2388,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2529
2388
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2530
2389
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedRefundApplication} and HTTP response
|
|
2531
2390
|
*/},{key:"queryRefundApplicationByKeyWithHttpInfo",value:function queryRefundApplicationByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2532
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRefundApplicationByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2391
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRefundApplicationByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedRefundApplication["default"];return this.apiClient.callApi('/object-query/refund-applications/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2533
2392
|
* Query RefundApplication by key with filters, expands, sort capabilities. Supported expands: refund,payment,refundapplicationitems.
|
|
2534
2393
|
* @param {String} key Object ID or Number.
|
|
2535
2394
|
* @param {Object} opts Optional parameters
|
|
@@ -2540,7 +2399,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2540
2399
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2541
2400
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2542
2401
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2543
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2544
2402
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2545
2403
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2546
2404
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2558,7 +2416,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2558
2416
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2559
2417
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2560
2418
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2561
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2562
2419
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2563
2420
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2564
2421
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2566,7 +2423,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2566
2423
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2567
2424
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedRefundApplicationItem} and HTTP response
|
|
2568
2425
|
*/},{key:"queryRefundApplicationItemByKeyWithHttpInfo",value:function queryRefundApplicationItemByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2569
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRefundApplicationItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2426
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRefundApplicationItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedRefundApplicationItem["default"];return this.apiClient.callApi('/object-query/refund-application-items/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2570
2427
|
* Query RefundApplicationItem by key with filters, expands, sort capabilities. Supported expands: refundapplication.
|
|
2571
2428
|
* @param {String} key Object ID or Number.
|
|
2572
2429
|
* @param {Object} opts Optional parameters
|
|
@@ -2577,7 +2434,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2577
2434
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2578
2435
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2579
2436
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2580
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2581
2437
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2582
2438
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2583
2439
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2594,14 +2450,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2594
2450
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2595
2451
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2596
2452
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2597
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2598
2453
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2599
2454
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2600
2455
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2601
2456
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2602
2457
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2603
2458
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryRefundApplicationItemsResponse} and HTTP response
|
|
2604
|
-
*/},{key:"queryRefundApplicationItemsWithHttpInfo",value:function queryRefundApplicationItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2459
|
+
*/},{key:"queryRefundApplicationItemsWithHttpInfo",value:function queryRefundApplicationItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryRefundApplicationItemsResponse["default"];return this.apiClient.callApi('/object-query/refund-application-items','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2605
2460
|
* Query RefundApplicationItems with filters, expands, sort capabilities. Supported expands: refundapplication.
|
|
2606
2461
|
* @param {Object} opts Optional parameters
|
|
2607
2462
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2611,7 +2466,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2611
2466
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2612
2467
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2613
2468
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2614
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2615
2469
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2616
2470
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2617
2471
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2628,14 +2482,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2628
2482
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2629
2483
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2630
2484
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2631
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2632
2485
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2633
2486
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2634
2487
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2635
2488
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2636
2489
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2637
2490
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryRefundApplicationsResponse} and HTTP response
|
|
2638
|
-
*/},{key:"queryRefundApplicationsWithHttpInfo",value:function queryRefundApplicationsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2491
|
+
*/},{key:"queryRefundApplicationsWithHttpInfo",value:function queryRefundApplicationsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryRefundApplicationsResponse["default"];return this.apiClient.callApi('/object-query/refund-applications','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2639
2492
|
* Query RefundApplications with filters, expands, sort capabilities. Supported expands: refund,payment,refundapplicationitems.
|
|
2640
2493
|
* @param {Object} opts Optional parameters
|
|
2641
2494
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2645,7 +2498,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2645
2498
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2646
2499
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2647
2500
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2648
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2649
2501
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2650
2502
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2651
2503
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2663,7 +2515,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2663
2515
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2664
2516
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2665
2517
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2666
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2667
2518
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2668
2519
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2669
2520
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2671,7 +2522,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2671
2522
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2672
2523
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedRefund} and HTTP response
|
|
2673
2524
|
*/},{key:"queryRefundByKeyWithHttpInfo",value:function queryRefundByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2674
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRefundByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2525
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryRefundByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedRefund["default"];return this.apiClient.callApi('/object-query/refunds/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2675
2526
|
* Query Refund by key with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,refundapplications,refundapplications.payment,refundapplications.refundapplicationitems.
|
|
2676
2527
|
* @param {String} key Object ID or Number.
|
|
2677
2528
|
* @param {Object} opts Optional parameters
|
|
@@ -2682,7 +2533,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2682
2533
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2683
2534
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2684
2535
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2685
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2686
2536
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2687
2537
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2688
2538
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2699,14 +2549,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2699
2549
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2700
2550
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2701
2551
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2702
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2703
2552
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2704
2553
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2705
2554
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2706
2555
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2707
2556
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2708
2557
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryRefundsResponse} and HTTP response
|
|
2709
|
-
*/},{key:"queryRefundsWithHttpInfo",value:function queryRefundsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2558
|
+
*/},{key:"queryRefundsWithHttpInfo",value:function queryRefundsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryRefundsResponse["default"];return this.apiClient.callApi('/object-query/refunds','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2710
2559
|
* Query Refunds with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,refundapplications,refundapplications.payment,refundapplications.refundapplicationitems.
|
|
2711
2560
|
* @param {Object} opts Optional parameters
|
|
2712
2561
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2716,7 +2565,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2716
2565
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2717
2566
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2718
2567
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2719
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2720
2568
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2721
2569
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2722
2570
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2734,7 +2582,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2734
2582
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2735
2583
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2736
2584
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2737
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2738
2585
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2739
2586
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2740
2587
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2742,7 +2589,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2742
2589
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2743
2590
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedSubscription} and HTTP response
|
|
2744
2591
|
*/},{key:"querySubscriptionByKeyWithHttpInfo",value:function querySubscriptionByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2745
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling querySubscriptionByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2592
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling querySubscriptionByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedSubscription["default"];return this.apiClient.callApi('/object-query/subscriptions/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2746
2593
|
* Query Subscription by key with filters, expands, sort capabilities. Supported expands: account,invoiceowner,billtocontact,invoiceitems,rateplans,rateplans.rateplancharges,rateplans.rateplancharges.rateplanchargetiers,account.billto,account.soldto,account.paymentmethods,order.
|
|
2747
2594
|
* @param {String} key Object ID or Number.
|
|
2748
2595
|
* @param {Object} opts Optional parameters
|
|
@@ -2753,7 +2600,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2753
2600
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2754
2601
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2755
2602
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2756
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2757
2603
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2758
2604
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2759
2605
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2770,14 +2616,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2770
2616
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2771
2617
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2772
2618
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2773
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2774
2619
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2775
2620
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2776
2621
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2777
2622
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2778
2623
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2779
2624
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QuerySubscriptionsResponse} and HTTP response
|
|
2780
|
-
*/},{key:"querySubscriptionsWithHttpInfo",value:function querySubscriptionsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2625
|
+
*/},{key:"querySubscriptionsWithHttpInfo",value:function querySubscriptionsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QuerySubscriptionsResponse["default"];return this.apiClient.callApi('/object-query/subscriptions','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2781
2626
|
* Query Subscriptions with filters, expands, sort capabilities. Supported expands: account,invoiceowner,billtocontact,invoiceitems,rateplans,rateplans.rateplancharges,rateplans.rateplancharges.rateplanchargetiers,account.billto,account.soldto,account.paymentmethods,order.
|
|
2782
2627
|
* @param {Object} opts Optional parameters
|
|
2783
2628
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2787,7 +2632,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2787
2632
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2788
2633
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2789
2634
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2790
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2791
2635
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2792
2636
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2793
2637
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2805,7 +2649,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2805
2649
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2806
2650
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2807
2651
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2808
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2809
2652
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2810
2653
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2811
2654
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2813,7 +2656,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2813
2656
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2814
2657
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedTaxationItem} and HTTP response
|
|
2815
2658
|
*/},{key:"queryTaxationItemByKeyWithHttpInfo",value:function queryTaxationItemByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2816
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryTaxationItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2659
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryTaxationItemByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedTaxationItem["default"];return this.apiClient.callApi('/object-query/taxation-items/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2817
2660
|
* Query TaxationItem by key with filters, expands, sort capabilities. Supported expands: N/A.
|
|
2818
2661
|
* @param {String} key Object ID or Number.
|
|
2819
2662
|
* @param {Object} opts Optional parameters
|
|
@@ -2824,7 +2667,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2824
2667
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2825
2668
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2826
2669
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2827
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2828
2670
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2829
2671
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2830
2672
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2841,14 +2683,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2841
2683
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2842
2684
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2843
2685
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2844
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2845
2686
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2846
2687
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2847
2688
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2848
2689
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2849
2690
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2850
2691
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryTaxationItemsResponse} and HTTP response
|
|
2851
|
-
*/},{key:"queryTaxationItemsWithHttpInfo",value:function queryTaxationItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2692
|
+
*/},{key:"queryTaxationItemsWithHttpInfo",value:function queryTaxationItemsWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryTaxationItemsResponse["default"];return this.apiClient.callApi('/object-query/taxation-items','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2852
2693
|
* Query TaxationItems with filters, expands, sort capabilities. Supported expands: N/A.
|
|
2853
2694
|
* @param {Object} opts Optional parameters
|
|
2854
2695
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2858,7 +2699,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2858
2699
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2859
2700
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2860
2701
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2861
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2862
2702
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2863
2703
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2864
2704
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2876,7 +2716,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2876
2716
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2877
2717
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2878
2718
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2879
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2880
2719
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2881
2720
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2882
2721
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2884,7 +2723,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2884
2723
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2885
2724
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedUsage} and HTTP response
|
|
2886
2725
|
*/},{key:"queryUsageByKeyWithHttpInfo",value:function queryUsageByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2887
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryUsageByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2726
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryUsageByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedUsage["default"];return this.apiClient.callApi('/object-query/usages/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2888
2727
|
* Query Usage by key with filters, expands, sort capabilities. Supported expands: account.
|
|
2889
2728
|
* @param {String} key Object ID or Number.
|
|
2890
2729
|
* @param {Object} opts Optional parameters
|
|
@@ -2895,7 +2734,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2895
2734
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2896
2735
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2897
2736
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2898
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2899
2737
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2900
2738
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2901
2739
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2912,14 +2750,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2912
2750
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2913
2751
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2914
2752
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2915
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2916
2753
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2917
2754
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2918
2755
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2919
2756
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2920
2757
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2921
2758
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryUsagesResponse} and HTTP response
|
|
2922
|
-
*/},{key:"queryUsagesWithHttpInfo",value:function queryUsagesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2759
|
+
*/},{key:"queryUsagesWithHttpInfo",value:function queryUsagesWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryUsagesResponse["default"];return this.apiClient.callApi('/object-query/usages','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2923
2760
|
* Query Usages with filters, expands, sort capabilities. Supported expands: account.
|
|
2924
2761
|
* @param {Object} opts Optional parameters
|
|
2925
2762
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -2929,7 +2766,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2929
2766
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2930
2767
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2931
2768
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2932
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2933
2769
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2934
2770
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2935
2771
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2947,7 +2783,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2947
2783
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2948
2784
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2949
2785
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2950
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2951
2786
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2952
2787
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2953
2788
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2955,7 +2790,7 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2955
2790
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2956
2791
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedValidityPeriodSummary} and HTTP response
|
|
2957
2792
|
*/},{key:"queryValidityPeriodSummaryByKeyWithHttpInfo",value:function queryValidityPeriodSummaryByKeyWithHttpInfo(key,opts){opts=opts||{};var postBody=null;// verify the required parameter 'key' is set
|
|
2958
|
-
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryValidityPeriodSummaryByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2793
|
+
if(key===undefined||key===null){throw new Error("Missing the required parameter 'key' when calling queryValidityPeriodSummaryByKey");}var pathParams={'key':key};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_ExpandedValidityPeriodSummary["default"];return this.apiClient.callApi('/object-query/validity-period-summaries/{key}','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2959
2794
|
* Query ValidityPeriodSummary by key with filters, expands, sort capabilities. Supported expands: account,prepaidbalance.
|
|
2960
2795
|
* @param {String} key Object ID or Number.
|
|
2961
2796
|
* @param {Object} opts Optional parameters
|
|
@@ -2966,7 +2801,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2966
2801
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2967
2802
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2968
2803
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
2969
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2970
2804
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2971
2805
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2972
2806
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
@@ -2983,14 +2817,13 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
2983
2817
|
* @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
2984
2818
|
* @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
2985
2819
|
* @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.
|
|
2986
|
-
* @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
2987
2820
|
* @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
2988
2821
|
* @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
2989
2822
|
* @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|
|
2990
2823
|
* @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
|
|
2991
2824
|
* @param {Array.<String>} [filter] A case-sensitive filter on the list.
|
|
2992
2825
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryValidityPeriodSummarysResponse} and HTTP response
|
|
2993
|
-
*/},{key:"queryValidityPeriodSummarysWithHttpInfo",value:function queryValidityPeriodSummarysWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']
|
|
2826
|
+
*/},{key:"queryValidityPeriodSummarysWithHttpInfo",value:function queryValidityPeriodSummarysWithHttpInfo(opts){opts=opts||{};var postBody=null;var pathParams={};var queryParams={'pageSize':opts['page_size'],'cursor':opts['cursor'],'sort[]':this.apiClient.buildCollectionParam(opts['sort'],'multi'),'expand[]':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'filter[]':this.apiClient.buildCollectionParam(opts['filter'],'multi')};var headerParams={'Idempotency-Key':opts['idempotency_key'],'Accept-Encoding':opts['accept_encoding'],'Content-Encoding':opts['content_encoding'],'Zuora-Track-Id':opts['zuora_track_id'],'Zuora-Entity-Ids':opts['zuora_entity_ids'],'Authorization':opts['authorization'],'Zuora-Version':opts['zuora_version']};var formParams={};var authNames=['bearerAuth'];var contentTypes=[];var accepts=['application/json'];var returnType=_QueryValidityPeriodSummarysResponse["default"];return this.apiClient.callApi('/object-query/validity-period-summaries','GET',pathParams,queryParams,headerParams,formParams,postBody,authNames,contentTypes,accepts,returnType,null);}/**
|
|
2994
2827
|
* Query ValidityPeriodSummarys with filters, expands, sort capabilities. Supported expands: account,prepaidbalance.
|
|
2995
2828
|
* @param {Object} opts Optional parameters
|
|
2996
2829
|
* @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
@@ -3000,7 +2833,6 @@ if(key===undefined||key===null){throw new Error("Missing the required parameter
|
|
|
3000
2833
|
* @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
3001
2834
|
* @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
3002
2835
|
* @param {String} opts.zuora_version The minor version of the Zuora REST API. (default to '2024-05-20')
|
|
3003
|
-
* @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
3004
2836
|
* @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
|
|
3005
2837
|
* @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
|
|
3006
2838
|
* @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
|