Class: CyberSource::InvoiceSettingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/invoice_settings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ InvoiceSettingsApi

Returns a new instance of InvoiceSettingsApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/invoice_settings_api.rb', line 18

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/cybersource_rest_client/api/invoice_settings_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#get_invoice_settings(opts = {}) ⇒ InvoicingV2InvoiceSettingsGet200Response

Get Invoice Settings Allows you to retrieve the invoice settings for the payment page.

Parameters:

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cybersource_rest_client/api/invoice_settings_api.rb', line 28

def get_invoice_settings(opts = {})
  data, status_code, headers = get_invoice_settings_with_http_info(opts)
  return data, status_code, headers
end

#get_invoice_settings_with_http_info(opts = {}) ⇒ Array<(InvoicingV2InvoiceSettingsGet200Response, Fixnum, Hash)>

Get Invoice Settings Allows you to retrieve the invoice settings for the payment page.

Parameters:

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

    the optional parameters

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
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
 
# File 'lib/cybersource_rest_client/api/invoice_settings_api.rb', line 37

def get_invoice_settings_with_http_info(opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InvoiceSettingsApi.get_invoice_settings ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # resource path
  local_var_path = 'invoicing/v2/invoiceSettings'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicingV2InvoiceSettingsGet200Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InvoiceSettingsApi#get_invoice_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#update_invoice_settings(invoice_settings_request, opts = {}) ⇒ InvoicingV2InvoiceSettingsGet200Response

Update Invoice Settings Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.

Parameters:

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/cybersource_rest_client/api/invoice_settings_api.rb', line 94

def update_invoice_settings(invoice_settings_request, opts = {})
  data, status_code, headers = update_invoice_settings_with_http_info(invoice_settings_request, opts)
  return data, status_code, headers
end

#update_invoice_settings_with_http_info(invoice_settings_request, opts = {}) ⇒ Array<(InvoicingV2InvoiceSettingsGet200Response, Fixnum, Hash)>

Update Invoice Settings Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.

Parameters:

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

    the optional parameters

Returns:



104
105
106
107
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
152
153
154
155
 
# File 'lib/cybersource_rest_client/api/invoice_settings_api.rb', line 104

def update_invoice_settings_with_http_info(invoice_settings_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InvoiceSettingsApi.update_invoice_settings ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'invoice_settings_request' is set
  if @api_client.config.client_side_validation && invoice_settings_request.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_settings_request' when calling InvoiceSettingsApi.update_invoice_settings"
  end
  # resource path
  local_var_path = 'invoicing/v2/invoiceSettings'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(invoice_settings_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'InvoiceSettingsRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicingV2InvoiceSettingsGet200Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InvoiceSettingsApi#update_invoice_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end