Class: CybridApiOrganization::SubscriptionDeliveriesOrganizationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubscriptionDeliveriesOrganizationApi

Returns a new instance of SubscriptionDeliveriesOrganizationApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_subscription_delivery(post_subscription_delivery_organization_model, opts = {}) ⇒ SubscriptionDeliveryOrganizationModel

Create SubscriptionDelivery Creates a SubscriptionDelivery. ## Subscription Delivery Create a SubscriptionDelivery to retry the delivery of a SubscriptionEvent to a Subscription. ## State | State | Description | |——-|————-| | storing | The Platform is storing the SubscriptionDelivery details in our private store | | completed | The Platform has successfully delivered the SubscriptionEvent to specified Subscription | | failing | The Platform is failing to deliver the SubscriptionDelivery, a new attempt will be made (see ‘next_attempt_at`) | | failed | The Platform has failed to deliver the SubscriptionDelivery, no more attempts will be made | Required scope: **subscription_events:execute

Parameters:

Returns:



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

def create_subscription_delivery(post_subscription_delivery_organization_model, opts = {})
  data, _status_code, _headers = create_subscription_delivery_with_http_info(post_subscription_delivery_organization_model, opts)
  data
end

#create_subscription_delivery_with_http_info(post_subscription_delivery_organization_model, opts = {}) ⇒ Array<(SubscriptionDeliveryOrganizationModel, Integer, Hash)>

Create SubscriptionDelivery Creates a SubscriptionDelivery. ## Subscription Delivery Create a SubscriptionDelivery to retry the delivery of a SubscriptionEvent to a Subscription. ## State | State | Description | |——-|————-| | storing | The Platform is storing the SubscriptionDelivery details in our private store | | completed | The Platform has successfully delivered the SubscriptionEvent to specified Subscription | | failing | The Platform is failing to deliver the SubscriptionDelivery, a new attempt will be made (see &#x60;next_attempt_at&#x60;) | | failed | The Platform has failed to deliver the SubscriptionDelivery, no more attempts will be made | Required scope: **subscription_events: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/subscription_deliveries_organization_api.rb', line 37

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

  # 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_delivery_organization_model)

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

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

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

#get_subscription_delivery(subscription_delivery_guid, opts = {}) ⇒ SubscriptionDeliveryOrganizationModel

Get Subscription Delivery Retrieves a subscription delivery. Required scope: subscription_events:read

Parameters:

  • subscription_delivery_guid (String) —

    Identifier for the subscription delivery.

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

    the optional parameters

Returns:



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

def get_subscription_delivery(subscription_delivery_guid, opts = {})
  data, _status_code, _headers = get_subscription_delivery_with_http_info(subscription_delivery_guid, opts)
  data
end

#get_subscription_delivery_with_http_info(subscription_delivery_guid, opts = {}) ⇒ Array<(SubscriptionDeliveryOrganizationModel, Integer, Hash)>

Get Subscription Delivery Retrieves a subscription delivery. Required scope: subscription_events:read

Parameters:

  • subscription_delivery_guid (String) —

    Identifier for the subscription delivery.

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

    the optional parameters

Returns:



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/subscription_deliveries_organization_api.rb', line 105

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

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

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

#list_subscription_deliveries(opts = {}) ⇒ SubscriptionDeliveryListOrganizationModel

Get subscription deliveries list Retrieves a listing of subscription deliveries 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_delivery_guids to list subscription deliveries for.

  • :subscription_event_guid (String) —

    Comma separated subscription_event_guids to list subscription deliveries for.

  • :subscription_guid (String) —

    Comma separated subscription_guids to list subscription deliveries for.

Returns:



162
163
164
165
 
# File 'lib/cybrid_api_organization_ruby/api/subscription_deliveries_organization_api.rb', line 162

def list_subscription_deliveries(opts = {})
  data, _status_code, _headers = list_subscription_deliveries_with_http_info(opts)
  data
end

#list_subscription_deliveries_with_http_info(opts = {}) ⇒ Array<(SubscriptionDeliveryListOrganizationModel, Integer, Hash)>

Get subscription deliveries list Retrieves a listing of subscription deliveries 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_delivery_guids to list subscription deliveries for.

  • :subscription_event_guid (String) —

    Comma separated subscription_event_guids to list subscription deliveries for.

  • :subscription_guid (String) —

    Comma separated subscription_guids to list subscription deliveries for.

Returns:



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/cybrid_api_organization_ruby/api/subscription_deliveries_organization_api.rb', line 176

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

  # resource path
  local_var_path = '/api/subscription_deliveries'

  # 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[:'subscription_event_guid'] = opts[:'subscription_event_guid'] if !opts[:'subscription_event_guid'].nil?
  query_params[:'subscription_guid'] = opts[:'subscription_guid'] if !opts[:'subscription_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] || 'SubscriptionDeliveryListOrganizationModel'

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

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