Module: Orb::Internal::Type::RequestParameters Private

Included in:
Models::AlertCreateForCustomerParams, Models::AlertCreateForExternalCustomerParams, Models::AlertCreateForSubscriptionParams, Models::AlertDisableParams, Models::AlertEnableParams, Models::AlertListParams, Models::AlertRetrieveParams, Models::AlertUpdateParams, Models::Beta::ExternalPlanIDCreatePlanVersionParams, Models::Beta::ExternalPlanIDFetchPlanVersionParams, Models::Beta::ExternalPlanIDSetDefaultPlanVersionParams, Models::BetaCreatePlanVersionParams, Models::BetaFetchPlanVersionParams, Models::BetaSetDefaultPlanVersionParams, Models::CouponArchiveParams, Models::CouponCreateParams, Models::CouponFetchParams, Models::CouponListParams, Models::Coupons::SubscriptionListParams, Models::CreditNoteCreateParams, Models::CreditNoteFetchParams, Models::CreditNoteListParams, Models::CustomerCreateParams, Models::CustomerDeleteParams, Models::CustomerFetchByExternalIDParams, Models::CustomerFetchParams, Models::CustomerListParams, Models::CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams, Models::CustomerSyncPaymentMethodsFromGatewayParams, Models::CustomerUpdateByExternalIDParams, Models::CustomerUpdateParams, Models::Customers::BalanceTransactionCreateParams, Models::Customers::BalanceTransactionListParams, Models::Customers::CostListByExternalIDParams, Models::Customers::CostListParams, Models::Customers::CreditListByExternalIDParams, Models::Customers::CreditListParams, Models::Customers::Credits::LedgerCreateEntryByExternalIDParams, Models::Customers::Credits::LedgerCreateEntryParams, Models::Customers::Credits::LedgerListByExternalIDParams, Models::Customers::Credits::LedgerListParams, Models::Customers::Credits::TopUpCreateByExternalIDParams, Models::Customers::Credits::TopUpCreateParams, Models::Customers::Credits::TopUpDeleteByExternalIDParams, Models::Customers::Credits::TopUpDeleteParams, Models::Customers::Credits::TopUpListByExternalIDParams, Models::Customers::Credits::TopUpListParams, Models::DimensionalPriceGroupCreateParams, Models::DimensionalPriceGroupListParams, Models::DimensionalPriceGroupRetrieveParams, Models::DimensionalPriceGroupUpdateParams, Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDRetrieveParams, Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDUpdateParams, Models::EventDeprecateParams, Models::EventIngestParams, Models::EventSearchParams, Models::EventUpdateParams, Models::Events::BackfillCloseParams, Models::Events::BackfillCreateParams, Models::Events::BackfillFetchParams, Models::Events::BackfillListParams, Models::Events::BackfillRevertParams, Models::Events::VolumeListParams, Models::InvoiceCreateParams, Models::InvoiceFetchParams, Models::InvoiceFetchUpcomingParams, Models::InvoiceIssueParams, Models::InvoiceLineItemCreateParams, Models::InvoiceListParams, Models::InvoiceMarkPaidParams, Models::InvoicePayParams, Models::InvoiceUpdateParams, Models::InvoiceVoidParams, Models::ItemArchiveParams, Models::ItemCreateParams, Models::ItemFetchParams, Models::ItemListParams, Models::ItemUpdateParams, Models::MetricCreateParams, Models::MetricFetchParams, Models::MetricListParams, Models::MetricUpdateParams, Models::PlanCreateParams, Models::PlanFetchParams, Models::PlanListParams, Models::PlanUpdateParams, Models::Plans::ExternalPlanIDFetchParams, Models::Plans::ExternalPlanIDUpdateParams, Models::PriceCreateParams, Models::PriceEvaluateMultipleParams, Models::PriceEvaluateParams, Models::PriceEvaluatePreviewEventsParams, Models::PriceFetchParams, Models::PriceListParams, Models::PriceUpdateParams, Models::Prices::ExternalPriceIDFetchParams, Models::Prices::ExternalPriceIDUpdateParams, Models::SubscriptionCancelParams, Models::SubscriptionChangeApplyParams, Models::SubscriptionChangeCancelParams, Models::SubscriptionChangeRetrieveParams, Models::SubscriptionCreateParams, Models::SubscriptionFetchCostsParams, Models::SubscriptionFetchParams, Models::SubscriptionFetchScheduleParams, Models::SubscriptionFetchUsageParams, Models::SubscriptionListParams, Models::SubscriptionPriceIntervalsParams, Models::SubscriptionRedeemCouponParams, Models::SubscriptionSchedulePlanChangeParams, Models::SubscriptionTriggerPhaseParams, Models::SubscriptionUnscheduleCancellationParams, Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesParams, Models::SubscriptionUnschedulePendingPlanChangesParams, Models::SubscriptionUpdateFixedFeeQuantityParams, Models::SubscriptionUpdateParams, Models::SubscriptionUpdateTrialParams, Models::TopLevelPingParams
Defined in:
lib/orb/internal/type/request_parameters.rb

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Defined Under Namespace

Modules: Converter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#request_options ⇒ Object

Options to specify HTTP behaviour for this request.

@return [Orb::RequestOptions, Hash{Symbol=>Object}]




# File 'lib/orb/internal/type/request_parameters.rb', line 8

Class Method Details

.included(mod) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • mod (Module)

Raises:

  • (ArgumentError) 


14
15
16
17
18
 
# File 'lib/orb/internal/type/request_parameters.rb', line 14

def self.included(mod)
  raise ArgumentError.new(mod) unless mod <= Orb::Internal::Type::BaseModel

  mod.optional(:request_options, Orb::RequestOptions)
end