Class: QuicknodeSdk::Admin

Inherits:
NativeDelegator show all
Defined in:
lib/quicknode_sdk/clients/admin.rb,
sig/quicknode_sdk.rbs

Instance Method Summary collapse

Methods inherited from NativeDelegator

#method_missing, #respond_to_missing?

Constructor Details

#initialize ⇒ Admin

Returns a new instance of Admin.

Parameters:

  • native (Object) 


48
 
# File 'sig/quicknode_sdk.rbs', line 48

def initialize: (untyped native) -> void

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class QuicknodeSdk::NativeDelegator

Instance Method Details

#account_info ⇒ Object

Returns:

  • (Object) 


94
 
# File 'sig/quicknode_sdk.rbs', line 94

def account_info: () -> untyped

#archive_endpoint ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String) 


54
 
# File 'sig/quicknode_sdk.rbs', line 54

def archive_endpoint: (id: String) -> void

#bulk_add_tag ⇒ Object

Parameters:

  • ids: (Array[String])
  • label: (String)

Returns:

  • (Object) 


108
 
# File 'sig/quicknode_sdk.rbs', line 108

def bulk_add_tag: (ids: Array[String], label: String) -> untyped

#bulk_remove_tag ⇒ Object

Parameters:

  • ids: (Array[String])
  • tag_id: (Integer)

Returns:

  • (Object) 


109
 
# File 'sig/quicknode_sdk.rbs', line 109

def bulk_remove_tag: (ids: Array[String], tag_id: Integer) -> untyped

#bulk_update_endpoint_status ⇒ Object

Parameters:

  • ids: (Array[String])
  • status: (String)

Returns:

  • (Object) 


107
 
# File 'sig/quicknode_sdk.rbs', line 107

def bulk_update_endpoint_status: (ids: Array[String], status: String) -> untyped

#create_domain_mask ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • domain_mask: (String) 


72
 
# File 'sig/quicknode_sdk.rbs', line 72

def create_domain_mask: (id: String, ?domain_mask: String) -> void

#create_endpoint ⇒ Object

Parameters:

  • chain: (String)
  • network: (String)

Returns:

  • (Object) 


51
 
# File 'sig/quicknode_sdk.rbs', line 51

def create_endpoint: (?chain: String, ?network: String) -> untyped

#create_ip ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • ip: (String) 


70
 
# File 'sig/quicknode_sdk.rbs', line 70

def create_ip: (id: String, ip: String) -> void

#create_jwt ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • kid: (String)
  • public_key: (String)
  • name: (String) 


74
 
# File 'sig/quicknode_sdk.rbs', line 74

def create_jwt: (id: String, kid: String, public_key: String, name: String) -> void

#create_method_rate_limit ⇒ Object

Parameters:

  • id: (String)
  • interval: (String)
  • methods: (Array[String])
  • rate: (Integer)

Returns:

  • (Object) 


84
 
# File 'sig/quicknode_sdk.rbs', line 84

def create_method_rate_limit: (id: String, interval: String, methods: Array[String], rate: Integer) -> untyped

#create_or_update_ip_custom_header ⇒ Object

Parameters:

  • id: (String)
  • header_name: (String)

Returns:

  • (Object) 


81
 
# File 'sig/quicknode_sdk.rbs', line 81

def create_or_update_ip_custom_header: (id: String, header_name: String) -> untyped

#create_referrer ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • referrer: (String) 


68
 
# File 'sig/quicknode_sdk.rbs', line 68

def create_referrer: (id: String, referrer: String) -> void

#create_request_filter ⇒ Object

Parameters:

  • id: (String)
  • methods: (Array[String])

Returns:

  • (Object) 


76
 
# File 'sig/quicknode_sdk.rbs', line 76

def create_request_filter: (id: String, methods: Array[String]) -> untyped

#create_tag ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • label: (String) 


56
 
# File 'sig/quicknode_sdk.rbs', line 56

def create_tag: (id: String, ?label: String) -> void

#create_team ⇒ Object

Parameters:

  • name: (String)

Returns:

  • (Object) 


99
 
# File 'sig/quicknode_sdk.rbs', line 99

def create_team: (name: String) -> untyped

#create_token ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String) 


66
 
# File 'sig/quicknode_sdk.rbs', line 66

def create_token: (id: String) -> void

#delete_account_tag ⇒ Object

Parameters:

  • id: (Integer)

Returns:

  • (Object) 


112
 
# File 'sig/quicknode_sdk.rbs', line 112

def delete_account_tag: (id: Integer) -> untyped

#delete_domain_mask ⇒ Object

Parameters:

  • id: (String)
  • domain_mask_id: (String)

Returns:

  • (Object) 


73
 
# File 'sig/quicknode_sdk.rbs', line 73

def delete_domain_mask: (id: String, domain_mask_id: String) -> untyped

#delete_ip ⇒ Object

Parameters:

  • id: (String)
  • ip_id: (String)

Returns:

  • (Object) 


71
 
# File 'sig/quicknode_sdk.rbs', line 71

def delete_ip: (id: String, ip_id: String) -> untyped

#delete_ip_custom_header ⇒ Object

Parameters:

  • id: (String)

Returns:

  • (Object) 


82
 
# File 'sig/quicknode_sdk.rbs', line 82

def delete_ip_custom_header: (id: String) -> untyped

#delete_jwt ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • jwt_id: (String) 


75
 
# File 'sig/quicknode_sdk.rbs', line 75

def delete_jwt: (id: String, jwt_id: String) -> void

#delete_method_rate_limit ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • method_rate_limit_id: (String) 


86
 
# File 'sig/quicknode_sdk.rbs', line 86

def delete_method_rate_limit: (id: String, method_rate_limit_id: String) -> void

#delete_rate_limit_override ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • override_id: (String) 


89
 
# File 'sig/quicknode_sdk.rbs', line 89

def delete_rate_limit_override: (id: String, override_id: String) -> void

#delete_referrer ⇒ Object

Parameters:

  • id: (String)
  • referrer_id: (String)

Returns:

  • (Object) 


69
 
# File 'sig/quicknode_sdk.rbs', line 69

def delete_referrer: (id: String, referrer_id: String) -> untyped

#delete_request_filter ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • request_filter_id: (String) 


78
 
# File 'sig/quicknode_sdk.rbs', line 78

def delete_request_filter: (id: String, request_filter_id: String) -> void

#delete_tag ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • tag_id: (String) 


57
 
# File 'sig/quicknode_sdk.rbs', line 57

def delete_tag: (id: String, tag_id: String) -> void

#delete_team ⇒ Object

Parameters:

  • id: (Integer)

Returns:

  • (Object) 


101
 
# File 'sig/quicknode_sdk.rbs', line 101

def delete_team: (id: Integer) -> untyped

#delete_token ⇒ Object

Parameters:

  • id: (String)
  • token_id: (String)

Returns:

  • (Object) 


67
 
# File 'sig/quicknode_sdk.rbs', line 67

def delete_token: (id: String, token_id: String) -> untyped

#disable_multichain ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String) 


80
 
# File 'sig/quicknode_sdk.rbs', line 80

def disable_multichain: (id: String) -> void

#enable_multichain ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String) 


79
 
# File 'sig/quicknode_sdk.rbs', line 79

def enable_multichain: (id: String) -> void

#get_account_metrics ⇒ Object

Parameters:

  • period: (String)
  • metric: (String)
  • percentile: (String)

Returns:

  • (Object) 


92
 
# File 'sig/quicknode_sdk.rbs', line 92

def get_account_metrics: (period: String, metric: String, ?percentile: String) -> untyped

#get_api_credits ⇒ Object

Parameters:

  • chain: (String)

Returns:

  • (Object) 


95
 
# File 'sig/quicknode_sdk.rbs', line 95

def get_api_credits: (chain: String) -> untyped

#get_endpoint_logs ⇒ Object

Parameters:

  • id: (String)
  • from_time: (String)
  • to_time: (String)
  • include_details: (Boolean)
  • limit: (Integer)
  • next_at: (String)

Returns:

  • (Object) 


62
 
# File 'sig/quicknode_sdk.rbs', line 62

def get_endpoint_logs: (id: String, from_time: String, to_time: String, ?include_details: bool, ?limit: Integer, ?next_at: String) -> untyped

#get_endpoint_metrics ⇒ Object

Parameters:

  • id: (String)
  • period: (String)
  • metric: (String)

Returns:

  • (Object) 


91
 
# File 'sig/quicknode_sdk.rbs', line 91

def get_endpoint_metrics: (id: String, period: String, metric: String) -> untyped

#get_endpoint_security ⇒ Object

Parameters:

  • id: (String)

Returns:

  • (Object) 


114
 
# File 'sig/quicknode_sdk.rbs', line 114

def get_endpoint_security: (id: String) -> untyped

#get_endpoint_urls ⇒ Object

Parameters:

  • id: (String)

Returns:

  • (Object) 


90
 
# File 'sig/quicknode_sdk.rbs', line 90

def get_endpoint_urls: (id: String) -> untyped

#get_endpoints ⇒ Object

Parameters:

  • limit: (Integer)
  • offset: (Integer)
  • search: (String)
  • sort_by: (String)
  • sort_direction: (String)
  • networks: (Array[String])
  • statuses: (Array[String])
  • labels: (Array[String])
  • dedicated: (Boolean)
  • is_flat_rate: (Boolean)
  • tag_ids: (Array[Integer])
  • tag_labels: (Array[String])

Returns:

  • (Object) 


50
 
# File 'sig/quicknode_sdk.rbs', line 50

def get_endpoints: (?limit: Integer, ?offset: Integer, ?search: String, ?sort_by: String, ?sort_direction: String, ?networks: Array[String], ?statuses: Array[String], ?labels: Array[String], ?dedicated: bool, ?is_flat_rate: bool, ?tag_ids: Array[Integer], ?tag_labels: Array[String]) -> untyped

#get_log_details ⇒ Object

Parameters:

  • id: (String)
  • request_id: (String)

Returns:

  • (Object) 


63
 
# File 'sig/quicknode_sdk.rbs', line 63

def get_log_details: (id: String, request_id: String) -> untyped

#get_method_rate_limits ⇒ Object

Parameters:

  • id: (String)

Returns:

  • (Object) 


83
 
# File 'sig/quicknode_sdk.rbs', line 83

def get_method_rate_limits: (id: String) -> untyped

#get_rate_limits ⇒ Object

Parameters:

  • id: (String)

Returns:

  • (Object) 


88
 
# File 'sig/quicknode_sdk.rbs', line 88

def get_rate_limits: (id: String) -> untyped

#get_security_options ⇒ Object

Parameters:

  • id: (String)

Returns:

  • (Object) 


64
 
# File 'sig/quicknode_sdk.rbs', line 64

def get_security_options: (id: String) -> untyped

#get_team ⇒ Object

Parameters:

  • id: (Integer)

Returns:

  • (Object) 


100
 
# File 'sig/quicknode_sdk.rbs', line 100

def get_team: (id: Integer) -> untyped

#get_usage ⇒ Object

Parameters:

  • start_time: (Integer)
  • end_time: (Integer)

Returns:

  • (Object) 


58
 
# File 'sig/quicknode_sdk.rbs', line 58

def get_usage: (?start_time: Integer, ?end_time: Integer) -> untyped

#get_usage_by_chain ⇒ Object

Parameters:

  • start_time: (Integer)
  • end_time: (Integer)

Returns:

  • (Object) 


61
 
# File 'sig/quicknode_sdk.rbs', line 61

def get_usage_by_chain: (?start_time: Integer, ?end_time: Integer) -> untyped

#get_usage_by_endpoint ⇒ Object

Parameters:

  • start_time: (Integer)
  • end_time: (Integer)

Returns:

  • (Object) 


59
 
# File 'sig/quicknode_sdk.rbs', line 59

def get_usage_by_endpoint: (?start_time: Integer, ?end_time: Integer) -> untyped

#get_usage_by_method ⇒ Object

Parameters:

  • start_time: (Integer)
  • end_time: (Integer)

Returns:

  • (Object) 


60
 
# File 'sig/quicknode_sdk.rbs', line 60

def get_usage_by_method: (?start_time: Integer, ?end_time: Integer) -> untyped

#get_usage_by_tag ⇒ Object

Parameters:

  • start_time: (Integer)
  • end_time: (Integer)

Returns:

  • (Object) 


113
 
# File 'sig/quicknode_sdk.rbs', line 113

def get_usage_by_tag: (?start_time: Integer, ?end_time: Integer) -> untyped

#invite_team_member ⇒ Object

Parameters:

  • id: (Integer)
  • email: (String)
  • full_name: (String)
  • role: (String)

Returns:

  • (Object) 


104
 
# File 'sig/quicknode_sdk.rbs', line 104

def invite_team_member: (id: Integer, email: String, ?full_name: String, ?role: String) -> untyped

#list_chains ⇒ Object

Returns:

  • (Object) 


93
 
# File 'sig/quicknode_sdk.rbs', line 93

def list_chains: () -> untyped

#list_invoices ⇒ Object

Returns:

  • (Object) 


96
 
# File 'sig/quicknode_sdk.rbs', line 96

def list_invoices: () -> untyped

#list_payments ⇒ Object

Returns:

  • (Object) 


97
 
# File 'sig/quicknode_sdk.rbs', line 97

def list_payments: () -> untyped

#list_tags ⇒ Object

Returns:

  • (Object) 


110
 
# File 'sig/quicknode_sdk.rbs', line 110

def list_tags: () -> untyped

#list_team_endpoints ⇒ Object

Parameters:

  • id: (Integer)

Returns:

  • (Object) 


102
 
# File 'sig/quicknode_sdk.rbs', line 102

def list_team_endpoints: (id: Integer) -> untyped

#list_teams ⇒ Object

Returns:

  • (Object) 


98
 
# File 'sig/quicknode_sdk.rbs', line 98

def list_teams: () -> untyped

#remove_team_member ⇒ Object

Parameters:

  • id: (Integer)
  • user_id: (Integer)
  • destroy_user: (Boolean)

Returns:

  • (Object) 


105
 
# File 'sig/quicknode_sdk.rbs', line 105

def remove_team_member: (id: Integer, user_id: Integer, ?destroy_user: bool) -> untyped

#rename_tag ⇒ Object

Parameters:

  • id: (Integer)
  • label: (String)

Returns:

  • (Object) 


111
 
# File 'sig/quicknode_sdk.rbs', line 111

def rename_tag: (id: Integer, label: String) -> untyped

#resend_team_invite ⇒ Object

Parameters:

  • id: (Integer)
  • user_id: (Integer)

Returns:

  • (Object) 


106
 
# File 'sig/quicknode_sdk.rbs', line 106

def resend_team_invite: (id: Integer, user_id: Integer) -> untyped

#show_endpoint ⇒ Object

Parameters:

  • id: (String)

Returns:

  • (Object) 


52
 
# File 'sig/quicknode_sdk.rbs', line 52

def show_endpoint: (id: String) -> untyped

#update_endpoint ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • label: (String) 


53
 
# File 'sig/quicknode_sdk.rbs', line 53

def update_endpoint: (id: String, ?label: String) -> void

#update_endpoint_status ⇒ Object

Parameters:

  • id: (String)
  • status: (String)

Returns:

  • (Object) 


55
 
# File 'sig/quicknode_sdk.rbs', line 55

def update_endpoint_status: (id: String, status: String) -> untyped

#update_method_rate_limit ⇒ Object

Parameters:

  • id: (String)
  • method_rate_limit_id: (String)
  • methods: (Array[String])
  • status: (String)
  • rate: (Integer)

Returns:

  • (Object) 


85
 
# File 'sig/quicknode_sdk.rbs', line 85

def update_method_rate_limit: (id: String, method_rate_limit_id: String, ?methods: Array[String], ?status: String, ?rate: Integer) -> untyped

#update_rate_limits ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • rps: (Integer)
  • rpm: (Integer)
  • rpd: (Integer) 


87
 
# File 'sig/quicknode_sdk.rbs', line 87

def update_rate_limits: (id: String, ?rps: Integer, ?rpm: Integer, ?rpd: Integer) -> void

#update_request_filter ⇒ void

This method returns an undefined value.

Parameters:

  • id: (String)
  • request_filter_id: (String)
  • methods: (Array[String]) 


77
 
# File 'sig/quicknode_sdk.rbs', line 77

def update_request_filter: (id: String, request_filter_id: String, ?methods: Array[String]) -> void

#update_security_options ⇒ Object

Parameters:

  • id: (String)
  • tokens: (String)
  • referrers: (String)
  • jwts: (String)
  • ips: (String)
  • domain_masks: (String)
  • hsts: (String)
  • cors: (String)
  • request_filters: (String)
  • ip_custom_header: (String)

Returns:

  • (Object) 


65
 
# File 'sig/quicknode_sdk.rbs', line 65

def update_security_options: (id: String, ?tokens: String, ?referrers: String, ?jwts: String, ?ips: String, ?domain_masks: String, ?hsts: String, ?cors: String, ?request_filters: String, ?ip_custom_header: String) -> untyped

#update_team_endpoints ⇒ Object

Parameters:

  • id: (Integer)
  • endpoint_ids: (Array[String])

Returns:

  • (Object) 


103
 
# File 'sig/quicknode_sdk.rbs', line 103

def update_team_endpoints: (id: Integer, endpoint_ids: Array[String]) -> untyped