Class: Hook0::Generated::SubscriptionsApi

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

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ SubscriptionsApi

Returns a new instance of SubscriptionsApi.

Parameters:

  • transport (Object) —

    what one request is issued through



969
970
971
 
# File 'lib/hook0/generated/api.rb', line 969

def initialize(transport)
  @transport = transport
end

Instance Method Details

#create(body) ⇒ Subscription

Create a new subscription

Parameters:

Returns:



977
978
979
980
981
982
983
984
985
986
987
 
# File 'lib/hook0/generated/api.rb', line 977

def create(body)
  read_answer(
    @transport.request(
      "POST",
      "/api/v1/subscriptions/",
      [],
      body.to_h
    ),
    Subscription.method(:from_json)
  )
end

#delete(subscription_id, application_id) ⇒ void

This method returns an undefined value.

Delete a subscription

Parameters:

  • subscription_id (String) —

    carries subscription_id.

  • application_id (String) —

    carries application_id.



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'lib/hook0/generated/api.rb', line 994

def delete(subscription_id, application_id)
  check_answer(
    @transport.request(
      "DELETE",
      Runtime.path(
        "/api/v1/subscriptions/{subscription_id}",
        "subscription_id" => subscription_id
      ),
      Runtime.query(
        [
          ["application_id", application_id]
        ],
        []
      ),
      nil
    )
  )
end

#get(subscription_id) ⇒ Subscription

Get a subscription by its ID

Parameters:

  • subscription_id (String) —

    carries subscription_id.

Returns:



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'lib/hook0/generated/api.rb', line 1017

def get(subscription_id)
  read_answer(
    @transport.request(
      "GET",
      Runtime.path(
        "/api/v1/subscriptions/{subscription_id}",
        "subscription_id" => subscription_id
      ),
      [],
      nil
    ),
    Subscription.method(:from_json)
  )
end

#list(application_id) ⇒ Array<Subscription>

List subscriptions

Parameters:

  • application_id (String) —

    carries application_id.

Returns:



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/hook0/generated/api.rb', line 1036

def list(application_id)
  read_answer(
    @transport.request(
      "GET",
      "/api/v1/subscriptions/",
      Runtime.query(
        [
          ["application_id", application_id]
        ],
        []
      ),
      nil
    ),
    Runtime.list(Subscription.method(:from_json))
  )
end

#update(subscription_id, body) ⇒ Subscription

Update a subscription

Parameters:

  • subscription_id (String) —

    carries subscription_id.

  • body (SubscriptionPost) —

    what the operation reads

Returns:



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
 
# File 'lib/hook0/generated/api.rb', line 1058

def update(subscription_id, body)
  read_answer(
    @transport.request(
      "PUT",
      Runtime.path(
        "/api/v1/subscriptions/{subscription_id}",
        "subscription_id" => subscription_id
      ),
      [],
      body.to_h
    ),
    Subscription.method(:from_json)
  )
end