Class: GenesisRuby::Api::Requests::NonFinancial::ManagedRecurring::Cancel

Inherits:

Base::Versioned

• Object
• GenesisRuby::Api::Request
• Base::Versioned
• GenesisRuby::Api::Requests::NonFinancial::ManagedRecurring::Cancel

Defined in:

lib/genesis_ruby/api/requests/non_financial/managed_recurring/cancel.rb

Overview

Cancels an active managed recurring item by its unique identifier.

Constant Summary

Constants inherited from GenesisRuby::Api::Request

GenesisRuby::Api::Request::AUTH_TYPE_BASIC, GenesisRuby::Api::Request::AUTH_TYPE_TOKEN, GenesisRuby::Api::Request::METHOD_DELETE, GenesisRuby::Api::Request::METHOD_GET, GenesisRuby::Api::Request::METHOD_PATCH, GenesisRuby::Api::Request::METHOD_POST, GenesisRuby::Api::Request::METHOD_PUT, GenesisRuby::Api::Request::PORT_HTTPS, GenesisRuby::Api::Request::PROTOCOL_HTTPS

Instance Attribute Summary

• #unique_id ⇒ Object

  Unique identifier of the managed recurring item.

Attributes inherited from Base::Versioned

#allowed_versions, #version

Attributes inherited from GenesisRuby::Api::Request

#api_config

Instance Method Summary

• #initialize(configuration, _builder_interface = nil) ⇒ Cancel constructor

  Cancel initialization.

Methods inherited from GenesisRuby::Api::Request

#build_document

Constructor Details

#initialize(configuration, _builder_interface = nil) ⇒ Cancel

Cancel initialization

# File 'lib/genesis_ruby/api/requests/non_financial/managed_recurring/cancel.rb', line 14

def initialize(configuration, _builder_interface = nil)
  super configuration

  self.request_path = 'managed_recurring/items/:unique_id'
end

Instance Attribute Details

#unique_id ⇒ Object

Unique identifier of the managed recurring item

# File 'lib/genesis_ruby/api/requests/non_financial/managed_recurring/cancel.rb', line 21

def unique_id
  @unique_id.to_s
end