Class: TapyrusApiClient::AddressApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tapyrus-api-client/api/address_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AddressApi

Returns a new instance of AddressApi.



19
20
21
 
# File 'lib/tapyrus-api-client/api/address_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tapyrus-api-client/api/address_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_address(purpose_address_request, opts = {}) ⇒ String

アドレスを生成して返します。

受金用のアドレスを生成して返します。 任意で`purpose`を設定し、生成するアドレスの種類を指定できます。未指定の場合、汎用的に使うアドレスを生成します。  - `purpose` に `general` と入力する、または未指定の場合、汎用的に使うアドレスを生成します。 - `purpose`に`tracking`と入力すると、トラッキングに使用するアドレスを生成します。

Parameters:

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

    the optional parameters

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/tapyrus-api-client/api/address_api.rb', line 27

def create_address(purpose_address_request, opts = {})
  data, _status_code, _headers = create_address_with_http_info(purpose_address_request, opts)
  data
end

#create_address_with_http_info(purpose_address_request, opts = {}) ⇒ Array<(String, Integer, Hash)>

アドレスを生成して返します。

受金用のアドレスを生成して返します。 任意で&#x60;purpose&#x60;を設定し、生成するアドレスの種類を指定できます。未指定の場合、汎用的に使うアドレスを生成します。  - &#x60;purpose&#x60; に &#x60;general&#x60; と入力する、または未指定の場合、汎用的に使うアドレスを生成します。 - &#x60;purpose&#x60;に&#x60;tracking&#x60;と入力すると、トラッキングに使用するアドレスを生成します。

Parameters:

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



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
87
88
 
# File 'lib/tapyrus-api-client/api/address_api.rb', line 37

def create_address_with_http_info(purpose_address_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressApi.create_address ...'
  end
  # verify the required parameter 'purpose_address_request' is set
  if @api_client.config.client_side_validation && purpose_address_request.nil?
    fail ArgumentError, "Missing the required parameter 'purpose_address_request' when calling AddressApi.create_address"
  end
  # resource path
  local_var_path = '/addresses'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(purpose_address_request)

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AddressApi.create_address",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AddressApi#create_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_addresses(opts = {}) ⇒ GetAddressesResponse

これまで生成したアドレスを一覧にして返します。

これまで生成したアドレスを一覧にして返します。 任意で`purpose`を設定し、取得するアドレスの種類を指定できます。未指定の場合、汎用的に使うアドレスのみ取得します。  - `purpose`に`general`と入力すると、生成したアドレスのうち、汎用的に使うアドレスのみ取得します。  - `purpose`に`all`と入力すると、生成したアドレスすべて取得します。  - `purpose`に`tracking`と入力すると、生成したアドレスのうち、トラッキングに使用されているアドレスを取得します。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :per (Integer) —

    1ページあたりの件数

  • :page (Integer) —

    ページ番号

  • :purpose (String) —

    取得したいアドレス

Returns:



97
98
99
100
 
# File 'lib/tapyrus-api-client/api/address_api.rb', line 97

def get_addresses(opts = {})
  data, _status_code, _headers = get_addresses_with_http_info(opts)
  data
end

#get_addresses_with_http_info(opts = {}) ⇒ Array<(GetAddressesResponse, Integer, Hash)>

これまで生成したアドレスを一覧にして返します。

これまで生成したアドレスを一覧にして返します。 任意で&#x60;purpose&#x60;を設定し、取得するアドレスの種類を指定できます。未指定の場合、汎用的に使うアドレスのみ取得します。  - &#x60;purpose&#x60;に&#x60;general&#x60;と入力すると、生成したアドレスのうち、汎用的に使うアドレスのみ取得します。  - &#x60;purpose&#x60;に&#x60;all&#x60;と入力すると、生成したアドレスすべて取得します。  - &#x60;purpose&#x60;に&#x60;tracking&#x60;と入力すると、生成したアドレスのうち、トラッキングに使用されているアドレスを取得します。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :per (Integer) —

    1ページあたりの件数

  • :page (Integer) —

    ページ番号

  • :purpose (String) —

    取得したいアドレス

Returns:

  • (Array<(GetAddressesResponse, Integer, Hash)>) —

    GetAddressesResponse data, response status code and response headers



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
 
# File 'lib/tapyrus-api-client/api/address_api.rb', line 109

def get_addresses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressApi.get_addresses ...'
  end
  # resource path
  local_var_path = '/addresses'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'purpose'] = opts[:'purpose'] if !opts[:'purpose'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAddressesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AddressApi.get_addresses",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AddressApi#get_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end