Class: Ingenico::Connect::SDK::Merchant::Tokens::TokensClient

Inherits:
ApiResource
  • Object
show all
Defined in:
lib/ingenico/connect/sdk/merchant/tokens/tokens_client.rb

Overview

Tokens client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary collapse

Constructor Details

#initialize(parent, path_context) ⇒ TokensClient

parent

ApiResource

path_context

Hash of String to String



20
21
22
 
# File 'lib/ingenico/connect/sdk/merchant/tokens/tokens_client.rb', line 20

def initialize(parent, path_context)
  super(parent, path_context)
end

Instance Method Details

#approvesepadirectdebit(token_id, body, context = nil) ⇒ Object

Resource /{merchantId}/tokens/{tokenId}/approvesepadirectdebit

Approve SEPA DD mandate

token_id

String

body

Domain::Token::ApproveTokenRequest

context

CallContext

Raises

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raises

AuthorizationException if the request was not allowed (HTTP status code 403)

Raises

IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)

Raises

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed,

or there was a conflict (HTTP status code 404, 409 or 410)

Raises

GlobalCollectException if something went wrong at the Ingenico ePayments platform,

the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,

or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raises

ApiException if the Ingenico ePayments platform returned any other error



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/ingenico/connect/sdk/merchant/tokens/tokens_client.rb', line 166

def approvesepadirectdebit(token_id, body, context=nil)
  path_context = {
    'tokenId' => token_id,
  }
  uri = instantiate_uri('/{apiVersion}/{merchantId}/tokens/{tokenId}/approvesepadirectdebit', path_context)
  return @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    nil,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#create(body, context = nil) ⇒ Object

Resource /{merchantId}/tokens

Create token

body

Domain::Token::CreateTokenRequest

context

CallContext

Returns

Domain::Token::CreateTokenResponse

Raises

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raises

AuthorizationException if the request was not allowed (HTTP status code 403)

Raises

IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)

Raises

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed,

or there was a conflict (HTTP status code 404, 409 or 410)

Raises

GlobalCollectException if something went wrong at the Ingenico ePayments platform,

the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,

or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raises

ApiException if the Ingenico ePayments platform returned any other error



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/ingenico/connect/sdk/merchant/tokens/tokens_client.rb', line 39

def create(body, context=nil)
  uri = instantiate_uri('/{apiVersion}/{merchantId}/tokens', nil)
  return @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Ingenico::Connect::SDK::Domain::Token::CreateTokenResponse,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#delete(token_id, query, context = nil) ⇒ Object

Resource /{merchantId}/tokens/{tokenId}

Delete token

token_id

String

query

DeleteTokenParams

context

CallContext

Raises

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raises

AuthorizationException if the request was not allowed (HTTP status code 403)

Raises

IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)

Raises

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed,

or there was a conflict (HTTP status code 404, 409 or 410)

Raises

GlobalCollectException if something went wrong at the Ingenico ePayments platform,

the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,

or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raises

ApiException if the Ingenico ePayments platform returned any other error



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/ingenico/connect/sdk/merchant/tokens/tokens_client.rb', line 134

def delete(token_id, query, context=nil)
  path_context = {
    'tokenId' => token_id,
  }
  uri = instantiate_uri('/{apiVersion}/{merchantId}/tokens/{tokenId}', path_context)
  return @communicator.delete(
    uri,
    client_headers,
    query,
    nil,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#get(token_id, context = nil) ⇒ Object

Resource /{merchantId}/tokens/{tokenId}

Get token

token_id

String

context

CallContext

Returns

Domain::Token::TokenResponse

Raises

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raises

AuthorizationException if the request was not allowed (HTTP status code 403)

Raises

IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)

Raises

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed,

or there was a conflict (HTTP status code 404, 409 or 410)

Raises

GlobalCollectException if something went wrong at the Ingenico ePayments platform,

the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,

or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raises

ApiException if the Ingenico ePayments platform returned any other error



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ingenico/connect/sdk/merchant/tokens/tokens_client.rb', line 69

def get(token_id, context=nil)
  path_context = {
    'tokenId' => token_id,
  }
  uri = instantiate_uri('/{apiVersion}/{merchantId}/tokens/{tokenId}', path_context)
  return @communicator.get(
    uri,
    client_headers,
    nil,
    Ingenico::Connect::SDK::Domain::Token::TokenResponse,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#update(token_id, body, context = nil) ⇒ Object

Resource /{merchantId}/tokens/{tokenId}

Update token

token_id

String

body

Domain::Token::UpdateTokenRequest

context

CallContext

Raises

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raises

AuthorizationException if the request was not allowed (HTTP status code 403)

Raises

IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)

Raises

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed,

or there was a conflict (HTTP status code 404, 409 or 410)

Raises

GlobalCollectException if something went wrong at the Ingenico ePayments platform,

the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,

or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raises

ApiException if the Ingenico ePayments platform returned any other error



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/ingenico/connect/sdk/merchant/tokens/tokens_client.rb', line 101

def update(token_id, body, context=nil)
  path_context = {
    'tokenId' => token_id,
  }
  uri = instantiate_uri('/{apiVersion}/{merchantId}/tokens/{tokenId}', path_context)
  return @communicator.put(
    uri,
    client_headers,
    nil,
    body,
    nil,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end