Class: CybridApiOrganization::SubscriptionEventsOrganizationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_organization_ruby/api/subscription_events_organization_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubscriptionEventsOrganizationApi

Returns a new instance of SubscriptionEventsOrganizationApi.



19
20
21
 
# File 'lib/cybrid_api_organization_ruby/api/subscription_events_organization_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cybrid_api_organization_ruby/api/subscription_events_organization_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_subscription_event(subscription_event_guid, opts = {}) ⇒ SubscriptionEventOrganizationModel

Get Subscription Event Retrieves a Subscription Event. Required scope: subscription_events:read

Parameters:

  • subscription_event_guid (String) —

    Identifier for the Subscription Event.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cybrid_api_organization_ruby/api/subscription_events_organization_api.rb', line 27

def get_subscription_event(subscription_event_guid, opts = {})
  data, _status_code, _headers = get_subscription_event_with_http_info(subscription_event_guid, opts)
  data
end

#get_subscription_event_with_http_info(subscription_event_guid, opts = {}) ⇒ Array<(SubscriptionEventOrganizationModel, Integer, Hash)>

Get Subscription Event Retrieves a Subscription Event. Required scope: subscription_events:read

Parameters:

  • subscription_event_guid (String) —

    Identifier for the Subscription Event.

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

    the optional parameters

Returns:



37
38
39
40
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
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/cybrid_api_organization_ruby/api/subscription_events_organization_api.rb', line 37

def get_subscription_event_with_http_info(subscription_event_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionEventsOrganizationApi.get_subscription_event ...'
  end
  # verify the required parameter 'subscription_event_guid' is set
  if @api_client.config.client_side_validation && subscription_event_guid.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_event_guid' when calling SubscriptionEventsOrganizationApi.get_subscription_event"
  end
  # resource path
  local_var_path = '/api/subscription_events/{subscription_event_guid}'.sub('{' + 'subscription_event_guid' + '}', CGI.escape(subscription_event_guid.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] || 'SubscriptionEventOrganizationModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"SubscriptionEventsOrganizationApi.get_subscription_event",
    :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: SubscriptionEventsOrganizationApi#get_subscription_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_subscription_events(opts = {}) ⇒ SubscriptionEventListOrganizationModel

Get subscription events list Retrieves a listing of subscription events s. Required scope: subscription_events:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

  • :guid (String) —

    Comma separated subscription_event_guids to list subscription events for.

Returns:



92
93
94
95
 
# File 'lib/cybrid_api_organization_ruby/api/subscription_events_organization_api.rb', line 92

def list_subscription_events(opts = {})
  data, _status_code, _headers = list_subscription_events_with_http_info(opts)
  data
end

#list_subscription_events_with_http_info(opts = {}) ⇒ Array<(SubscriptionEventListOrganizationModel, Integer, Hash)>

Get subscription events list Retrieves a listing of subscription events s. Required scope: subscription_events:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

  • :guid (String) —

    Comma separated subscription_event_guids to list subscription events for.

Returns:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
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
 
# File 'lib/cybrid_api_organization_ruby/api/subscription_events_organization_api.rb', line 104

def list_subscription_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionEventsOrganizationApi.list_subscription_events ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SubscriptionEventsOrganizationApi.list_subscription_events, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling SubscriptionEventsOrganizationApi.list_subscription_events, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling SubscriptionEventsOrganizationApi.list_subscription_events, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/subscription_events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?

  # 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] || 'SubscriptionEventListOrganizationModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"SubscriptionEventsOrganizationApi.list_subscription_events",
    :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: SubscriptionEventsOrganizationApi#list_subscription_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end