Class: Payabli::Notificationlogs::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/payabli/notificationlogs/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



9
10
11
 
# File 'lib/payabli/notificationlogs/client.rb', line 9

def initialize(client:)
  @client = client
end

Instance Method Details

#bulk_retry_notification_logs(request_options: {}, **params) ⇒ untyped

Retry sending multiple notifications (maximum 50 IDs). This is an async process, so use the search endpoint again to check the notification status.

This endpoint requires the notifications_create permission.

Examples:

client.notificationlogs.bulk_retry_notification_logs(request: %w[550e8400-e29b-41d4-a716-446655440000 550e8400-e29b-41d4-a716-446655440001 550e8400-e29b-41d4-a716-446655440002])

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:

  • (untyped)

Raises:

  • (error_class) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/payabli/notificationlogs/client.rb', line 170

def bulk_retry_notification_logs(request_options: {}, **params)
  params = Payabli::Internal::Types::Utils.normalize_keys(params)
  headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
  request = Payabli::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v2/notificationlogs/retry",
    headers: headers,
    body: params,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Payabli::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#get_notification_log(request_options: {}, **params) ⇒ Payabli::Types::NotificationLogDetail

Get detailed information for a specific notification log entry. This endpoint requires the notifications_create OR notifications_read permission.

Examples:

client.notificationlogs.get_notification_log(uuid: "550e8400-e29b-41d4-a716-446655440000")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :uuid (String)

Returns:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/payabli/notificationlogs/client.rb', line 88

def get_notification_log(request_options: {}, **params)
  params = Payabli::Internal::Types::Utils.normalize_keys(params)
  headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
  request = Payabli::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v2/notificationlogs/#{URI.encode_uri_component(params[:uuid].to_s)}",
    headers: headers,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Payabli::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Payabli::Types::NotificationLogDetail.load(response.body)
  else
    error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#retry_notification_log(request_options: {}, **params) ⇒ Payabli::Types::NotificationLogDetail

Retry sending a specific notification.

Permissions: notifications_create

Examples:

client.notificationlogs.retry_notification_log(uuid: "550e8400-e29b-41d4-a716-446655440000")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :uuid (String)

Returns:



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/payabli/notificationlogs/client.rb', line 129

def retry_notification_log(request_options: {}, **params)
  params = Payabli::Internal::Types::Utils.normalize_keys(params)
  headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
  request = Payabli::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v2/notificationlogs/#{URI.encode_uri_component(params[:uuid].to_s)}/retry",
    headers: headers,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Payabli::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Payabli::Types::NotificationLogDetail.load(response.body)
  else
    error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#search_notification_logs(request_options: {}, **params) ⇒ Array[Payabli::Types::NotificationLog]

Search notification logs with filtering and pagination.

  • Start date and end date cannot be more than 30 days apart
  • Either orgId or paypointId must be provided

This endpoint requires the notifications_create OR notifications_read permission.

Examples:

client.notificationlogs.search_notification_logs(
  page_size: 20,
  start_date: "2024-01-01T00:00:00Z",
  end_date: "2024-01-31T23:59:59Z",
  notification_event: "ActivatedMerchant",
  succeeded: true,
  org_id: 123
)

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :page_size (Integer, nil)
  • :page (Integer, nil)

Returns:

Raises:

  • (error_class) 


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
 
# File 'lib/payabli/notificationlogs/client.rb', line 40

def search_notification_logs(request_options: {}, **params)
  params = Payabli::Internal::Types::Utils.normalize_keys(params)
  request_data = Payabli::Notificationlogs::Types::SearchNotificationLogsRequest.new(params).to_h
  non_body_param_names = %w[PageSize Page]
  body = request_data.except(*non_body_param_names)

  query_params = {}
  query_params["PageSize"] = params[:page_size] if params.key?(:page_size)
  query_params["Page"] = params[:page] if params.key?(:page)

  headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
  request = Payabli::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v2/notificationlogs",
    headers: headers,
    query: query_params,
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Payabli::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end