Class: MaxApiClient::SubscriptionsApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/max_api_client/raw_api.rb,
sig/max_api_client.rbs

Overview

Raw update subscription endpoints.

Constant Summary

Constants inherited from BaseApi

BaseApi::HTTP_METHODS

Instance Method Summary collapse

Methods inherited from BaseApi

#initialize

Constructor Details

This class inherits a constructor from MaxApiClient::BaseApi

Instance Method Details

#get_subscriptions ⇒ Object

rubocop:disable Naming/AccessorMethodName

Returns:

  • (Object) 


145
146
147
 
# File 'lib/max_api_client/raw_api.rb', line 145

def get_subscriptions
  get("subscriptions")
end

#get_updates(read_timeout: nil, **query) ⇒ Object

Parameters:

  • limit: (Integer, nil)
  • timeout: (Integer, nil)
  • marker: (Integer, nil)
  • types: (String, nil)
  • read_timeout: (Numeric, nil) (defaults to: nil)

Returns:

  • (Object) 


158
159
160
 
# File 'lib/max_api_client/raw_api.rb', line 158

def get_updates(read_timeout: nil, **query)
  get("updates", query:, read_timeout:)
end

#subscribe(url:, update_types: nil, secret: nil) ⇒ Object

rubocop:enable Naming/AccessorMethodName

Parameters:

  • url: (String)
  • update_types: (Array[String], String, nil) (defaults to: nil)
  • secret: (String, nil) (defaults to: nil)

Returns:

  • (Object) 


150
151
152
 
# File 'lib/max_api_client/raw_api.rb', line 150

def subscribe(url:, update_types: nil, secret: nil)
  post("subscriptions", body: compact_nil(url:, update_types:, secret:))
end

#unsubscribe(url:) ⇒ Object

Parameters:

  • url: (String)

Returns:

  • (Object) 


154
155
156
 
# File 'lib/max_api_client/raw_api.rb', line 154

def unsubscribe(url:)
  delete("subscriptions", query: { url: })
end