Class: XTwitterScraper::Resources::Support::Tickets

Inherits:
Object
  • Object
show all
Defined in:
lib/x_twitter_scraper/resources/support/tickets.rb

Overview

Support ticket management

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Tickets

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 Tickets.

Parameters:



119
120
121
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 119

def initialize(client:)
  @client = client
end

Instance Method Details

#create(body:, subject:, request_options: {}) ⇒ XTwitterScraper::Models::Support::TicketCreateResponse

Create a support ticket

Parameters:

Returns:

See Also:



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 19

def create(params)
  parsed, options = XTwitterScraper::Support::TicketCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "support/tickets",
    body: parsed,
    model: XTwitterScraper::Models::Support::TicketCreateResponse,
    options: options
  )
end

#list(request_options: {}) ⇒ XTwitterScraper::Models::Support::TicketListResponse

List user’s support tickets

Parameters:

Returns:

See Also:



83
84
85
86
87
88
89
90
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 83

def list(params = {})
  @client.request(
    method: :get,
    path: "support/tickets",
    model: XTwitterScraper::Models::Support::TicketListResponse,
    options: params[:request_options]
  )
end

#reply(id, body:, request_options: {}) ⇒ XTwitterScraper::Models::Support::TicketReplyResponse

Reply to a support ticket

Parameters:

Returns:

See Also:



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 105

def reply(id, params)
  parsed, options = XTwitterScraper::Support::TicketReplyParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["support/tickets/%1$s/messages", id],
    body: parsed,
    model: XTwitterScraper::Models::Support::TicketReplyResponse,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ XTwitterScraper::Models::Support::TicketRetrieveResponse

Get ticket with all messages

Parameters:

Returns:

See Also:



41
42
43
44
45
46
47
48
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 41

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["support/tickets/%1$s", id],
    model: XTwitterScraper::Models::Support::TicketRetrieveResponse,
    options: params[:request_options]
  )
end

#update(id, status:, request_options: {}) ⇒ XTwitterScraper::Models::Support::TicketUpdateResponse

Update ticket status

Parameters:

Returns:

See Also:



63
64
65
66
67
68
69
70
71
72
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 63

def update(id, params)
  parsed, options = XTwitterScraper::Support::TicketUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["support/tickets/%1$s", id],
    body: parsed,
    model: XTwitterScraper::Models::Support::TicketUpdateResponse,
    options: options
  )
end