Class: Zavudev::Resources::Number10dlc::Campaigns::PhoneNumbers

Inherits:
Object
  • Object
show all
Defined in:
lib/zavudev/resources/number_10dlc/campaigns/phone_numbers.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PhoneNumbers

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

Parameters:



83
84
85
 
# File 'lib/zavudev/resources/number_10dlc/campaigns/phone_numbers.rb', line 83

def initialize(client:)
  @client = client
end

Instance Method Details

#assign(campaign_id, phone_number_id:, request_options: {}) ⇒ Zavudev::Models::Number10dlc::Campaigns::PhoneNumberAssignResponse

Assign a US phone number to an approved 10DLC campaign. The campaign must be in approved status.

Parameters:

  • campaign_id (String) —

    10DLC campaign ID.

  • phone_number_id (String) —

    ID of the phone number to assign.

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

Returns:

See Also:



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/zavudev/resources/number_10dlc/campaigns/phone_numbers.rb', line 42

def assign(campaign_id, params)
  parsed, options = Zavudev::Number10dlc::Campaigns::PhoneNumberAssignParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/10dlc/campaigns/%1$s/phone-numbers", campaign_id],
    body: parsed,
    model: Zavudev::Models::Number10dlc::Campaigns::PhoneNumberAssignResponse,
    options: options
  )
end

#list(campaign_id, request_options: {}) ⇒ Zavudev::Models::Number10dlc::Campaigns::PhoneNumberListResponse

List phone numbers assigned to a 10DLC campaign.

Parameters:

Returns:

See Also:



19
20
21
22
23
24
25
26
 
# File 'lib/zavudev/resources/number_10dlc/campaigns/phone_numbers.rb', line 19

def list(campaign_id, params = {})
  @client.request(
    method: :get,
    path: ["v1/10dlc/campaigns/%1$s/phone-numbers", campaign_id],
    model: Zavudev::Models::Number10dlc::Campaigns::PhoneNumberListResponse,
    options: params[:request_options]
  )
end

#unassign(assignment_id, campaign_id:, request_options: {}) ⇒ nil

Remove a phone number assignment from a 10DLC campaign.

Parameters:

  • assignment_id (String) —

    Phone number assignment ID.

  • campaign_id (String) —

    10DLC campaign ID.

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

Returns:

  • (nil)

See Also:



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/zavudev/resources/number_10dlc/campaigns/phone_numbers.rb', line 66

def unassign(assignment_id, params)
  parsed, options = Zavudev::Number10dlc::Campaigns::PhoneNumberUnassignParams.dump_request(params)
  campaign_id =
    parsed.delete(:campaign_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["v1/10dlc/campaigns/%1$s/phone-numbers/%2$s", campaign_id, assignment_id],
    model: NilClass,
    options: options
  )
end