Class: Stripe::V2::Iam::ApiKeyService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/v2/iam/api_key_service.rb

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#create(params = {}, opts = {}) ⇒ Object

Create an API key.



9
10
11
12
13
14
15
16
17
 
# File 'lib/stripe/services/v2/iam/api_key_service.rb', line 9

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v2/iam/api_keys",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#expire(id, params = {}, opts = {}) ⇒ Object

Expire an API key.



20
21
22
23
24
25
26
27
28
 
# File 'lib/stripe/services/v2/iam/api_key_service.rb', line 20

def expire(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/iam/api_keys/%<id>s/expire", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(params = {}, opts = {}) ⇒ Object

List all API keys of an account.



31
32
33
34
35
36
37
38
39
 
# File 'lib/stripe/services/v2/iam/api_key_service.rb', line 31

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v2/iam/api_keys",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(id, params = {}, opts = {}) ⇒ Object

Retrieve an API key.



42
43
44
45
46
47
48
49
50
 
# File 'lib/stripe/services/v2/iam/api_key_service.rb', line 42

def retrieve(id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v2/iam/api_keys/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#rotate(id, params = {}, opts = {}) ⇒ Object

Rotate an API key.



53
54
55
56
57
58
59
60
61
 
# File 'lib/stripe/services/v2/iam/api_key_service.rb', line 53

def rotate(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/iam/api_keys/%<id>s/rotate", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(id, params = {}, opts = {}) ⇒ Object

Update an API key.



64
65
66
67
68
69
70
71
72
 
# File 'lib/stripe/services/v2/iam/api_key_service.rb', line 64

def update(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/iam/api_keys/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end