Class: MailchimpMarketing::ExternalAuthsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/MailchimpMarketing/api/external_auths_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ ExternalAuthsApi

Returns a new instance of ExternalAuthsApi.



19
20
21
 
# File 'lib/MailchimpMarketing/api/external_auths_api.rb', line 19

def initialize(api_client)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/MailchimpMarketing/api/external_auths_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(body = {}, opts = {}) ⇒ ExternalAuthenticationsExternalAuths

Create a new External Auth Create a new external auth if one does not exist.

Parameters:

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

    the optional parameters

Returns:

  • (ExternalAuthenticationsExternalAuths) 


131
132
133
134
 
# File 'lib/MailchimpMarketing/api/external_auths_api.rb', line 131

def create(body = {}, opts = {})
  data, _status_code, _headers = create_with_http_info(body, opts)
  data
end

#create_with_http_info(body, opts = {}) ⇒ Array<(ExternalAuthenticationsExternalAuths, Fixnum, Hash)>

Create a new External Auth Create a new external auth if one does not exist.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ExternalAuthenticationsExternalAuths, Fixnum, Hash)>) —

    ExternalAuthenticationsExternalAuths data, response status code and response headers



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
 
# File 'lib/MailchimpMarketing/api/external_auths_api.rb', line 141

def create_with_http_info(body, opts = {})
  # resource path
  local_var_path = '/external-auths'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExternalAuthenticationsExternalAuths')
  return data, status_code, headers
end

#get(system_id = {}, opts = {}) ⇒ ExternalAuthenticationsExternalAuths

Get an External Authentication Get information about a specific partners External Authentication for a user.

Parameters:

  • system_id (defaults to: {}) —

    The System name for external partner.

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

  • :exclude_fields (Array<String>) —

    A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Returns:

  • (ExternalAuthenticationsExternalAuths) 


29
30
31
32
 
# File 'lib/MailchimpMarketing/api/external_auths_api.rb', line 29

def get(system_id = {}, opts = {})
  data, _status_code, _headers = get_with_http_info(system_id, opts)
  data
end

#get_collection(opts = {}) ⇒ ExternalAuthentications

Get a collection of External Authentications Get a collection of External Authentications

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

  • :exclude_fields (Array<String>) —

    A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

  • :count (Integer) —

    The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 10. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 1000 (default to 10)

  • :offset (Integer) —

    The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 0. (default to 0)

Returns:

  • (ExternalAuthentications) 


80
81
82
83
 
# File 'lib/MailchimpMarketing/api/external_auths_api.rb', line 80

def get_collection(opts = {})
  data, _status_code, _headers = get_collection_with_http_info(opts)
  data
end

#get_collection_with_http_info(opts = {}) ⇒ Array<(ExternalAuthentications, Fixnum, Hash)>

Get a collection of External Authentications Get a collection of External Authentications

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

  • :exclude_fields (Array<String>) —

    A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

  • :count (Integer) —

    The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 10. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 1000

  • :offset (Integer) —

    The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 0.

Returns:

  • (Array<(ExternalAuthentications, Fixnum, Hash)>) —

    ExternalAuthentications data, response status code and response headers



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/MailchimpMarketing/api/external_auths_api.rb', line 93

def get_collection_with_http_info(opts = {})
  # resource path
  local_var_path = '/external-auths'

  # query parameters
  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExternalAuthentications')
  return data, status_code, headers
end

#get_with_http_info(system_id, opts = {}) ⇒ Array<(ExternalAuthenticationsExternalAuths, Fixnum, Hash)>

Get an External Authentication Get information about a specific partners External Authentication for a user.

Parameters:

  • system_id —

    The System name for external partner.

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

  • :exclude_fields (Array<String>) —

    A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Returns:

  • (Array<(ExternalAuthenticationsExternalAuths, Fixnum, Hash)>) —

    ExternalAuthenticationsExternalAuths data, response status code and response headers



41
42
43
44
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
 
# File 'lib/MailchimpMarketing/api/external_auths_api.rb', line 41

def get_with_http_info(system_id, opts = {})
  # resource path
  local_var_path = '/external-auths/{system_id}'.sub('{' + 'system_id' + '}', system_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExternalAuthenticationsExternalAuths')
  return data, status_code, headers
end