Class: CybridApiOrganization::SubscriptionsOrganizationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubscriptionsOrganizationApi

Returns a new instance of SubscriptionsOrganizationApi.



19
20
21
 
# File 'lib/cybrid_api_organization_ruby/api/subscriptions_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/subscriptions_organization_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_subscription(post_subscription_organization_model, opts = {}) ⇒ SubscriptionOrganizationModel

Create Subscription Creates a Subscription. ## Subscription creation Subscriptions can be created for webhook endpoints. ## State | State | Description | |——-|————-| | storing | The Platform is storing the subscription details in our private store | | completed | The Platform has created the subscription | | failed | The Platform was not able to successfully create the subscription | Required scope: **subscriptions:execute

Parameters:

Returns:



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

def create_subscription(post_subscription_organization_model, opts = {})
  data, _status_code, _headers = create_subscription_with_http_info(post_subscription_organization_model, opts)
  data
end

#create_subscription_with_http_info(post_subscription_organization_model, opts = {}) ⇒ Array<(SubscriptionOrganizationModel, Integer, Hash)>

Create Subscription Creates a Subscription. ## Subscription creation Subscriptions can be created for webhook endpoints. ## State | State | Description | |——-|————-| | storing | The Platform is storing the subscription details in our private store | | completed | The Platform has created the subscription | | failed | The Platform was not able to successfully create the subscription | Required scope: **subscriptions:execute

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
84
85
86
87
88
 
# File 'lib/cybrid_api_organization_ruby/api/subscriptions_organization_api.rb', line 37

def create_subscription_with_http_info(post_subscription_organization_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionsOrganizationApi.create_subscription ...'
  end
  # verify the required parameter 'post_subscription_organization_model' is set
  if @api_client.config.client_side_validation && post_subscription_organization_model.nil?
    fail ArgumentError, "Missing the required parameter 'post_subscription_organization_model' when calling SubscriptionsOrganizationApi.create_subscription"
  end
  # resource path
  local_var_path = '/api/subscriptions/'

  # 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/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_subscription_organization_model)

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

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

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

#delete_subscription(subscription_guid, opts = {}) ⇒ nil

Delete Subscription Deletes a subscription. Required scope: subscriptions:execute

Parameters:

  • subscription_guid (String) —

    Identifier for the subscription.

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

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/cybrid_api_organization_ruby/api/subscriptions_organization_api.rb', line 95

def delete_subscription(subscription_guid, opts = {})
  delete_subscription_with_http_info(subscription_guid, opts)
  nil
end

#delete_subscription_with_http_info(subscription_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Subscription Deletes a subscription. Required scope: subscriptions:execute

Parameters:

  • subscription_guid (String) —

    Identifier for the subscription.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/cybrid_api_organization_ruby/api/subscriptions_organization_api.rb', line 105

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

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

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

#get_subscription(subscription_guid, opts = {}) ⇒ SubscriptionOrganizationModel

Get Subscription Retrieves a subscription. Required scope: subscriptions:read

Parameters:

  • subscription_guid (String) —

    Identifier for the subscription.

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/cybrid_api_organization_ruby/api/subscriptions_organization_api.rb', line 158

def get_subscription(subscription_guid, opts = {})
  data, _status_code, _headers = get_subscription_with_http_info(subscription_guid, opts)
  data
end

#get_subscription_with_http_info(subscription_guid, opts = {}) ⇒ Array<(SubscriptionOrganizationModel, Integer, Hash)>

Get Subscription Retrieves a subscription. Required scope: subscriptions:read

Parameters:

  • subscription_guid (String) —

    Identifier for the subscription.

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

    the optional parameters

Returns:



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/cybrid_api_organization_ruby/api/subscriptions_organization_api.rb', line 168

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

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

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

#list_subscriptions(opts = {}) ⇒ SubscriptionListOrganizationModel

Get subscriptions list Retrieves a listing of subscriptions. Required scope: subscriptions: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_guids to list subscriptions for.

  • :environment (String) —

    Environment to list subscriptions for.

  • :state (String) —

    State to list subscriptions for.

Returns:



225
226
227
228
 
# File 'lib/cybrid_api_organization_ruby/api/subscriptions_organization_api.rb', line 225

def list_subscriptions(opts = {})
  data, _status_code, _headers = list_subscriptions_with_http_info(opts)
  data
end

#list_subscriptions_with_http_info(opts = {}) ⇒ Array<(SubscriptionListOrganizationModel, Integer, Hash)>

Get subscriptions list Retrieves a listing of subscriptions. Required scope: subscriptions: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_guids to list subscriptions for.

  • :environment (String) —

    Environment to list subscriptions for.

  • :state (String) —

    State to list subscriptions for.

Returns:



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/cybrid_api_organization_ruby/api/subscriptions_organization_api.rb', line 239

def list_subscriptions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionsOrganizationApi.list_subscriptions ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SubscriptionsOrganizationApi.list_subscriptions, 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 SubscriptionsOrganizationApi.list_subscriptions, 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 SubscriptionsOrganizationApi.list_subscriptions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/subscriptions'

  # 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?
  query_params[:'environment'] = opts[:'environment'] if !opts[:'environment'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].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] || 'SubscriptionListOrganizationModel'

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

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