Class: BillForward::PaymentmethodsubscriptionlinksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentmethodsubscriptionlinksApi

Returns a new instance of PaymentmethodsubscriptionlinksApi.



30
31
32
 
# File 'lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb', line 30

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

Create a payment method to a subscription","request":"createPaymentMethodSubscriptionLinkRequest.html","response":"createPaymentMethodSubscriptionLinkResponse.html"

Parameters:

  • payment_method —

    The payment-method object to be updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb', line 39

def create_payment_method_subscription_link(payment_method, opts = {})
  data, _status_code, _headers = create_payment_method_subscription_link_with_http_info(payment_method, opts)
  return data
end

#create_payment_method_subscription_link_with_http_info(payment_method, opts = {}) ⇒ Array<(PaymentMethodSubscriptionLinkPagedMetadata, Fixnum, Hash)>

Create a payment method to a subscription&quot;,&quot;request&quot;:&quot;createPaymentMethodSubscriptionLinkRequest.html&quot;,&quot;response&quot;:&quot;createPaymentMethodSubscriptionLinkResponse.html&quot;

Parameters:

  • payment_method —

    The payment-method object to be updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb', line 49

def create_payment_method_subscription_link_with_http_info(payment_method, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentmethodsubscriptionlinksApi.create_payment_method_subscription_link ..."
  end
  # verify the required parameter 'payment_method' is set
  fail ArgumentError, "Missing the required parameter 'payment_method' when calling PaymentmethodsubscriptionlinksApi.create_payment_method_subscription_link" if payment_method.nil?
  # resource path
  local_var_path = "/payment-method-subscription-links".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['text/xml', 'application/xml', 'application/json; charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(payment_method)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PaymentMethodSubscriptionLinkPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentmethodsubscriptionlinksApi#create_payment_method_subscription_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retire_payment_method_subscription_link(payment_method_subscription_link_id, organizations, opts = {}) ⇒ PaymentMethodSubscriptionLinkPagedMetadata

Retires the payment-method-subscription-link specified by the link-ID parameter. a payment method from a subscription","response":"deletePaymentMethodSubscriptionLink.html"

Parameters:

  • payment_method_subscription_link_id —

    ID of the link.

  • organizations —

    A list of organization-IDs used to restrict the scope of API calls.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb', line 97

def retire_payment_method_subscription_link(payment_method_subscription_link_id, organizations, opts = {})
  data, _status_code, _headers = retire_payment_method_subscription_link_with_http_info(payment_method_subscription_link_id, organizations, opts)
  return data
end

#retire_payment_method_subscription_link_with_http_info(payment_method_subscription_link_id, organizations, opts = {}) ⇒ Array<(PaymentMethodSubscriptionLinkPagedMetadata, Fixnum, Hash)>

Retires the payment-method-subscription-link specified by the link-ID parameter. a payment method from a subscription&quot;,&quot;response&quot;:&quot;deletePaymentMethodSubscriptionLink.html&quot;

Parameters:

  • payment_method_subscription_link_id —

    ID of the link.

  • organizations —

    A list of organization-IDs used to restrict the scope of API calls.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb', line 108

def retire_payment_method_subscription_link_with_http_info(payment_method_subscription_link_id, organizations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentmethodsubscriptionlinksApi.retire_payment_method_subscription_link ..."
  end
  # verify the required parameter 'payment_method_subscription_link_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_method_subscription_link_id' when calling PaymentmethodsubscriptionlinksApi.retire_payment_method_subscription_link" if payment_method_subscription_link_id.nil?
  # verify the required parameter 'organizations' is set
  fail ArgumentError, "Missing the required parameter 'organizations' when calling PaymentmethodsubscriptionlinksApi.retire_payment_method_subscription_link" if organizations.nil?
  # resource path
  local_var_path = "/payment-method-subscription-links/{payment-method-subscription-link-ID}".sub('{format}','json').sub('{' + 'payment-method-subscription-link-ID' + '}', payment_method_subscription_link_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(organizations, :multi)

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json; charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['text/plain']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PaymentMethodSubscriptionLinkPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentmethodsubscriptionlinksApi#retire_payment_method_subscription_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end