Class: Courier::Resources::Users::Tokens

Inherits:
Object
  • Object
show all
Defined in:
lib/courier/resources/users/tokens.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Tokens

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Tokens.

Parameters:



175
176
177
 
# File 'lib/courier/resources/users/tokens.rb', line 175

def initialize(client:)
  @client = client
end

Instance Method Details

#add_multiple(user_id, request_options: {}) ⇒ nil

Adds multiple tokens to a user and overwrites matching existing tokens.

Parameters:

  • user_id (String) —

    The user’s ID. This can be any uniquely identifiable string.

  • request_options (Courier::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



122
123
124
125
126
127
128
129
 
# File 'lib/courier/resources/users/tokens.rb', line 122

def add_multiple(user_id, params = {})
  @client.request(
    method: :put,
    path: ["users/%1$s/tokens", user_id],
    model: NilClass,
    options: params[:request_options]
  )
end

#add_single(token, user_id:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {}) ⇒ nil

Some parameter documentations has been truncated, see Models::Users::TokenAddSingleParams for more details.

Adds a single token to a user and overwrites a matching existing token.

Parameters:

Returns:

  • (nil)

See Also:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/courier/resources/users/tokens.rb', line 157

def add_single(token, params)
  parsed, options = Courier::Users::TokenAddSingleParams.dump_request(params)
  user_id =
    parsed.delete(:user_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :put,
    path: ["users/%1$s/tokens/%2$s", user_id, token],
    body: parsed,
    model: NilClass,
    options: options
  )
end

#delete(token, user_id:, request_options: {}) ⇒ nil

Delete User Token

Parameters:

  • token (String) —

    The full token string.

  • user_id (String) —

    The user’s ID. This can be any uniquely identifiable string.

  • request_options (Courier::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/courier/resources/users/tokens.rb', line 97

def delete(token, params)
  parsed, options = Courier::Users::TokenDeleteParams.dump_request(params)
  user_id =
    parsed.delete(:user_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["users/%1$s/tokens/%2$s", user_id, token],
    model: NilClass,
    options: options
  )
end

#list(user_id, request_options: {}) ⇒ Courier::Models::Users::TokenListResponse

Gets all tokens available for a :user_id

Parameters:

  • user_id (String) —

    The user’s ID. This can be any uniquely identifiable string.

  • request_options (Courier::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



75
76
77
78
79
80
81
82
 
# File 'lib/courier/resources/users/tokens.rb', line 75

def list(user_id, params = {})
  @client.request(
    method: :get,
    path: ["users/%1$s/tokens", user_id],
    model: Courier::Models::Users::TokenListResponse,
    options: params[:request_options]
  )
end

#retrieve(token, user_id:, request_options: {}) ⇒ Courier::Models::Users::TokenRetrieveResponse

Get single token available for a ‘:token`

Parameters:

  • token (String) —

    The full token string.

  • user_id (String) —

    The user’s ID. This can be any uniquely identifiable string.

  • request_options (Courier::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/courier/resources/users/tokens.rb', line 20

def retrieve(token, params)
  parsed, options = Courier::Users::TokenRetrieveParams.dump_request(params)
  user_id =
    parsed.delete(:user_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["users/%1$s/tokens/%2$s", user_id, token],
    model: Courier::Models::Users::TokenRetrieveResponse,
    options: options
  )
end

#update(token, user_id:, patch:, request_options: {}) ⇒ nil

Apply a JSON Patch (RFC 6902) to the specified token.

Parameters:

Returns:

  • (nil)

See Also:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/courier/resources/users/tokens.rb', line 49

def update(token, params)
  parsed, options = Courier::Users::TokenUpdateParams.dump_request(params)
  user_id =
    parsed.delete(:user_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :patch,
    path: ["users/%1$s/tokens/%2$s", user_id, token],
    body: parsed,
    model: NilClass,
    options: options
  )
end