togai_client 1.0.1 → 1.0.2
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.
- checksums.yaml +4 -4
- data/README.md +3 -4
- data/docs/Account.md +26 -2
- data/docs/AccountAlias.md +28 -0
- data/docs/AccountAliases.md +1 -3
- data/docs/AccountAliasesPaginatedResponse.md +20 -0
- data/docs/AccountSchedule.md +38 -0
- data/docs/AccountsApi.md +840 -124
- data/docs/AccountsBillingInformation.md +20 -0
- data/docs/ActivatePricePlanRequest.md +18 -0
- data/docs/AddAccountAliasesRequest.md +3 -1
- data/docs/AddOn.md +30 -0
- data/docs/AddOnPaginatedResponse.md +22 -0
- data/docs/AddOnType.md +15 -0
- data/docs/AddOnsApi.md +365 -0
- data/docs/Address.md +30 -0
- data/docs/Alert.md +40 -0
- data/docs/AlertStatus.md +15 -0
- data/docs/AlertTemplate.md +38 -0
- data/docs/AlertTemplatesPaginatedResponse.md +20 -0
- data/docs/AlertsApi.md +566 -0
- data/docs/AlertsPaginatedResponse.md +20 -0
- data/docs/AliasPaginatedResponse.md +20 -0
- data/docs/AliasesApi.md +291 -0
- data/docs/AssociationConfig.md +24 -0
- data/docs/Attribute.md +22 -0
- data/docs/AuthenticationApi.md +74 -0
- data/docs/BillingConfig.md +20 -0
- data/docs/BillingEntitlementRateCard.md +34 -0
- data/docs/BillingEntitlementRevenueSummary.md +18 -0
- data/docs/BulkRateCardOperationsRequest.md +18 -0
- data/docs/BulkRateCardOperationsResponse.md +18 -0
- data/docs/CalculateRevenueRequest.md +30 -0
- data/docs/CalculateRevenueResponse.md +24 -0
- data/docs/CalculateRevenueResponseV2.md +22 -0
- data/docs/Computation.md +5 -3
- data/docs/CreateAccountAliasRequest.md +22 -0
- data/docs/CreateAccountRequest.md +27 -5
- data/docs/CreateAccountRequestWithoutCustomerId.md +42 -0
- data/docs/CreateAddOnRequest.md +22 -0
- data/docs/CreateAlertRequest.md +32 -0
- data/docs/CreateAliasRequest.md +18 -0
- data/docs/CreateBulkAliasRequest.md +18 -0
- data/docs/CreateCreditRequest.md +18 -0
- data/docs/CreateCreditResponse.md +18 -0
- data/docs/CreateCustomInvoiceRequest.md +36 -0
- data/docs/CreateCustomerContactRequest.md +30 -0
- data/docs/CreateCustomerContactResponse.md +34 -0
- data/docs/CreateCustomerRequest.md +9 -7
- data/docs/CreateCustomerResponse.md +8 -2
- data/docs/CreateEntitySetting.md +26 -0
- data/docs/CreateEventSchemaRequest.md +7 -1
- data/docs/CreateFeatureRequest.md +22 -0
- data/docs/CreateInvoiceGroupRequest.md +28 -0
- data/docs/CreatePaymentRequest.md +30 -0
- data/docs/CreatePricePlanDetails.md +38 -0
- data/docs/CreatePricePlanDetailsOverride.md +34 -0
- data/docs/CreatePricePlanMigrationRequest.md +32 -0
- data/docs/CreatePricePlanRequest.md +6 -2
- data/docs/CreatePricePlanV2Request.md +30 -0
- data/docs/CreatePricingRule.md +28 -0
- data/docs/CreateProposalRequest.md +40 -0
- data/docs/CreatePurchaseRequest.md +38 -0
- data/docs/CreateUsageMeterRequest.md +12 -6
- data/docs/Credit.md +50 -0
- data/docs/CreditBalanceResponse.md +28 -0
- data/docs/CreditDetailsResponse.md +52 -0
- data/docs/CreditGrantRateCard.md +34 -0
- data/docs/CreditGrantRevenueSummary.md +18 -0
- data/docs/CreditGrantType.md +15 -0
- data/docs/CreditRateDetails.md +20 -0
- data/docs/CreditRequest.md +34 -0
- data/docs/CreditTransaction.md +30 -0
- data/docs/CreditsApi.md +369 -0
- data/docs/CurrencyConfig.md +22 -0
- data/docs/CurrencyRateValue.md +20 -0
- data/docs/CurrencySlabRateDetail.md +24 -0
- data/docs/CustomInvoiceLineItem.md +28 -0
- data/docs/Customer.md +6 -2
- data/docs/CustomerPortalApi.md +77 -0
- data/docs/CustomersApi.md +85 -13
- data/docs/Dependency.md +22 -0
- data/docs/EditAccountScheduleRequest.md +18 -0
- data/docs/EditPricingScheduleRequest.md +18 -0
- data/docs/EnrichedField.md +22 -0
- data/docs/EnrichmentDependency.md +24 -0
- data/docs/Enrichments.md +20 -0
- data/docs/EntitlementOverageConfig.md +22 -0
- data/docs/EntitlementOverageConfigLookupCycle.md +20 -0
- data/docs/EntitlementOverageEntry.md +20 -0
- data/docs/EntitlementOverageRateCard.md +32 -0
- data/docs/EntitlementOverageRevenueSummary.md +18 -0
- data/docs/EntitlementsApi.md +599 -0
- data/docs/Event.md +11 -11
- data/docs/EventCorrectionInfo.md +32 -0
- data/docs/EventCorrectionRequest.md +18 -0
- data/docs/EventIngestionApi.md +16 -15
- data/docs/EventManagementApi.md +95 -21
- data/docs/EventPipelineInfo.md +15 -3
- data/docs/EventPipelineInfoAccount.md +3 -1
- data/docs/EventPipelineInfoEnrichments.md +22 -0
- data/docs/EventPipelineInfoFeatureDetails.md +24 -0
- data/docs/EventPipelineInfoPricePlans.md +28 -0
- data/docs/EventPipelineInfoRevenueDetails.md +22 -0
- data/docs/EventPipelineInfoUsageMeters.md +26 -0
- data/docs/EventSchema.md +11 -1
- data/docs/EventSchemaListData.md +11 -1
- data/docs/EventSchemasApi.md +82 -84
- data/docs/EventSchemasForFeature.md +20 -0
- data/docs/EventSource.md +20 -0
- data/docs/EventWithStatus.md +9 -1
- data/docs/EventWithStatusAndEventPipelineInfo.md +9 -1
- data/docs/EventsCorrectionResponse.md +18 -0
- data/docs/ExpiryType.md +15 -0
- data/docs/ExternalPaymentReference.md +26 -0
- data/docs/Feature.md +30 -0
- data/docs/FeatureApi.md +293 -0
- data/docs/FeatureConfig.md +22 -0
- data/docs/FeatureCreditEntry.md +32 -0
- data/docs/FeatureDetails.md +20 -0
- data/docs/FeatureListResponse.md +30 -0
- data/docs/FeaturePaginatedListData.md +22 -0
- data/docs/Field.md +26 -0
- data/docs/FileDownloadUrlResponse.md +18 -0
- data/docs/FileStorageApi.md +151 -0
- data/docs/FinalizeAccountSchedules.md +20 -0
- data/docs/FinalizePricePlanRequest.md +20 -0
- data/docs/FixedFeeRateCard.md +34 -0
- data/docs/FixedFeeRevenueSummary.md +18 -0
- data/docs/FixedFeeType.md +15 -0
- data/docs/GetCustomerPortalDelegateTokenRequest.md +24 -0
- data/docs/GetEntitlementValuesResponse.md +18 -0
- data/docs/GetEntitlementValuesResponseDataInner.md +20 -0
- data/docs/GetFeatureCreditEntriesPaginatedResponse.md +20 -0
- data/docs/GetFeatureCreditsResponse.md +28 -0
- data/docs/GetJobResponse.md +36 -0
- data/docs/GetLicenseUpdatesResponse.md +20 -0
- data/docs/GetMetricsRequest.md +4 -4
- data/docs/GetProposalResponse.md +62 -0
- data/docs/GetPurchaseResponse.md +62 -0
- data/docs/GrantDetails.md +24 -0
- data/docs/Incident.md +36 -0
- data/docs/IncidentsPaginatedResponse.md +20 -0
- data/docs/IngestEventRequest.md +1 -1
- data/docs/IngestEventResponse.md +12 -2
- data/docs/Invoice.md +68 -0
- data/docs/InvoiceDetails.md +28 -0
- data/docs/InvoiceDetailsAccount.md +24 -0
- data/docs/InvoiceDetailsCustomer.md +24 -0
- data/docs/InvoiceDetailsInvoiceGroup.md +28 -0
- data/docs/InvoiceDetailsOrganization.md +24 -0
- data/docs/InvoiceGroupAccountsPaginatedResponse.md +40 -0
- data/docs/InvoiceGroupDetails.md +30 -0
- data/docs/InvoiceGroupPaginatedResponse.md +20 -0
- data/docs/InvoiceGroups.md +36 -0
- data/docs/InvoiceGroupsApi.md +358 -0
- data/docs/InvoiceInfoInner.md +20 -0
- data/docs/InvoiceLineItem.md +34 -0
- data/docs/InvoiceSummary.md +58 -0
- data/docs/InvoiceTiming.md +15 -0
- data/docs/InvoicesApi.md +751 -0
- data/docs/InvoicesClass.md +15 -0
- data/docs/InvoicesStatus.md +15 -0
- data/docs/InvoicesType.md +15 -0
- data/docs/JobEntriesPaginatedResponse.md +22 -0
- data/docs/JobEntriesResponse.md +26 -0
- data/docs/JobsApi.md +361 -0
- data/docs/JobsPaginatedResponse.md +22 -0
- data/docs/JobsWithoutStatusInfoResponse.md +24 -0
- data/docs/LicenseEntriesConfig.md +24 -0
- data/docs/LicenseEntriesConfigLookupCycle.md +20 -0
- data/docs/LicenseEntriesConfigLookupRange.md +22 -0
- data/docs/LicenseEntry.md +22 -0
- data/docs/LicenseEntryDetailsUpdateRequest.md +22 -0
- data/docs/LicenseRateCard.md +40 -0
- data/docs/LicenseRateCardConfig.md +20 -0
- data/docs/LicenseUpdate.md +26 -0
- data/docs/LicenseUpdateRequest.md +30 -0
- data/docs/LicenseUpdateResponse.md +28 -0
- data/docs/LicensesApi.md +300 -0
- data/docs/ListCreditsResponse.md +20 -0
- data/docs/ListInvoicesResponse.md +20 -0
- data/docs/ListPaymentResponse.md +20 -0
- data/docs/ManageMiscellaneousChargesRequest.md +18 -0
- data/docs/MaxQuantityBreachAction.md +15 -0
- data/docs/MetricQuery.md +7 -5
- data/docs/MetricQueryFilterEntry.md +1 -1
- data/docs/MetricQueryResponse.md +1 -1
- data/docs/MetricsApi.md +7 -7
- data/docs/MigrationMode.md +15 -0
- data/docs/MinimumCommitment.md +20 -0
- data/docs/MiscellaneousCharge.md +26 -0
- data/docs/MiscellaneousChargesResponse.md +18 -0
- data/docs/ModelAlias.md +20 -0
- data/docs/NamedLicenseEntriesConfig.md +24 -0
- data/docs/NamedLicenseEntriesConfigLookupCycle.md +20 -0
- data/docs/NamedLicenseEntriesConfigLookupRange.md +22 -0
- data/docs/NamedLicenseEntry.md +24 -0
- data/docs/NamedLicenseUpdate.md +32 -0
- data/docs/NamedLicenseUpdatesPaginatedResponse.md +20 -0
- data/docs/Payment.md +38 -0
- data/docs/PaymentLineItemRecord.md +24 -0
- data/docs/PaymentsApi.md +227 -0
- data/docs/PlanOverride.md +6 -0
- data/docs/PreAction.md +20 -0
- data/docs/PriceExperimentationApi.md +147 -0
- data/docs/PricePlan.md +4 -0
- data/docs/PricePlanDetails.md +25 -3
- data/docs/PricePlanDetailsConfig.md +28 -0
- data/docs/PricePlanDetailsOverride.md +16 -2
- data/docs/PricePlanInfo.md +20 -0
- data/docs/PricePlanListData.md +10 -2
- data/docs/PricePlanMigrationConfig.md +30 -0
- data/docs/PricePlanType.md +15 -0
- data/docs/PricePlanV2.md +42 -0
- data/docs/PricePlanV2Api.md +953 -0
- data/docs/PricePlanV2PaginatedResponse.md +20 -0
- data/docs/PricePlansApi.md +202 -52
- data/docs/PricingCycleConfig.md +6 -6
- data/docs/PricingCycleConfigStartOffset.md +1 -1
- data/docs/PricingCycleInterval.md +15 -0
- data/docs/PricingRule.md +32 -0
- data/docs/PricingRuleAction.md +26 -0
- data/docs/PricingRuleChangesLog.md +30 -0
- data/docs/PricingRuleInfo.md +24 -0
- data/docs/PricingRuleTiming.md +15 -0
- data/docs/PricingRulesApi.md +83 -0
- data/docs/PricingRulesLog.md +28 -0
- data/docs/PricingRulesLogsPaginatedResponse.md +18 -0
- data/docs/PricingRulesPaginatedResponse.md +18 -0
- data/docs/PricingRulesValues.md +20 -0
- data/docs/PricingSchedule.md +9 -1
- data/docs/PricingSchedulePaginatedResponse.md +22 -0
- data/docs/PricingScheduleWithPricePlanId.md +36 -0
- data/docs/Proposal.md +62 -0
- data/docs/ProposalsListResponse.md +40 -0
- data/docs/ProposalsPaginatedResponse.md +22 -0
- data/docs/ProratedRefundMode.md +15 -0
- data/docs/ProrationConfig.md +22 -0
- data/docs/ProrationConfigCustomConfig.md +22 -0
- data/docs/ProrationConfigLookupCycleConfig.md +22 -0
- data/docs/Purchase.md +58 -0
- data/docs/PurchaseFeatureDetails.md +30 -0
- data/docs/PurchaseListResponse.md +46 -0
- data/docs/PurchasePaginatedListData.md +22 -0
- data/docs/PurchasePlanOverride.md +22 -0
- data/docs/PurchaseStatus.md +15 -0
- data/docs/PurchaseType.md +15 -0
- data/docs/QueryColumn.md +26 -0
- data/docs/QueryFilter.md +22 -0
- data/docs/QueryFunction.md +20 -0
- data/docs/QueryInput.md +28 -0
- data/docs/QueryInputSortInner.md +20 -0
- data/docs/RateCard.md +23 -5
- data/docs/RateCardData.md +28 -0
- data/docs/RateCardDetails.md +30 -0
- data/docs/RateCardOperation.md +22 -0
- data/docs/RateCardPaginatedResponse.md +20 -0
- data/docs/RatePlan.md +20 -0
- data/docs/RateValue.md +22 -0
- data/docs/RecurrenceConfig.md +20 -0
- data/docs/RemoveAccountAliasRequest.md +20 -0
- data/docs/RemoveAccountAliasesRequest.md +4 -2
- data/docs/Report.md +38 -0
- data/docs/ReportStatus.md +15 -0
- data/docs/ReportType.md +15 -0
- data/docs/ReportsApi.md +83 -0
- data/docs/ReportsPaginatedResponse.md +20 -0
- data/docs/RevenueInfo.md +42 -0
- data/docs/RevenueInfoV2.md +32 -0
- data/docs/RevenueSummaryWithMetadata.md +24 -0
- data/docs/ScheduleInfo.md +22 -0
- data/docs/SchedulesApi.md +667 -0
- data/docs/SchedulesPaginatedResponse.md +22 -0
- data/docs/Setting.md +30 -0
- data/docs/SettingDataType.md +15 -0
- data/docs/SettingPaginatedResponse.md +22 -0
- data/docs/SettingsApi.md +301 -0
- data/docs/Slab.md +24 -0
- data/docs/SlabDetail.md +26 -0
- data/docs/SlabRate.md +22 -0
- data/docs/SlabRevenue.md +22 -0
- data/docs/SlabRevenueMetadata.md +22 -0
- data/docs/SlabRevenueSummary.md +24 -0
- data/docs/SlabRevenueWithMetadata.md +24 -0
- data/docs/TokenResponse.md +18 -0
- data/docs/TopupWalletRequest.md +18 -0
- data/docs/UpdateAccountRequest.md +18 -2
- data/docs/UpdateAccountScheduleV2Request.md +26 -0
- data/docs/UpdateAddOnRequest.md +20 -0
- data/docs/UpdateAlertRequest.md +26 -0
- data/docs/UpdateCustomerRequest.md +5 -5
- data/docs/UpdateEventSchemaRequest.md +9 -3
- data/docs/UpdateFeatureCreditsRequest.md +20 -0
- data/docs/UpdateFeatureRequest.md +22 -0
- data/docs/UpdateIncidentStatusRequest.md +18 -0
- data/docs/UpdateInvoiceGroupAccounts.md +18 -0
- data/docs/UpdateInvoiceRequest.md +26 -0
- data/docs/UpdatePricePlanRequest.md +8 -2
- data/docs/UpdatePricePlanV2Request.md +22 -0
- data/docs/UpdatePricingRulesRequest.md +18 -0
- data/docs/UpdatePricingScheduleRequest.md +30 -0
- data/docs/UpdatePricingScheduleRequestWithActions.md +32 -0
- data/docs/UpdatePricingScheduleResponse.md +22 -0
- data/docs/UpdateProposalStatus.md +18 -0
- data/docs/UpdateSettingRequest.md +22 -0
- data/docs/UpdateUsageMeterRequest.md +13 -5
- data/docs/UpdateWalletRequest.md +20 -0
- data/docs/UsageConfig.md +24 -0
- data/docs/UsageConfigLookupCycle.md +20 -0
- data/docs/UsageConfigLookupRange.md +22 -0
- data/docs/UsageCycleInterval.md +15 -0
- data/docs/UsageLookupRange.md +20 -0
- data/docs/UsageMeter.md +12 -2
- data/docs/UsageMeterAggregation.md +15 -0
- data/docs/UsageMeterFilterEntry.md +20 -0
- data/docs/UsageMetersApi.md +64 -74
- data/docs/UsageRateCard.md +28 -0
- data/docs/ValidateEntitlementValueRequest.md +18 -0
- data/docs/ValidatedEntityError.md +24 -0
- data/docs/ValidatedEntityErrorsPaginatedResponse.md +20 -0
- data/docs/VersionsToMigrate.md +15 -0
- data/docs/WalletApi.md +301 -0
- data/docs/WalletBalanceResponse.md +40 -0
- data/docs/WalletEntriesPaginatedResponse.md +20 -0
- data/docs/WalletEntry.md +34 -0
- data/docs/WalletStatus.md +15 -0
- data/docs/WalletTopupDetails.md +20 -0
- data/lib/togai_client/api/accounts_api.rb +881 -220
- data/lib/togai_client/api/add_ons_api.rb +372 -0
- data/lib/togai_client/api/alerts_api.rb +527 -0
- data/lib/togai_client/api/aliases_api.rb +279 -0
- data/lib/togai_client/api/authentication_api.rb +79 -0
- data/lib/togai_client/api/credits_api.rb +351 -0
- data/lib/togai_client/api/customer_portal_api.rb +90 -0
- data/lib/togai_client/api/customers_api.rb +96 -18
- data/lib/togai_client/api/entitlements_api.rb +655 -0
- data/lib/togai_client/api/event_ingestion_api.rb +15 -15
- data/lib/togai_client/api/event_management_api.rb +97 -21
- data/lib/togai_client/api/event_schemas_api.rb +104 -107
- data/lib/togai_client/api/feature_api.rb +298 -0
- data/lib/togai_client/api/file_storage_api.rb +151 -0
- data/lib/togai_client/api/invoice_groups_api.rb +370 -0
- data/lib/togai_client/api/invoices_api.rb +705 -0
- data/lib/togai_client/api/jobs_api.rb +337 -0
- data/lib/togai_client/api/licenses_api.rb +282 -0
- data/lib/togai_client/api/metrics_api.rb +6 -6
- data/lib/togai_client/api/payments_api.rb +215 -0
- data/lib/togai_client/api/price_experimentation_api.rb +158 -0
- data/lib/togai_client/api/price_plan_v2_api.rb +960 -0
- data/lib/togai_client/api/price_plans_api.rb +214 -62
- data/lib/togai_client/api/pricing_rules_api.rb +106 -0
- data/lib/togai_client/api/reports_api.rb +92 -0
- data/lib/togai_client/api/schedules_api.rb +685 -0
- data/lib/togai_client/api/settings_api.rb +302 -0
- data/lib/togai_client/api/usage_meters_api.rb +97 -153
- data/lib/togai_client/api/wallet_api.rb +310 -0
- data/lib/togai_client/api_client.rb +25 -23
- data/lib/togai_client/api_error.rb +2 -1
- data/lib/togai_client/configuration.rb +51 -18
- data/lib/togai_client/models/account.rb +260 -28
- data/lib/togai_client/models/account_alias.rb +329 -0
- data/lib/togai_client/models/account_aliases.rb +23 -67
- data/lib/togai_client/models/account_aliases_paginated_response.rb +233 -0
- data/lib/togai_client/models/account_paginated_response.rb +14 -19
- data/lib/togai_client/models/account_schedule.rb +375 -0
- data/lib/togai_client/models/accounts_billing_information.rb +228 -0
- data/lib/togai_client/models/activate_price_plan_request.rb +235 -0
- data/lib/togai_client/models/add_account_aliases_request.rb +64 -25
- data/lib/togai_client/models/add_on.rb +395 -0
- data/lib/togai_client/models/add_on_paginated_response.rb +241 -0
- data/lib/togai_client/models/add_on_type.rb +42 -0
- data/lib/togai_client/models/address.rb +276 -0
- data/lib/togai_client/models/alert.rb +391 -0
- data/lib/togai_client/models/alert_status.rb +40 -0
- data/lib/togai_client/models/alert_template.rb +343 -0
- data/lib/togai_client/models/alert_templates_paginated_response.rb +232 -0
- data/lib/togai_client/models/alerts_paginated_response.rb +232 -0
- data/lib/togai_client/models/alias_paginated_response.rb +226 -0
- data/lib/togai_client/models/association_config.rb +244 -0
- data/lib/togai_client/models/attribute.rb +327 -0
- data/lib/togai_client/models/base_success_response.rb +16 -19
- data/lib/togai_client/models/billing_config.rb +225 -0
- data/lib/togai_client/models/billing_entitlement_rate_card.rb +370 -0
- data/lib/togai_client/models/billing_entitlement_revenue_summary.rb +221 -0
- data/lib/togai_client/models/bulk_rate_card_operations_request.rb +224 -0
- data/lib/togai_client/models/bulk_rate_card_operations_response.rb +224 -0
- data/lib/togai_client/models/calculate_revenue_request.rb +297 -0
- data/lib/togai_client/models/calculate_revenue_response.rb +264 -0
- data/lib/togai_client/models/calculate_revenue_response_v2.rb +248 -0
- data/lib/togai_client/models/computation.rb +49 -27
- data/lib/togai_client/models/create_account_alias_request.rb +270 -0
- data/lib/togai_client/models/create_account_request.rb +306 -27
- data/lib/togai_client/models/create_account_request_without_customer_id.rb +551 -0
- data/lib/togai_client/models/create_add_on_request.rb +309 -0
- data/lib/togai_client/models/create_alert_request.rb +327 -0
- data/lib/togai_client/models/create_alias_request.rb +241 -0
- data/lib/togai_client/models/create_bulk_alias_request.rb +252 -0
- data/lib/togai_client/models/create_credit_request.rb +224 -0
- data/lib/togai_client/models/create_credit_response.rb +223 -0
- data/lib/togai_client/models/create_custom_invoice_request.rb +411 -0
- data/lib/togai_client/models/create_customer_contact_request.rb +402 -0
- data/lib/togai_client/models/create_customer_contact_response.rb +435 -0
- data/lib/togai_client/models/create_customer_request.rb +69 -47
- data/lib/togai_client/models/create_customer_response.rb +81 -40
- data/lib/togai_client/models/create_entity_setting.rb +308 -0
- data/lib/togai_client/models/create_event_schema_request.rb +70 -24
- data/lib/togai_client/models/create_feature_request.rb +309 -0
- data/lib/togai_client/models/create_invoice_group_request.rb +344 -0
- data/lib/togai_client/models/create_payment_request.rb +394 -0
- data/lib/togai_client/models/create_price_plan_details.rb +339 -0
- data/lib/togai_client/models/create_price_plan_details_override.rb +319 -0
- data/lib/togai_client/models/create_price_plan_migration_request.rb +385 -0
- data/lib/togai_client/models/create_price_plan_request.rb +69 -24
- data/lib/togai_client/models/create_price_plan_v2_request.rb +367 -0
- data/lib/togai_client/models/create_pricing_rule.rb +313 -0
- data/lib/togai_client/models/create_proposal_request.rb +371 -0
- data/lib/togai_client/models/create_purchase_request.rb +330 -0
- data/lib/togai_client/models/create_usage_meter_request.rb +85 -42
- data/lib/togai_client/models/credit.rb +490 -0
- data/lib/togai_client/models/credit_balance_response.rb +302 -0
- data/lib/togai_client/models/credit_details_response.rb +508 -0
- data/lib/togai_client/models/credit_grant_rate_card.rb +332 -0
- data/lib/togai_client/models/credit_grant_revenue_summary.rb +221 -0
- data/lib/togai_client/models/credit_grant_type.rb +40 -0
- data/lib/togai_client/models/credit_rate_details.rb +262 -0
- data/lib/togai_client/models/credit_request.rb +330 -0
- data/lib/togai_client/models/credit_transaction.rb +357 -0
- data/lib/togai_client/models/currency_config.rb +296 -0
- data/lib/togai_client/models/currency_rate_value.rb +237 -0
- data/lib/togai_client/models/currency_slab_rate_detail.rb +287 -0
- data/lib/togai_client/models/custom_invoice_line_item.rb +260 -0
- data/lib/togai_client/models/customer.rb +68 -26
- data/lib/togai_client/models/customer_paginated_response.rb +14 -19
- data/lib/togai_client/models/dependency.rb +287 -0
- data/lib/togai_client/models/dimensions_schema.rb +16 -19
- data/lib/togai_client/models/edit_account_schedule_request.rb +252 -0
- data/lib/togai_client/models/edit_pricing_schedule_request.rb +252 -0
- data/lib/togai_client/models/enriched_field.rb +288 -0
- data/lib/togai_client/models/enrichment_dependency.rb +297 -0
- data/lib/togai_client/models/enrichments.rb +234 -0
- data/lib/togai_client/models/entitlement_overage_config.rb +278 -0
- data/lib/togai_client/models/entitlement_overage_config_lookup_cycle.rb +258 -0
- data/lib/togai_client/models/entitlement_overage_entry.rb +256 -0
- data/lib/togai_client/models/entitlement_overage_rate_card.rb +324 -0
- data/lib/togai_client/models/entitlement_overage_revenue_summary.rb +221 -0
- data/lib/togai_client/models/error_response.rb +16 -19
- data/lib/togai_client/models/event.rb +104 -84
- data/lib/togai_client/models/event_attribute_schema.rb +22 -21
- data/lib/togai_client/models/event_correction_info.rb +384 -0
- data/lib/togai_client/models/event_correction_request.rb +215 -0
- data/lib/togai_client/models/event_pipeline_info.rb +76 -25
- data/lib/togai_client/models/event_pipeline_info_account.rb +31 -23
- data/lib/togai_client/models/event_pipeline_info_customer.rb +18 -19
- data/lib/togai_client/models/event_pipeline_info_enrichments.rb +238 -0
- data/lib/togai_client/models/event_pipeline_info_event_schema.rb +18 -19
- data/lib/togai_client/models/event_pipeline_info_feature_details.rb +255 -0
- data/lib/togai_client/models/event_pipeline_info_price_plans.rb +306 -0
- data/lib/togai_client/models/event_pipeline_info_revenue_details.rb +253 -0
- data/lib/togai_client/models/event_pipeline_info_usage_meters.rb +312 -0
- data/lib/togai_client/models/event_schema.rb +89 -29
- data/lib/togai_client/models/event_schema_list_data.rb +90 -31
- data/lib/togai_client/models/event_schema_list_paginated_response.rb +14 -19
- data/lib/togai_client/models/event_schema_versions_response.rb +16 -19
- data/lib/togai_client/models/event_schemas_for_feature.rb +259 -0
- data/lib/togai_client/models/event_source.rb +278 -0
- data/lib/togai_client/models/event_with_status.rb +94 -23
- data/lib/togai_client/models/event_with_status_and_event_pipeline_info.rb +100 -23
- data/lib/togai_client/models/events_correction_response.rb +252 -0
- data/lib/togai_client/models/expiry_type.rb +41 -0
- data/lib/togai_client/models/external_payment_reference.rb +309 -0
- data/lib/togai_client/models/feature.rb +365 -0
- data/lib/togai_client/models/feature_config.rb +266 -0
- data/lib/togai_client/models/feature_credit_entry.rb +387 -0
- data/lib/togai_client/models/feature_details.rb +238 -0
- data/lib/togai_client/models/feature_list_response.rb +343 -0
- data/lib/togai_client/models/feature_paginated_list_data.rb +234 -0
- data/lib/togai_client/models/field.rb +331 -0
- data/lib/togai_client/models/file_download_url_response.rb +221 -0
- data/lib/togai_client/models/finalize_account_schedules.rb +228 -0
- data/lib/togai_client/models/finalize_price_plan_request.rb +246 -0
- data/lib/togai_client/models/fixed_fee_rate_card.rb +354 -0
- data/lib/togai_client/models/fixed_fee_revenue_summary.rb +221 -0
- data/lib/togai_client/models/fixed_fee_type.rb +40 -0
- data/lib/togai_client/models/get_customer_portal_delegate_token_request.rb +255 -0
- data/lib/togai_client/models/get_entitlement_values_response.rb +223 -0
- data/lib/togai_client/models/get_entitlement_values_response_data_inner.rb +239 -0
- data/lib/togai_client/models/get_event_response.rb +16 -19
- data/lib/togai_client/models/get_events_response.rb +21 -20
- data/lib/togai_client/models/get_feature_credit_entries_paginated_response.rb +225 -0
- data/lib/togai_client/models/get_feature_credits_response.rb +333 -0
- data/lib/togai_client/models/get_job_response.rb +399 -0
- data/lib/togai_client/models/get_license_updates_response.rb +252 -0
- data/lib/togai_client/models/get_metrics_request.rb +22 -19
- data/lib/togai_client/models/get_metrics_response.rb +16 -19
- data/lib/togai_client/models/get_proposal_response.rb +536 -0
- data/lib/togai_client/models/get_purchase_response.rb +519 -0
- data/lib/togai_client/models/grant_details.rb +299 -0
- data/lib/togai_client/models/incident.rb +347 -0
- data/lib/togai_client/models/incidents_paginated_response.rb +232 -0
- data/lib/togai_client/models/ingest_batch_event_request.rb +21 -24
- data/lib/togai_client/models/ingest_event_request.rb +21 -19
- data/lib/togai_client/models/ingest_event_response.rb +76 -42
- data/lib/togai_client/models/ingestion_status.rb +23 -22
- data/lib/togai_client/models/invoice.rb +571 -0
- data/lib/togai_client/models/invoice_details.rb +259 -0
- data/lib/togai_client/models/invoice_details_account.rb +269 -0
- data/lib/togai_client/models/invoice_details_customer.rb +255 -0
- data/lib/togai_client/models/invoice_details_invoice_group.rb +294 -0
- data/lib/togai_client/models/invoice_details_organization.rb +264 -0
- data/lib/togai_client/models/invoice_group_accounts_paginated_response.rb +430 -0
- data/lib/togai_client/models/invoice_group_details.rb +330 -0
- data/lib/togai_client/models/invoice_group_paginated_response.rb +225 -0
- data/lib/togai_client/models/invoice_groups.rb +403 -0
- data/lib/togai_client/models/invoice_info_inner.rb +239 -0
- data/lib/togai_client/models/invoice_line_item.rb +381 -0
- data/lib/togai_client/models/invoice_summary.rb +520 -0
- data/lib/togai_client/models/invoice_timing.rb +41 -0
- data/lib/togai_client/models/invoices_class.rb +41 -0
- data/lib/togai_client/models/invoices_status.rb +47 -0
- data/lib/togai_client/models/invoices_type.rb +44 -0
- data/lib/togai_client/models/job_entries_paginated_response.rb +234 -0
- data/lib/togai_client/models/job_entries_response.rb +314 -0
- data/lib/togai_client/models/jobs_paginated_response.rb +234 -0
- data/lib/togai_client/models/jobs_without_status_info_response.rb +269 -0
- data/lib/togai_client/models/license_entries_config.rb +287 -0
- data/lib/togai_client/models/license_entries_config_lookup_cycle.rb +251 -0
- data/lib/togai_client/models/license_entries_config_lookup_range.rb +273 -0
- data/lib/togai_client/models/license_entry.rb +272 -0
- data/lib/togai_client/models/license_entry_details_update_request.rb +277 -0
- data/lib/togai_client/models/license_rate_card.rb +388 -0
- data/lib/togai_client/models/license_rate_card_config.rb +246 -0
- data/lib/togai_client/models/license_update.rb +320 -0
- data/lib/togai_client/models/license_update_request.rb +377 -0
- data/lib/togai_client/models/license_update_response.rb +342 -0
- data/lib/togai_client/models/list_credits_response.rb +280 -0
- data/lib/togai_client/models/list_invoices_response.rb +280 -0
- data/lib/togai_client/models/list_payment_response.rb +280 -0
- data/lib/togai_client/models/manage_miscellaneous_charges_request.rb +224 -0
- data/lib/togai_client/models/max_quantity_breach_action.rb +39 -0
- data/lib/togai_client/models/metric_data_points.rb +28 -29
- data/lib/togai_client/models/metric_data_points_grouped_by.rb +18 -19
- data/lib/togai_client/models/metric_name.rb +11 -4
- data/lib/togai_client/models/metric_query.rb +45 -24
- data/lib/togai_client/models/metric_query_filter_entry.rb +19 -20
- data/lib/togai_client/models/metric_query_response.rb +42 -19
- data/lib/togai_client/models/migration_mode.rb +44 -0
- data/lib/togai_client/models/minimum_commitment.rb +258 -0
- data/lib/togai_client/models/miscellaneous_charge.rb +265 -0
- data/lib/togai_client/models/miscellaneous_charges_response.rb +224 -0
- data/lib/togai_client/models/model_alias.rb +238 -0
- data/lib/togai_client/models/named_license_entries_config.rb +287 -0
- data/lib/togai_client/models/named_license_entries_config_lookup_cycle.rb +251 -0
- data/lib/togai_client/models/named_license_entries_config_lookup_range.rb +273 -0
- data/lib/togai_client/models/named_license_entry.rb +281 -0
- data/lib/togai_client/models/named_license_update.rb +396 -0
- data/lib/togai_client/models/named_license_updates_paginated_response.rb +252 -0
- data/lib/togai_client/models/pagination_options.rb +14 -19
- data/lib/togai_client/models/payment.rb +380 -0
- data/lib/togai_client/models/payment_line_item_record.rb +290 -0
- data/lib/togai_client/models/plan_override.rb +64 -20
- data/lib/togai_client/models/pre_action.rb +269 -0
- data/lib/togai_client/models/price_plan.rb +59 -21
- data/lib/togai_client/models/price_plan_details.rb +182 -45
- data/lib/togai_client/models/price_plan_details_config.rb +344 -0
- data/lib/togai_client/models/price_plan_details_override.rb +135 -35
- data/lib/togai_client/models/price_plan_info.rb +230 -0
- data/lib/togai_client/models/price_plan_list_data.rb +116 -25
- data/lib/togai_client/models/price_plan_migration_config.rb +368 -0
- data/lib/togai_client/models/price_plan_paginated_response.rb +16 -19
- data/lib/togai_client/models/price_plan_type.rb +40 -0
- data/lib/togai_client/models/price_plan_v2.rb +519 -0
- data/lib/togai_client/models/price_plan_v2_paginated_response.rb +233 -0
- data/lib/togai_client/models/price_type.rb +7 -4
- data/lib/togai_client/models/pricing_cycle_config.rb +34 -67
- data/lib/togai_client/models/pricing_cycle_config_start_offset.rb +20 -21
- data/lib/togai_client/models/pricing_cycle_interval.rb +43 -0
- data/lib/togai_client/models/pricing_model.rb +7 -4
- data/lib/togai_client/models/pricing_rule.rb +382 -0
- data/lib/togai_client/models/pricing_rule_action.rb +293 -0
- data/lib/togai_client/models/pricing_rule_changes_log.rb +290 -0
- data/lib/togai_client/models/pricing_rule_info.rb +249 -0
- data/lib/togai_client/models/pricing_rule_timing.rb +40 -0
- data/lib/togai_client/models/pricing_rules_log.rb +318 -0
- data/lib/togai_client/models/pricing_rules_logs_paginated_response.rb +224 -0
- data/lib/togai_client/models/pricing_rules_paginated_response.rb +223 -0
- data/lib/togai_client/models/pricing_rules_values.rb +223 -0
- data/lib/togai_client/models/pricing_schedule.rb +100 -23
- data/lib/togai_client/models/pricing_schedule_paginated_response.rb +234 -0
- data/lib/togai_client/models/pricing_schedule_with_price_plan_id.rb +365 -0
- data/lib/togai_client/models/proposal.rb +536 -0
- data/lib/togai_client/models/proposals_list_response.rb +390 -0
- data/lib/togai_client/models/proposals_paginated_response.rb +234 -0
- data/lib/togai_client/models/prorated_refund_mode.rb +42 -0
- data/lib/togai_client/models/proration_config.rb +275 -0
- data/lib/togai_client/models/proration_config_custom_config.rb +254 -0
- data/lib/togai_client/models/proration_config_lookup_cycle_config.rb +261 -0
- data/lib/togai_client/models/purchase.rb +493 -0
- data/lib/togai_client/models/purchase_feature_details.rb +317 -0
- data/lib/togai_client/models/purchase_list_response.rb +393 -0
- data/lib/togai_client/models/purchase_paginated_list_data.rb +234 -0
- data/lib/togai_client/models/purchase_plan_override.rb +296 -0
- data/lib/togai_client/models/purchase_status.rb +46 -0
- data/lib/togai_client/models/purchase_type.rb +42 -0
- data/lib/togai_client/models/query_column.rb +259 -0
- data/lib/togai_client/models/query_filter.rb +255 -0
- data/lib/togai_client/models/query_function.rb +239 -0
- data/lib/togai_client/models/query_input.rb +295 -0
- data/lib/togai_client/models/query_input_sort_inner.rb +237 -0
- data/lib/togai_client/models/rate_card.rb +342 -38
- data/lib/togai_client/models/rate_card_data.rb +370 -0
- data/lib/togai_client/models/rate_card_details.rb +269 -0
- data/lib/togai_client/models/rate_card_operation.rb +302 -0
- data/lib/togai_client/models/rate_card_paginated_response.rb +233 -0
- data/lib/togai_client/models/rate_card_type.rb +13 -5
- data/lib/togai_client/models/rate_plan.rb +282 -0
- data/lib/togai_client/models/rate_value.rb +270 -0
- data/lib/togai_client/models/recurrence_config.rb +225 -0
- data/lib/togai_client/models/remove_account_alias_request.rb +232 -0
- data/lib/togai_client/models/remove_account_aliases_request.rb +30 -49
- data/lib/togai_client/models/report.rb +362 -0
- data/lib/togai_client/models/report_status.rb +43 -0
- data/lib/togai_client/models/report_type.rb +41 -0
- data/lib/togai_client/models/reports_paginated_response.rb +226 -0
- data/lib/togai_client/models/revenue_info.rb +335 -0
- data/lib/togai_client/models/revenue_info_v2.rb +297 -0
- data/lib/togai_client/models/revenue_summary_with_metadata.rb +255 -0
- data/lib/togai_client/models/schedule_info.rb +250 -0
- data/lib/togai_client/models/schedules_paginated_response.rb +241 -0
- data/lib/togai_client/models/setting.rb +340 -0
- data/lib/togai_client/models/setting_data_type.rb +42 -0
- data/lib/togai_client/models/setting_paginated_response.rb +234 -0
- data/lib/togai_client/models/slab.rb +315 -0
- data/lib/togai_client/models/slab_detail.rb +298 -0
- data/lib/togai_client/models/slab_rate.rb +249 -0
- data/lib/togai_client/models/slab_revenue.rb +281 -0
- data/lib/togai_client/models/slab_revenue_metadata.rb +232 -0
- data/lib/togai_client/models/slab_revenue_summary.rb +262 -0
- data/lib/togai_client/models/slab_revenue_with_metadata.rb +299 -0
- data/lib/togai_client/models/token_response.rb +221 -0
- data/lib/togai_client/models/topup_wallet_request.rb +222 -0
- data/lib/togai_client/models/update_account_request.rb +196 -26
- data/lib/togai_client/models/update_account_schedule_v2_request.rb +303 -0
- data/lib/togai_client/models/update_add_on_request.rb +264 -0
- data/lib/togai_client/models/update_alert_request.rb +274 -0
- data/lib/togai_client/models/update_customer_request.rb +36 -49
- data/lib/togai_client/models/update_event_schema_request.rb +68 -38
- data/lib/togai_client/models/update_feature_credits_request.rb +225 -0
- data/lib/togai_client/models/update_feature_request.rb +295 -0
- data/lib/togai_client/models/update_incident_status_request.rb +256 -0
- data/lib/togai_client/models/update_invoice_group_accounts.rb +252 -0
- data/lib/togai_client/models/update_invoice_request.rb +317 -0
- data/lib/togai_client/models/update_price_plan_request.rb +81 -25
- data/lib/togai_client/models/update_price_plan_v2_request.rb +266 -0
- data/lib/togai_client/models/update_pricing_rules_request.rb +216 -0
- data/lib/togai_client/models/update_pricing_schedule_request.rb +323 -0
- data/lib/togai_client/models/update_pricing_schedule_request_with_actions.rb +343 -0
- data/lib/togai_client/models/update_pricing_schedule_response.rb +276 -0
- data/lib/togai_client/models/update_proposal_status.rb +256 -0
- data/lib/togai_client/models/update_setting_request.rb +255 -0
- data/lib/togai_client/models/update_usage_meter_request.rb +105 -50
- data/lib/togai_client/models/update_wallet_request.rb +246 -0
- data/lib/togai_client/models/usage_config.rb +287 -0
- data/lib/togai_client/models/usage_config_lookup_cycle.rb +250 -0
- data/lib/togai_client/models/usage_config_lookup_range.rb +273 -0
- data/lib/togai_client/models/usage_cycle_interval.rb +43 -0
- data/lib/togai_client/models/usage_lookup_range.rb +238 -0
- data/lib/togai_client/models/usage_meter.rb +156 -39
- data/lib/togai_client/models/usage_meter_aggregation.rb +40 -0
- data/lib/togai_client/models/usage_meter_filter_entry.rb +238 -0
- data/lib/togai_client/models/usage_meter_paginated_response.rb +14 -19
- data/lib/togai_client/models/usage_rate_card.rb +285 -0
- data/lib/togai_client/models/validate_entitlement_value_request.rb +222 -0
- data/lib/togai_client/models/validated_entity_error.rb +273 -0
- data/lib/togai_client/models/validated_entity_errors_paginated_response.rb +232 -0
- data/lib/togai_client/models/versions_to_migrate.rb +40 -0
- data/lib/togai_client/models/wallet_balance_response.rb +388 -0
- data/lib/togai_client/models/wallet_entries_paginated_response.rb +280 -0
- data/lib/togai_client/models/wallet_entry.rb +421 -0
- data/lib/togai_client/models/wallet_status.rb +40 -0
- data/lib/togai_client/models/wallet_topup_details.rb +233 -0
- data/lib/togai_client/version.rb +2 -2
- data/lib/togai_client.rb +279 -21
- data/spec/spec_helper.rb +1 -1
- data/togai_client.gemspec +4 -3
- metadata +561 -5
@@ -0,0 +1,655 @@
|
|
1
|
+
=begin
|
2
|
+
#Togai Apis
|
3
|
+
|
4
|
+
#APIs for Togai App
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0
|
7
|
+
Contact: engg@togai.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.10.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module TogaiClient
|
16
|
+
class EntitlementsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Get entitlement value for a account
|
23
|
+
# This API let’s you to get the entitlement value for a account
|
24
|
+
# @param account_id [String] account_id corresponding to an account
|
25
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [GetEntitlementValuesResponse]
|
28
|
+
def get_entitlement_value(account_id, feature_id, opts = {})
|
29
|
+
data, _status_code, _headers = get_entitlement_value_with_http_info(account_id, feature_id, opts)
|
30
|
+
data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Get entitlement value for a account
|
34
|
+
# This API let’s you to get the entitlement value for a account
|
35
|
+
# @param account_id [String] account_id corresponding to an account
|
36
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [Array<(GetEntitlementValuesResponse, Integer, Hash)>] GetEntitlementValuesResponse data, response status code and response headers
|
39
|
+
def get_entitlement_value_with_http_info(account_id, feature_id, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: EntitlementsApi.get_entitlement_value ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'account_id' is set
|
44
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EntitlementsApi.get_entitlement_value"
|
46
|
+
end
|
47
|
+
if @api_client.config.client_side_validation && account_id.to_s.length > 50
|
48
|
+
fail ArgumentError, 'invalid value for "account_id" when calling EntitlementsApi.get_entitlement_value, the character length must be smaller than or equal to 50.'
|
49
|
+
end
|
50
|
+
|
51
|
+
# verify the required parameter 'feature_id' is set
|
52
|
+
if @api_client.config.client_side_validation && feature_id.nil?
|
53
|
+
fail ArgumentError, "Missing the required parameter 'feature_id' when calling EntitlementsApi.get_entitlement_value"
|
54
|
+
end
|
55
|
+
if @api_client.config.client_side_validation && feature_id.to_s.length > 50
|
56
|
+
fail ArgumentError, 'invalid value for "feature_id" when calling EntitlementsApi.get_entitlement_value, the character length must be smaller than or equal to 50.'
|
57
|
+
end
|
58
|
+
|
59
|
+
# resource path
|
60
|
+
local_var_path = '/accounts/{account_id}/entitlements/{feature_id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'feature_id' + '}', CGI.escape(feature_id.to_s))
|
61
|
+
|
62
|
+
# query parameters
|
63
|
+
query_params = opts[:query_params] || {}
|
64
|
+
|
65
|
+
# header parameters
|
66
|
+
header_params = opts[:header_params] || {}
|
67
|
+
# HTTP header 'Accept' (if needed)
|
68
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
69
|
+
|
70
|
+
# form parameters
|
71
|
+
form_params = opts[:form_params] || {}
|
72
|
+
|
73
|
+
# http body (model)
|
74
|
+
post_body = opts[:debug_body]
|
75
|
+
|
76
|
+
# return_type
|
77
|
+
return_type = opts[:debug_return_type] || 'GetEntitlementValuesResponse'
|
78
|
+
|
79
|
+
# auth_names
|
80
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
81
|
+
|
82
|
+
new_options = opts.merge(
|
83
|
+
:operation => :"EntitlementsApi.get_entitlement_value",
|
84
|
+
:header_params => header_params,
|
85
|
+
:query_params => query_params,
|
86
|
+
:form_params => form_params,
|
87
|
+
:body => post_body,
|
88
|
+
:auth_names => auth_names,
|
89
|
+
:return_type => return_type
|
90
|
+
)
|
91
|
+
|
92
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
93
|
+
if @api_client.config.debugging
|
94
|
+
@api_client.config.logger.debug "API called: EntitlementsApi#get_entitlement_value\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
95
|
+
end
|
96
|
+
return data, status_code, headers
|
97
|
+
end
|
98
|
+
|
99
|
+
# Get entitlements for a account
|
100
|
+
# This API let’s you to get the entitlements for a account
|
101
|
+
# @param account_id [String] account_id corresponding to an account
|
102
|
+
# @param [Hash] opts the optional parameters
|
103
|
+
# @return [GetEntitlementValuesResponse]
|
104
|
+
def get_entitlements(account_id, opts = {})
|
105
|
+
data, _status_code, _headers = get_entitlements_with_http_info(account_id, opts)
|
106
|
+
data
|
107
|
+
end
|
108
|
+
|
109
|
+
# Get entitlements for a account
|
110
|
+
# This API let’s you to get the entitlements for a account
|
111
|
+
# @param account_id [String] account_id corresponding to an account
|
112
|
+
# @param [Hash] opts the optional parameters
|
113
|
+
# @return [Array<(GetEntitlementValuesResponse, Integer, Hash)>] GetEntitlementValuesResponse data, response status code and response headers
|
114
|
+
def get_entitlements_with_http_info(account_id, opts = {})
|
115
|
+
if @api_client.config.debugging
|
116
|
+
@api_client.config.logger.debug 'Calling API: EntitlementsApi.get_entitlements ...'
|
117
|
+
end
|
118
|
+
# verify the required parameter 'account_id' is set
|
119
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
120
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EntitlementsApi.get_entitlements"
|
121
|
+
end
|
122
|
+
if @api_client.config.client_side_validation && account_id.to_s.length > 50
|
123
|
+
fail ArgumentError, 'invalid value for "account_id" when calling EntitlementsApi.get_entitlements, the character length must be smaller than or equal to 50.'
|
124
|
+
end
|
125
|
+
|
126
|
+
# resource path
|
127
|
+
local_var_path = '/accounts/{account_id}/entitlements'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
|
128
|
+
|
129
|
+
# query parameters
|
130
|
+
query_params = opts[:query_params] || {}
|
131
|
+
|
132
|
+
# header parameters
|
133
|
+
header_params = opts[:header_params] || {}
|
134
|
+
# HTTP header 'Accept' (if needed)
|
135
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
136
|
+
|
137
|
+
# form parameters
|
138
|
+
form_params = opts[:form_params] || {}
|
139
|
+
|
140
|
+
# http body (model)
|
141
|
+
post_body = opts[:debug_body]
|
142
|
+
|
143
|
+
# return_type
|
144
|
+
return_type = opts[:debug_return_type] || 'GetEntitlementValuesResponse'
|
145
|
+
|
146
|
+
# auth_names
|
147
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
148
|
+
|
149
|
+
new_options = opts.merge(
|
150
|
+
:operation => :"EntitlementsApi.get_entitlements",
|
151
|
+
:header_params => header_params,
|
152
|
+
:query_params => query_params,
|
153
|
+
:form_params => form_params,
|
154
|
+
:body => post_body,
|
155
|
+
:auth_names => auth_names,
|
156
|
+
:return_type => return_type
|
157
|
+
)
|
158
|
+
|
159
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
160
|
+
if @api_client.config.debugging
|
161
|
+
@api_client.config.logger.debug "API called: EntitlementsApi#get_entitlements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
162
|
+
end
|
163
|
+
return data, status_code, headers
|
164
|
+
end
|
165
|
+
|
166
|
+
# Get Feature credits balance
|
167
|
+
# This API let’s you to get the feature credits balance
|
168
|
+
# @param account_id [String] account_id corresponding to an account
|
169
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
170
|
+
# @param [Hash] opts the optional parameters
|
171
|
+
# @return [GetFeatureCreditsResponse]
|
172
|
+
def get_feature_credits(account_id, feature_id, opts = {})
|
173
|
+
data, _status_code, _headers = get_feature_credits_with_http_info(account_id, feature_id, opts)
|
174
|
+
data
|
175
|
+
end
|
176
|
+
|
177
|
+
# Get Feature credits balance
|
178
|
+
# This API let’s you to get the feature credits balance
|
179
|
+
# @param account_id [String] account_id corresponding to an account
|
180
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
181
|
+
# @param [Hash] opts the optional parameters
|
182
|
+
# @return [Array<(GetFeatureCreditsResponse, Integer, Hash)>] GetFeatureCreditsResponse data, response status code and response headers
|
183
|
+
def get_feature_credits_with_http_info(account_id, feature_id, opts = {})
|
184
|
+
if @api_client.config.debugging
|
185
|
+
@api_client.config.logger.debug 'Calling API: EntitlementsApi.get_feature_credits ...'
|
186
|
+
end
|
187
|
+
# verify the required parameter 'account_id' is set
|
188
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
189
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EntitlementsApi.get_feature_credits"
|
190
|
+
end
|
191
|
+
if @api_client.config.client_side_validation && account_id.to_s.length > 50
|
192
|
+
fail ArgumentError, 'invalid value for "account_id" when calling EntitlementsApi.get_feature_credits, the character length must be smaller than or equal to 50.'
|
193
|
+
end
|
194
|
+
|
195
|
+
# verify the required parameter 'feature_id' is set
|
196
|
+
if @api_client.config.client_side_validation && feature_id.nil?
|
197
|
+
fail ArgumentError, "Missing the required parameter 'feature_id' when calling EntitlementsApi.get_feature_credits"
|
198
|
+
end
|
199
|
+
if @api_client.config.client_side_validation && feature_id.to_s.length > 50
|
200
|
+
fail ArgumentError, 'invalid value for "feature_id" when calling EntitlementsApi.get_feature_credits, the character length must be smaller than or equal to 50.'
|
201
|
+
end
|
202
|
+
|
203
|
+
# resource path
|
204
|
+
local_var_path = '/accounts/{account_id}/features/{feature_id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'feature_id' + '}', CGI.escape(feature_id.to_s))
|
205
|
+
|
206
|
+
# query parameters
|
207
|
+
query_params = opts[:query_params] || {}
|
208
|
+
|
209
|
+
# header parameters
|
210
|
+
header_params = opts[:header_params] || {}
|
211
|
+
# HTTP header 'Accept' (if needed)
|
212
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
213
|
+
|
214
|
+
# form parameters
|
215
|
+
form_params = opts[:form_params] || {}
|
216
|
+
|
217
|
+
# http body (model)
|
218
|
+
post_body = opts[:debug_body]
|
219
|
+
|
220
|
+
# return_type
|
221
|
+
return_type = opts[:debug_return_type] || 'GetFeatureCreditsResponse'
|
222
|
+
|
223
|
+
# auth_names
|
224
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
225
|
+
|
226
|
+
new_options = opts.merge(
|
227
|
+
:operation => :"EntitlementsApi.get_feature_credits",
|
228
|
+
:header_params => header_params,
|
229
|
+
:query_params => query_params,
|
230
|
+
:form_params => form_params,
|
231
|
+
:body => post_body,
|
232
|
+
:auth_names => auth_names,
|
233
|
+
:return_type => return_type
|
234
|
+
)
|
235
|
+
|
236
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
237
|
+
if @api_client.config.debugging
|
238
|
+
@api_client.config.logger.debug "API called: EntitlementsApi#get_feature_credits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
239
|
+
end
|
240
|
+
return data, status_code, headers
|
241
|
+
end
|
242
|
+
|
243
|
+
# Ingest event if a user is entitled to a feature
|
244
|
+
# This API let’s you to ingest an event if a user is entitled to a feature
|
245
|
+
# @param [Hash] opts the optional parameters
|
246
|
+
# @option opts [IngestEventRequest] :ingest_event_request
|
247
|
+
# @return [BaseSuccessResponse]
|
248
|
+
def ingest_entitled_event(opts = {})
|
249
|
+
data, _status_code, _headers = ingest_entitled_event_with_http_info(opts)
|
250
|
+
data
|
251
|
+
end
|
252
|
+
|
253
|
+
# Ingest event if a user is entitled to a feature
|
254
|
+
# This API let’s you to ingest an event if a user is entitled to a feature
|
255
|
+
# @param [Hash] opts the optional parameters
|
256
|
+
# @option opts [IngestEventRequest] :ingest_event_request
|
257
|
+
# @return [Array<(BaseSuccessResponse, Integer, Hash)>] BaseSuccessResponse data, response status code and response headers
|
258
|
+
def ingest_entitled_event_with_http_info(opts = {})
|
259
|
+
if @api_client.config.debugging
|
260
|
+
@api_client.config.logger.debug 'Calling API: EntitlementsApi.ingest_entitled_event ...'
|
261
|
+
end
|
262
|
+
# resource path
|
263
|
+
local_var_path = '/entitled'
|
264
|
+
|
265
|
+
# query parameters
|
266
|
+
query_params = opts[:query_params] || {}
|
267
|
+
|
268
|
+
# header parameters
|
269
|
+
header_params = opts[:header_params] || {}
|
270
|
+
# HTTP header 'Accept' (if needed)
|
271
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
272
|
+
# HTTP header 'Content-Type'
|
273
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
274
|
+
if !content_type.nil?
|
275
|
+
header_params['Content-Type'] = content_type
|
276
|
+
end
|
277
|
+
|
278
|
+
# form parameters
|
279
|
+
form_params = opts[:form_params] || {}
|
280
|
+
|
281
|
+
# http body (model)
|
282
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'ingest_event_request'])
|
283
|
+
|
284
|
+
# return_type
|
285
|
+
return_type = opts[:debug_return_type] || 'BaseSuccessResponse'
|
286
|
+
|
287
|
+
# auth_names
|
288
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
289
|
+
|
290
|
+
new_options = opts.merge(
|
291
|
+
:operation => :"EntitlementsApi.ingest_entitled_event",
|
292
|
+
:header_params => header_params,
|
293
|
+
:query_params => query_params,
|
294
|
+
:form_params => form_params,
|
295
|
+
:body => post_body,
|
296
|
+
:auth_names => auth_names,
|
297
|
+
:return_type => return_type
|
298
|
+
)
|
299
|
+
|
300
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
301
|
+
if @api_client.config.debugging
|
302
|
+
@api_client.config.logger.debug "API called: EntitlementsApi#ingest_entitled_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
303
|
+
end
|
304
|
+
return data, status_code, headers
|
305
|
+
end
|
306
|
+
|
307
|
+
# List feature credits entries of a feature for an account
|
308
|
+
# This API let’s you to list the feature credits entries of a feature for an account
|
309
|
+
# @param account_id [String] account_id corresponding to an account
|
310
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
311
|
+
# @param [Hash] opts the optional parameters
|
312
|
+
# @option opts [Integer] :page_size Maximum page size expected by client to return the record list. NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.
|
313
|
+
# @option opts [String] :next_token Pagination token used as a marker to get records from next page.
|
314
|
+
# @return [GetFeatureCreditEntriesPaginatedResponse]
|
315
|
+
def list_feature_credit_entries(account_id, feature_id, opts = {})
|
316
|
+
data, _status_code, _headers = list_feature_credit_entries_with_http_info(account_id, feature_id, opts)
|
317
|
+
data
|
318
|
+
end
|
319
|
+
|
320
|
+
# List feature credits entries of a feature for an account
|
321
|
+
# This API let’s you to list the feature credits entries of a feature for an account
|
322
|
+
# @param account_id [String] account_id corresponding to an account
|
323
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
324
|
+
# @param [Hash] opts the optional parameters
|
325
|
+
# @option opts [Integer] :page_size Maximum page size expected by client to return the record list. NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.
|
326
|
+
# @option opts [String] :next_token Pagination token used as a marker to get records from next page.
|
327
|
+
# @return [Array<(GetFeatureCreditEntriesPaginatedResponse, Integer, Hash)>] GetFeatureCreditEntriesPaginatedResponse data, response status code and response headers
|
328
|
+
def list_feature_credit_entries_with_http_info(account_id, feature_id, opts = {})
|
329
|
+
if @api_client.config.debugging
|
330
|
+
@api_client.config.logger.debug 'Calling API: EntitlementsApi.list_feature_credit_entries ...'
|
331
|
+
end
|
332
|
+
# verify the required parameter 'account_id' is set
|
333
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
334
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EntitlementsApi.list_feature_credit_entries"
|
335
|
+
end
|
336
|
+
if @api_client.config.client_side_validation && account_id.to_s.length > 50
|
337
|
+
fail ArgumentError, 'invalid value for "account_id" when calling EntitlementsApi.list_feature_credit_entries, the character length must be smaller than or equal to 50.'
|
338
|
+
end
|
339
|
+
|
340
|
+
# verify the required parameter 'feature_id' is set
|
341
|
+
if @api_client.config.client_side_validation && feature_id.nil?
|
342
|
+
fail ArgumentError, "Missing the required parameter 'feature_id' when calling EntitlementsApi.list_feature_credit_entries"
|
343
|
+
end
|
344
|
+
if @api_client.config.client_side_validation && feature_id.to_s.length > 50
|
345
|
+
fail ArgumentError, 'invalid value for "feature_id" when calling EntitlementsApi.list_feature_credit_entries, the character length must be smaller than or equal to 50.'
|
346
|
+
end
|
347
|
+
|
348
|
+
# resource path
|
349
|
+
local_var_path = '/accounts/{account_id}/features/{feature_id}/entries'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'feature_id' + '}', CGI.escape(feature_id.to_s))
|
350
|
+
|
351
|
+
# query parameters
|
352
|
+
query_params = opts[:query_params] || {}
|
353
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
354
|
+
query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?
|
355
|
+
|
356
|
+
# header parameters
|
357
|
+
header_params = opts[:header_params] || {}
|
358
|
+
# HTTP header 'Accept' (if needed)
|
359
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
360
|
+
|
361
|
+
# form parameters
|
362
|
+
form_params = opts[:form_params] || {}
|
363
|
+
|
364
|
+
# http body (model)
|
365
|
+
post_body = opts[:debug_body]
|
366
|
+
|
367
|
+
# return_type
|
368
|
+
return_type = opts[:debug_return_type] || 'GetFeatureCreditEntriesPaginatedResponse'
|
369
|
+
|
370
|
+
# auth_names
|
371
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
372
|
+
|
373
|
+
new_options = opts.merge(
|
374
|
+
:operation => :"EntitlementsApi.list_feature_credit_entries",
|
375
|
+
:header_params => header_params,
|
376
|
+
:query_params => query_params,
|
377
|
+
:form_params => form_params,
|
378
|
+
:body => post_body,
|
379
|
+
:auth_names => auth_names,
|
380
|
+
:return_type => return_type
|
381
|
+
)
|
382
|
+
|
383
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
384
|
+
if @api_client.config.debugging
|
385
|
+
@api_client.config.logger.debug "API called: EntitlementsApi#list_feature_credit_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
386
|
+
end
|
387
|
+
return data, status_code, headers
|
388
|
+
end
|
389
|
+
|
390
|
+
# Update a feature credits entry
|
391
|
+
# #### This API let's you to update the following attributes: `effectiveUntil` and `granted` - **effectiveUntil**: must be in future - **granted**: must be greater than the existing usage (previous granted - current balance)
|
392
|
+
# @param account_id [String] account_id corresponding to an account
|
393
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
394
|
+
# @param entry_id [String] `entryId` corresponding to a particular entitlement/overage grant entry Formats: 1. If source of entry is an entitlement grant rate card in price plan: `schedule_id#pricing_cycle_start_date$PRICE_PLAN` 2. If source of entry is an entitlement overage rate card in price plan: `schedule_id#pricing_cycle_start_date$OVERAGE` 3. If source of entry is a purchase: `purchase_id#int_index$PURCHASE`
|
395
|
+
# @param [Hash] opts the optional parameters
|
396
|
+
# @option opts [UpdateFeatureCreditsRequest] :update_feature_credits_request
|
397
|
+
# @return [FeatureCreditEntry]
|
398
|
+
def update_feature_credit_entry(account_id, feature_id, entry_id, opts = {})
|
399
|
+
data, _status_code, _headers = update_feature_credit_entry_with_http_info(account_id, feature_id, entry_id, opts)
|
400
|
+
data
|
401
|
+
end
|
402
|
+
|
403
|
+
# Update a feature credits entry
|
404
|
+
# #### This API let's you to update the following attributes: `effectiveUntil` and `granted` - **effectiveUntil**: must be in future - **granted**: must be greater than the existing usage (previous granted - current balance)
|
405
|
+
# @param account_id [String] account_id corresponding to an account
|
406
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
407
|
+
# @param entry_id [String] `entryId` corresponding to a particular entitlement/overage grant entry Formats: 1. If source of entry is an entitlement grant rate card in price plan: `schedule_id#pricing_cycle_start_date$PRICE_PLAN` 2. If source of entry is an entitlement overage rate card in price plan: `schedule_id#pricing_cycle_start_date$OVERAGE` 3. If source of entry is a purchase: `purchase_id#int_index$PURCHASE`
|
408
|
+
# @param [Hash] opts the optional parameters
|
409
|
+
# @option opts [UpdateFeatureCreditsRequest] :update_feature_credits_request
|
410
|
+
# @return [Array<(FeatureCreditEntry, Integer, Hash)>] FeatureCreditEntry data, response status code and response headers
|
411
|
+
def update_feature_credit_entry_with_http_info(account_id, feature_id, entry_id, opts = {})
|
412
|
+
if @api_client.config.debugging
|
413
|
+
@api_client.config.logger.debug 'Calling API: EntitlementsApi.update_feature_credit_entry ...'
|
414
|
+
end
|
415
|
+
# verify the required parameter 'account_id' is set
|
416
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
417
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EntitlementsApi.update_feature_credit_entry"
|
418
|
+
end
|
419
|
+
if @api_client.config.client_side_validation && account_id.to_s.length > 50
|
420
|
+
fail ArgumentError, 'invalid value for "account_id" when calling EntitlementsApi.update_feature_credit_entry, the character length must be smaller than or equal to 50.'
|
421
|
+
end
|
422
|
+
|
423
|
+
# verify the required parameter 'feature_id' is set
|
424
|
+
if @api_client.config.client_side_validation && feature_id.nil?
|
425
|
+
fail ArgumentError, "Missing the required parameter 'feature_id' when calling EntitlementsApi.update_feature_credit_entry"
|
426
|
+
end
|
427
|
+
if @api_client.config.client_side_validation && feature_id.to_s.length > 50
|
428
|
+
fail ArgumentError, 'invalid value for "feature_id" when calling EntitlementsApi.update_feature_credit_entry, the character length must be smaller than or equal to 50.'
|
429
|
+
end
|
430
|
+
|
431
|
+
# verify the required parameter 'entry_id' is set
|
432
|
+
if @api_client.config.client_side_validation && entry_id.nil?
|
433
|
+
fail ArgumentError, "Missing the required parameter 'entry_id' when calling EntitlementsApi.update_feature_credit_entry"
|
434
|
+
end
|
435
|
+
if @api_client.config.client_side_validation && entry_id.to_s.length > 50
|
436
|
+
fail ArgumentError, 'invalid value for "entry_id" when calling EntitlementsApi.update_feature_credit_entry, the character length must be smaller than or equal to 50.'
|
437
|
+
end
|
438
|
+
|
439
|
+
# resource path
|
440
|
+
local_var_path = '/accounts/{account_id}/features/{feature_id}/entries/{entry_id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'feature_id' + '}', CGI.escape(feature_id.to_s)).sub('{' + 'entry_id' + '}', CGI.escape(entry_id.to_s))
|
441
|
+
|
442
|
+
# query parameters
|
443
|
+
query_params = opts[:query_params] || {}
|
444
|
+
|
445
|
+
# header parameters
|
446
|
+
header_params = opts[:header_params] || {}
|
447
|
+
# HTTP header 'Accept' (if needed)
|
448
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
449
|
+
# HTTP header 'Content-Type'
|
450
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
451
|
+
if !content_type.nil?
|
452
|
+
header_params['Content-Type'] = content_type
|
453
|
+
end
|
454
|
+
|
455
|
+
# form parameters
|
456
|
+
form_params = opts[:form_params] || {}
|
457
|
+
|
458
|
+
# http body (model)
|
459
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_feature_credits_request'])
|
460
|
+
|
461
|
+
# return_type
|
462
|
+
return_type = opts[:debug_return_type] || 'FeatureCreditEntry'
|
463
|
+
|
464
|
+
# auth_names
|
465
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
466
|
+
|
467
|
+
new_options = opts.merge(
|
468
|
+
:operation => :"EntitlementsApi.update_feature_credit_entry",
|
469
|
+
:header_params => header_params,
|
470
|
+
:query_params => query_params,
|
471
|
+
:form_params => form_params,
|
472
|
+
:body => post_body,
|
473
|
+
:auth_names => auth_names,
|
474
|
+
:return_type => return_type
|
475
|
+
)
|
476
|
+
|
477
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
478
|
+
if @api_client.config.debugging
|
479
|
+
@api_client.config.logger.debug "API called: EntitlementsApi#update_feature_credit_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
480
|
+
end
|
481
|
+
return data, status_code, headers
|
482
|
+
end
|
483
|
+
|
484
|
+
# Check entitlement value for a account
|
485
|
+
# This API let’s you to validate the entitlement value for a account
|
486
|
+
# @param account_id [String] account_id corresponding to an account
|
487
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
488
|
+
# @param [Hash] opts the optional parameters
|
489
|
+
# @option opts [ValidateEntitlementValueRequest] :validate_entitlement_value_request
|
490
|
+
# @return [BaseSuccessResponse]
|
491
|
+
def validate_entitlement_value(account_id, feature_id, opts = {})
|
492
|
+
data, _status_code, _headers = validate_entitlement_value_with_http_info(account_id, feature_id, opts)
|
493
|
+
data
|
494
|
+
end
|
495
|
+
|
496
|
+
# Check entitlement value for a account
|
497
|
+
# This API let’s you to validate the entitlement value for a account
|
498
|
+
# @param account_id [String] account_id corresponding to an account
|
499
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
500
|
+
# @param [Hash] opts the optional parameters
|
501
|
+
# @option opts [ValidateEntitlementValueRequest] :validate_entitlement_value_request
|
502
|
+
# @return [Array<(BaseSuccessResponse, Integer, Hash)>] BaseSuccessResponse data, response status code and response headers
|
503
|
+
def validate_entitlement_value_with_http_info(account_id, feature_id, opts = {})
|
504
|
+
if @api_client.config.debugging
|
505
|
+
@api_client.config.logger.debug 'Calling API: EntitlementsApi.validate_entitlement_value ...'
|
506
|
+
end
|
507
|
+
# verify the required parameter 'account_id' is set
|
508
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
509
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EntitlementsApi.validate_entitlement_value"
|
510
|
+
end
|
511
|
+
if @api_client.config.client_side_validation && account_id.to_s.length > 50
|
512
|
+
fail ArgumentError, 'invalid value for "account_id" when calling EntitlementsApi.validate_entitlement_value, the character length must be smaller than or equal to 50.'
|
513
|
+
end
|
514
|
+
|
515
|
+
# verify the required parameter 'feature_id' is set
|
516
|
+
if @api_client.config.client_side_validation && feature_id.nil?
|
517
|
+
fail ArgumentError, "Missing the required parameter 'feature_id' when calling EntitlementsApi.validate_entitlement_value"
|
518
|
+
end
|
519
|
+
if @api_client.config.client_side_validation && feature_id.to_s.length > 50
|
520
|
+
fail ArgumentError, 'invalid value for "feature_id" when calling EntitlementsApi.validate_entitlement_value, the character length must be smaller than or equal to 50.'
|
521
|
+
end
|
522
|
+
|
523
|
+
# resource path
|
524
|
+
local_var_path = '/accounts/{account_id}/entitlements/{feature_id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'feature_id' + '}', CGI.escape(feature_id.to_s))
|
525
|
+
|
526
|
+
# query parameters
|
527
|
+
query_params = opts[:query_params] || {}
|
528
|
+
|
529
|
+
# header parameters
|
530
|
+
header_params = opts[:header_params] || {}
|
531
|
+
# HTTP header 'Accept' (if needed)
|
532
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
533
|
+
# HTTP header 'Content-Type'
|
534
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
535
|
+
if !content_type.nil?
|
536
|
+
header_params['Content-Type'] = content_type
|
537
|
+
end
|
538
|
+
|
539
|
+
# form parameters
|
540
|
+
form_params = opts[:form_params] || {}
|
541
|
+
|
542
|
+
# http body (model)
|
543
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'validate_entitlement_value_request'])
|
544
|
+
|
545
|
+
# return_type
|
546
|
+
return_type = opts[:debug_return_type] || 'BaseSuccessResponse'
|
547
|
+
|
548
|
+
# auth_names
|
549
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
550
|
+
|
551
|
+
new_options = opts.merge(
|
552
|
+
:operation => :"EntitlementsApi.validate_entitlement_value",
|
553
|
+
:header_params => header_params,
|
554
|
+
:query_params => query_params,
|
555
|
+
:form_params => form_params,
|
556
|
+
:body => post_body,
|
557
|
+
:auth_names => auth_names,
|
558
|
+
:return_type => return_type
|
559
|
+
)
|
560
|
+
|
561
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
562
|
+
if @api_client.config.debugging
|
563
|
+
@api_client.config.logger.debug "API called: EntitlementsApi#validate_entitlement_value\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
564
|
+
end
|
565
|
+
return data, status_code, headers
|
566
|
+
end
|
567
|
+
|
568
|
+
# Void a feature credits entry of a feature for an account
|
569
|
+
# This API let’s you to void the feature credits entries of a feature for an account
|
570
|
+
# @param account_id [String] account_id corresponding to an account
|
571
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
572
|
+
# @param entry_id [String] `entryId` corresponding to a particular entitlement/overage grant entry Formats: 1. If source of entry is an entitlement grant rate card in price plan: `schedule_id#pricing_cycle_start_date$PRICE_PLAN` 2. If source of entry is an entitlement overage rate card in price plan: `schedule_id#pricing_cycle_start_date$OVERAGE` 3. If source of entry is a purchase: `purchase_id#int_index$PURCHASE`
|
573
|
+
# @param [Hash] opts the optional parameters
|
574
|
+
# @return [BaseSuccessResponse]
|
575
|
+
def void_feature_credit_entry(account_id, feature_id, entry_id, opts = {})
|
576
|
+
data, _status_code, _headers = void_feature_credit_entry_with_http_info(account_id, feature_id, entry_id, opts)
|
577
|
+
data
|
578
|
+
end
|
579
|
+
|
580
|
+
# Void a feature credits entry of a feature for an account
|
581
|
+
# This API let’s you to void the feature credits entries of a feature for an account
|
582
|
+
# @param account_id [String] account_id corresponding to an account
|
583
|
+
# @param feature_id [String] feature_id corresponding to a feature
|
584
|
+
# @param entry_id [String] `entryId` corresponding to a particular entitlement/overage grant entry Formats: 1. If source of entry is an entitlement grant rate card in price plan: `schedule_id#pricing_cycle_start_date$PRICE_PLAN` 2. If source of entry is an entitlement overage rate card in price plan: `schedule_id#pricing_cycle_start_date$OVERAGE` 3. If source of entry is a purchase: `purchase_id#int_index$PURCHASE`
|
585
|
+
# @param [Hash] opts the optional parameters
|
586
|
+
# @return [Array<(BaseSuccessResponse, Integer, Hash)>] BaseSuccessResponse data, response status code and response headers
|
587
|
+
def void_feature_credit_entry_with_http_info(account_id, feature_id, entry_id, opts = {})
|
588
|
+
if @api_client.config.debugging
|
589
|
+
@api_client.config.logger.debug 'Calling API: EntitlementsApi.void_feature_credit_entry ...'
|
590
|
+
end
|
591
|
+
# verify the required parameter 'account_id' is set
|
592
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
593
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EntitlementsApi.void_feature_credit_entry"
|
594
|
+
end
|
595
|
+
if @api_client.config.client_side_validation && account_id.to_s.length > 50
|
596
|
+
fail ArgumentError, 'invalid value for "account_id" when calling EntitlementsApi.void_feature_credit_entry, the character length must be smaller than or equal to 50.'
|
597
|
+
end
|
598
|
+
|
599
|
+
# verify the required parameter 'feature_id' is set
|
600
|
+
if @api_client.config.client_side_validation && feature_id.nil?
|
601
|
+
fail ArgumentError, "Missing the required parameter 'feature_id' when calling EntitlementsApi.void_feature_credit_entry"
|
602
|
+
end
|
603
|
+
if @api_client.config.client_side_validation && feature_id.to_s.length > 50
|
604
|
+
fail ArgumentError, 'invalid value for "feature_id" when calling EntitlementsApi.void_feature_credit_entry, the character length must be smaller than or equal to 50.'
|
605
|
+
end
|
606
|
+
|
607
|
+
# verify the required parameter 'entry_id' is set
|
608
|
+
if @api_client.config.client_side_validation && entry_id.nil?
|
609
|
+
fail ArgumentError, "Missing the required parameter 'entry_id' when calling EntitlementsApi.void_feature_credit_entry"
|
610
|
+
end
|
611
|
+
if @api_client.config.client_side_validation && entry_id.to_s.length > 50
|
612
|
+
fail ArgumentError, 'invalid value for "entry_id" when calling EntitlementsApi.void_feature_credit_entry, the character length must be smaller than or equal to 50.'
|
613
|
+
end
|
614
|
+
|
615
|
+
# resource path
|
616
|
+
local_var_path = '/accounts/{account_id}/features/{feature_id}/entries/{entry_id}/void'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'feature_id' + '}', CGI.escape(feature_id.to_s)).sub('{' + 'entry_id' + '}', CGI.escape(entry_id.to_s))
|
617
|
+
|
618
|
+
# query parameters
|
619
|
+
query_params = opts[:query_params] || {}
|
620
|
+
|
621
|
+
# header parameters
|
622
|
+
header_params = opts[:header_params] || {}
|
623
|
+
# HTTP header 'Accept' (if needed)
|
624
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
625
|
+
|
626
|
+
# form parameters
|
627
|
+
form_params = opts[:form_params] || {}
|
628
|
+
|
629
|
+
# http body (model)
|
630
|
+
post_body = opts[:debug_body]
|
631
|
+
|
632
|
+
# return_type
|
633
|
+
return_type = opts[:debug_return_type] || 'BaseSuccessResponse'
|
634
|
+
|
635
|
+
# auth_names
|
636
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
637
|
+
|
638
|
+
new_options = opts.merge(
|
639
|
+
:operation => :"EntitlementsApi.void_feature_credit_entry",
|
640
|
+
:header_params => header_params,
|
641
|
+
:query_params => query_params,
|
642
|
+
:form_params => form_params,
|
643
|
+
:body => post_body,
|
644
|
+
:auth_names => auth_names,
|
645
|
+
:return_type => return_type
|
646
|
+
)
|
647
|
+
|
648
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
649
|
+
if @api_client.config.debugging
|
650
|
+
@api_client.config.logger.debug "API called: EntitlementsApi#void_feature_credit_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
651
|
+
end
|
652
|
+
return data, status_code, headers
|
653
|
+
end
|
654
|
+
end
|
655
|
+
end
|