Class: MailchimpMarketing::PostcardsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ PostcardsApi

Returns a new instance of PostcardsApi.



19
20
21
 
# File 'lib/MailchimpMarketing/api/postcards_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/postcards_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_all(opts = {}) ⇒ InlineResponse2007

__summary__ Get all of a user’s postcards.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort_dir (String) —

    Determines the order direction for sorted results.

  • :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)

Returns:

  • (InlineResponse2007) 


30
31
32
33
 
# File 'lib/MailchimpMarketing/api/postcards_api.rb', line 30

def get_all(opts = {})
  data, _status_code, _headers = get_all_with_http_info(opts)
  data
end

#get_all_with_http_info(opts = {}) ⇒ Array<(InlineResponse2007, Fixnum, Hash)>

__summary__ Get all of a user&#39;s postcards.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort_dir (String) —

    Determines the order direction for sorted results.

  • :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

Returns:

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

    InlineResponse2007 data, response status code and response headers



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
72
73
74
75
 
# File 'lib/MailchimpMarketing/api/postcards_api.rb', line 43

def get_all_with_http_info(opts = {})
  # resource path
  local_var_path = '/postcards'

  # query parameters
  query_params = {}
  query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
  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?

  # 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 => 'InlineResponse2007')
  return data, status_code, headers
end