Class: Fastly::ContactApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/contact_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContactApi

Returns a new instance of ContactApi.



17
18
19
 
# File 'lib/fastly/api/contact_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/contact_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_contacts(opts = {}) ⇒ ContactResponse

Add a new customer contact Create a contact.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

  • :user_id (String) —

    The alphanumeric string representing the user for this customer contact.

  • :contact_type (String) —

    The type of contact.

  • :name (String) —

    The name of this contact, when user_id is not provided.

  • :email (String) —

    The email of this contact, when a user_id is not provided.

  • :phone (String) —

    The phone number for this contact. Required for primary, technical, and security contact types.

  • :customer_id (String) —

    The alphanumeric string representing the customer for this customer contact.

Returns:



30
31
32
33
 
# File 'lib/fastly/api/contact_api.rb', line 30

def create_contacts(opts = {})
  data, _status_code, _headers = create_contacts_with_http_info(opts)
  data
end

#create_contacts_with_http_info(opts = {}) ⇒ Array<(ContactResponse, Integer, Hash)>

Add a new customer contact Create a contact.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

  • :user_id (String) —

    The alphanumeric string representing the user for this customer contact.

  • :contact_type (String) —

    The type of contact.

  • :name (String) —

    The name of this contact, when user_id is not provided.

  • :email (String) —

    The email of this contact, when a user_id is not provided.

  • :phone (String) —

    The phone number for this contact. Required for primary, technical, and security contact types.

  • :customer_id (String) —

    The alphanumeric string representing the customer for this customer contact.

Returns:

  • (Array<(ContactResponse, Integer, Hash)>) —

    ContactResponse data, response status code and response headers



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/fastly/api/contact_api.rb', line 45

def create_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.create_contacts ...'
  end
  # unbox the parameters from the hash
  customer_id = opts[:'customer_id']
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling ContactApi.create_contacts"
  end
  allowable_values = ["primary", "billing", "technical", "security", "emergency", "general compliance"]
  if @api_client.config.client_side_validation && opts[:'contact_type'] && !allowable_values.include?(opts[:'contact_type'])
    fail ArgumentError, "invalid value for \"contact_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/customer/{customer_id}/contacts'.sub('{' + 'customer_id' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  form_params['contact_type'] = opts[:'contact_type'] if !opts[:'contact_type'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['email'] = opts[:'email'] if !opts[:'email'].nil?
  form_params['phone'] = opts[:'phone'] if !opts[:'phone'].nil?
  form_params['customer_id'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContactResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"ContactApi.create_contacts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#create_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_contact(opts = {}) ⇒ InlineResponse200

Delete a contact Delete a contact.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

  • :contact_id (String) —

    An alphanumeric string identifying the customer contact. (required)

Returns:



115
116
117
118
 
# File 'lib/fastly/api/contact_api.rb', line 115

def delete_contact(opts = {})
  data, _status_code, _headers = delete_contact_with_http_info(opts)
  data
end

#delete_contact_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete a contact Delete a contact.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

  • :contact_id (String) —

    An alphanumeric string identifying the customer contact. (required)

Returns:

  • (Array<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/fastly/api/contact_api.rb', line 125

def delete_contact_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.delete_contact ...'
  end
  # unbox the parameters from the hash
  customer_id = opts[:'customer_id']
  contact_id = opts[:'contact_id']
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling ContactApi.delete_contact"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactApi.delete_contact"
  end
  # resource path
  local_var_path = '/customer/{customer_id}/contacts/{contact_id}'.sub('{' + 'customer_id' + '}', CGI.escape(customer_id.to_s)).sub('{' + 'contact_id' + '}', CGI.escape(contact_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"ContactApi.delete_contact",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#delete_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_contacts(opts = {}) ⇒ Array<SchemasContactResponse>

List contacts List all contacts from a specified customer ID.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

Returns:



184
185
186
187
 
# File 'lib/fastly/api/contact_api.rb', line 184

def list_contacts(opts = {})
  data, _status_code, _headers = list_contacts_with_http_info(opts)
  data
end

#list_contacts_with_http_info(opts = {}) ⇒ Array<(Array<SchemasContactResponse>, Integer, Hash)>

List contacts List all contacts from a specified customer ID.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

Returns:

  • (Array<(Array<SchemasContactResponse>, Integer, Hash)>) —

    Array<SchemasContactResponse> data, response status code and response headers



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/fastly/api/contact_api.rb', line 193

def list_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.list_contacts ...'
  end
  # unbox the parameters from the hash
  customer_id = opts[:'customer_id']
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling ContactApi.list_contacts"
  end
  # resource path
  local_var_path = '/customer/{customer_id}/contacts'.sub('{' + 'customer_id' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<SchemasContactResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"ContactApi.list_contacts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#list_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end