Class: Hook0::Generated::RequestAttemptsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hook0/generated/api.rb

Overview

What the API declares under requestAttempts, issued through the transport it is handed.

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ RequestAttemptsApi

Returns a new instance of RequestAttemptsApi.

Parameters:

  • transport (Object) —

    what one request is issued through



698
699
700
 
# File 'lib/hook0/generated/api.rb', line 698

def initialize(transport)
  @transport = transport
end

Instance Method Details

#get(request_attempt_id, application_id) ⇒ RequestAttempt

Get a request attempt by its ID

Parameters:

  • request_attempt_id (String) —

    carries request_attempt_id.

  • application_id (String) —

    carries application_id.

Returns:



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/hook0/generated/api.rb', line 707

def get(request_attempt_id, application_id)
  read_answer(
    @transport.request(
      "GET",
      Runtime.path(
        "/api/v1/request_attempts/{request_attempt_id}",
        "request_attempt_id" => request_attempt_id
      ),
      Runtime.query(
        [
          ["application_id", application_id]
        ],
        []
      ),
      nil
    ),
    RequestAttempt.method(:from_json)
  )
end

#read(application_id, event_event_type_names: nil, event_id: nil, max_created_at: nil, min_created_at: nil, pagination_cursor: nil, subscription_id: nil) ⇒ Array<RequestAttempt>

List request attempts

Parameters:

  • application_id (String) —

    carries application_id.

  • event_event_type_names (String, nil) (defaults to: nil) —

    carries event.event_type_names: Comma-separated event types

  • event_id (String, nil) (defaults to: nil) —

    carries event_id.

  • max_created_at (String, nil) (defaults to: nil) —

    carries max_created_at.

  • min_created_at (String, nil) (defaults to: nil) —

    carries min_created_at.

  • pagination_cursor (String, nil) (defaults to: nil) —

    carries pagination_cursor.

  • subscription_id (String, nil) (defaults to: nil) —

    carries subscription_id.

Returns:



737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/hook0/generated/api.rb', line 737

def read(
  application_id,
  event_event_type_names: nil,
  event_id: nil,
  max_created_at: nil,
  min_created_at: nil,
  pagination_cursor: nil,
  subscription_id: nil
)
  read_answer(
    @transport.request(
      "GET",
      "/api/v1/request_attempts/",
      Runtime.query(
        [
          ["application_id", application_id]
        ],
        [
          ["event.event_type_names", event_event_type_names],
          ["event_id", event_id],
          ["max_created_at", max_created_at],
          ["min_created_at", min_created_at],
          ["pagination_cursor", pagination_cursor],
          ["subscription_id", subscription_id]
        ]
      ),
      nil
    ),
    Runtime.list(RequestAttempt.method(:from_json))
  )
end