Skip to content

SetupFlowsApi.md

Latest commit

 

History

History
371 lines (268 loc) · 9.58 KB

SetupFlowsApi.md

File metadata and controls

371 lines (268 loc) · 9.58 KB

PAYJPv2::SetupFlowsApi

All URIs are relative to http://localhost

Method HTTP request Description
cancel_setup_flow POST /v2/setup_flows/{setup_flow_id}/cancel Cancel Setup Flow
create_setup_flow POST /v2/setup_flows Create Setup Flow
get_all_setup_flows GET /v2/setup_flows Get All Setup Flows
get_setup_flow GET /v2/setup_flows/{setup_flow_id} Get Setup Flow
update_setup_flow POST /v2/setup_flows/{setup_flow_id} Update Setup Flow

cancel_setup_flow

cancel_setup_flow(setup_flow_id, opts)

Cancel Setup Flow

Examples

require 'time'
require 'payjpv2'
# setup authorization
PAYJPv2.configure do |config|
  # Configure HTTP basic authorization: HTTPBasic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure Bearer authorization: HTTPBearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PAYJPv2::SetupFlowsApi.new
setup_flow_id = 'setup_flow_id_example' # String | 
opts = {
  setup_flow_cancel_request: PAYJPv2::SetupFlowCancelRequest.new # SetupFlowCancelRequest | 
}

begin
  # Cancel Setup Flow
  result = api_instance.cancel_setup_flow(setup_flow_id, opts)
  p result
rescue PAYJPv2::ApiError => e
  puts "Error when calling SetupFlowsApi->cancel_setup_flow: #{e}"
end

Using the include_http_info option

To get response data along with status code and headers, use the include_http_info: true option.

begin
  # Cancel Setup Flow
  data, status_code, headers = api_instance.cancel_setup_flow(setup_flow_id, opts.merge(include_http_info: true))
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SetupFlowResponse>
rescue PAYJPv2::ApiError => e
  puts "Error when calling SetupFlowsApi->cancel_setup_flow: #{e}"
end

Parameters

Name Type Description Notes
setup_flow_id String
setup_flow_cancel_request SetupFlowCancelRequest [optional]

Return type

SetupFlowResponse

Authorization

HTTPBasic, HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

create_setup_flow

create_setup_flow(opts)

Create Setup Flow

Examples

require 'time'
require 'payjpv2'
# setup authorization
PAYJPv2.configure do |config|
  # Configure HTTP basic authorization: HTTPBasic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure Bearer authorization: HTTPBearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PAYJPv2::SetupFlowsApi.new
opts = {
  setup_flow_create_request: PAYJPv2::SetupFlowCreateRequest.new # SetupFlowCreateRequest | 
}

begin
  # Create Setup Flow
  result = api_instance.create_setup_flow(opts)
  p result
rescue PAYJPv2::ApiError => e
  puts "Error when calling SetupFlowsApi->create_setup_flow: #{e}"
end

Using the include_http_info option

To get response data along with status code and headers, use the include_http_info: true option.

begin
  # Create Setup Flow
  data, status_code, headers = api_instance.create_setup_flow(opts.merge(include_http_info: true))
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SetupFlowResponse>
rescue PAYJPv2::ApiError => e
  puts "Error when calling SetupFlowsApi->create_setup_flow: #{e}"
end

Parameters

Name Type Description Notes
setup_flow_create_request SetupFlowCreateRequest [optional]

Return type

SetupFlowResponse

Authorization

HTTPBasic, HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

get_all_setup_flows

get_all_setup_flows(opts)

Get All Setup Flows

Examples

require 'time'
require 'payjpv2'
# setup authorization
PAYJPv2.configure do |config|
  # Configure HTTP basic authorization: HTTPBasic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure Bearer authorization: HTTPBearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PAYJPv2::SetupFlowsApi.new
opts = {
  limit: 56, # Integer | 取得するデータの最大件数
  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
  ending_before: 'ending_before_example' # String | このIDより前のデータを取得
}

begin
  # Get All Setup Flows
  result = api_instance.get_all_setup_flows(opts)
  p result
rescue PAYJPv2::ApiError => e
  puts "Error when calling SetupFlowsApi->get_all_setup_flows: #{e}"
end

Using the include_http_info option

To get response data along with status code and headers, use the include_http_info: true option.

begin
  # Get All Setup Flows
  data, status_code, headers = api_instance.get_all_setup_flows(opts.merge(include_http_info: true))
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SetupFlowListResponse>
rescue PAYJPv2::ApiError => e
  puts "Error when calling SetupFlowsApi->get_all_setup_flows: #{e}"
end

Parameters

Name Type Description Notes
limit Integer 取得するデータの最大件数 [optional][default to 10]
starting_after String このIDより後のデータを取得 [optional]
ending_before String このIDより前のデータを取得 [optional]

Return type

SetupFlowListResponse

Authorization

HTTPBasic, HTTPBearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

get_setup_flow

get_setup_flow(setup_flow_id)

Get Setup Flow

Examples

require 'time'
require 'payjpv2'
# setup authorization
PAYJPv2.configure do |config|
  # Configure HTTP basic authorization: HTTPBasic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure Bearer authorization: HTTPBearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PAYJPv2::SetupFlowsApi.new
setup_flow_id = 'setup_flow_id_example' # String | 

begin
  # Get Setup Flow
  result = api_instance.get_setup_flow(setup_flow_id)
  p result
rescue PAYJPv2::ApiError => e
  puts "Error when calling SetupFlowsApi->get_setup_flow: #{e}"
end

Using the include_http_info option

To get response data along with status code and headers, use the include_http_info: true option.

begin
  # Get Setup Flow
  data, status_code, headers = api_instance.get_setup_flow(setup_flow_id, { include_http_info: true })
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SetupFlowResponse>
rescue PAYJPv2::ApiError => e
  puts "Error when calling SetupFlowsApi->get_setup_flow: #{e}"
end

Parameters

Name Type Description Notes
setup_flow_id String

Return type

SetupFlowResponse

Authorization

HTTPBasic, HTTPBearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

update_setup_flow

update_setup_flow(setup_flow_id, setup_flow_update_request)

Update Setup Flow

Examples

require 'time'
require 'payjpv2'
# setup authorization
PAYJPv2.configure do |config|
  # Configure HTTP basic authorization: HTTPBasic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure Bearer authorization: HTTPBearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PAYJPv2::SetupFlowsApi.new
setup_flow_id = 'setup_flow_id_example' # String | 
setup_flow_update_request = PAYJPv2::SetupFlowUpdateRequest.new # SetupFlowUpdateRequest | 

begin
  # Update Setup Flow
  result = api_instance.update_setup_flow(setup_flow_id, setup_flow_update_request)
  p result
rescue PAYJPv2::ApiError => e
  puts "Error when calling SetupFlowsApi->update_setup_flow: #{e}"
end

Using the include_http_info option

To get response data along with status code and headers, use the include_http_info: true option.

begin
  # Update Setup Flow
  data, status_code, headers = api_instance.update_setup_flow(setup_flow_id, setup_flow_update_request, { include_http_info: true })
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SetupFlowResponse>
rescue PAYJPv2::ApiError => e
  puts "Error when calling SetupFlowsApi->update_setup_flow: #{e}"
end

Parameters

Name Type Description Notes
setup_flow_id String
setup_flow_update_request SetupFlowUpdateRequest

Return type

SetupFlowResponse

Authorization

HTTPBasic, HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json