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

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

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:



139
140
141
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 139

def initialize(client:)
  @client = client
end

Instance Method Details

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

Some parameter documentations has been truncated, see Models::Support::TicketCreateParams for more details.

Create a support ticket

Parameters:

  • body (String) —

    Body param

  • subject (String) —

    Body param

  • idempotency_key (String) —

    Header param: Generate one random value per ticket or reply. Reuse it only when

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

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 30

def create(params)
  parsed, options = XTwitterScraper::Support::TicketCreateParams.dump_request(params)
  header_params = {idempotency_key: "idempotency-key"}
  @client.request(
    method: :post,
    path: "support/tickets",
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: XTwitterScraper::Models::Support::TicketCreateResponse,
    options: options
  )
end

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

List user's support tickets

Parameters:

Returns:

See Also:



96
97
98
99
100
101
102
103
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 96

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

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

Some parameter documentations has been truncated, see Models::Support::TicketReplyParams for more details.

Reply to a support ticket

Parameters:

  • id (String) —

    Path param: Support ticket public ID for the reply

  • body (String) —

    Body param

  • idempotency_key (String) —

    Header param: Generate one random value per ticket or reply. Reuse it only when

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

Returns:

See Also:



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 123

def reply(id, params)
  parsed, options = XTwitterScraper::Support::TicketReplyParams.dump_request(params)
  header_params = {idempotency_key: "idempotency-key"}
  @client.request(
    method: :post,
    path: ["support/tickets/%1$s/messages", id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    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:



54
55
56
57
58
59
60
61
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 54

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:



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/x_twitter_scraper/resources/support/tickets.rb', line 76

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