Class: SubskribeSandboxClient::CustomizationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/api/customization_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomizationApi

Returns a new instance of CustomizationApi.



19
20
21
 
# File 'lib/subskribe_sandbox/api/customization_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/subskribe_sandbox/api/customization_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#compile_order_creation_customization_zeppa_script(order_id, body, opts = {}) ⇒ nil

Compile and Verify a order creation customization for correctness if this endpoint returns OK it means the plan order customization zeppa script has successfully compiled

Parameters:

  • order_id —

    order id against which the compilation should happen

  • body —

    the zeppa script that needs to be compiled

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    order id against which the compilation should happen

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/subskribe_sandbox/api/customization_api.rb', line 29

def compile_order_creation_customization_zeppa_script(order_id, body, opts = {})
  compile_order_creation_customization_zeppa_script_with_http_info(order_id, body, opts)
  nil
end

#compile_order_creation_customization_zeppa_script_with_http_info(order_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Compile and Verify a order creation customization for correctness if this endpoint returns OK it means the plan order customization zeppa script has successfully compiled

Parameters:

  • order_id —

    order id against which the compilation should happen

  • body —

    the zeppa script that needs to be compiled

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    order id against which the compilation should happen

Returns:

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

    nil, 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
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/subskribe_sandbox/api/customization_api.rb', line 41

def compile_order_creation_customization_zeppa_script_with_http_info(order_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomizationApi.compile_order_creation_customization_zeppa_script ...'
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling CustomizationApi.compile_order_creation_customization_zeppa_script"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CustomizationApi.compile_order_creation_customization_zeppa_script"
  end
  # resource path
  local_var_path = '/beta/customization/orderCreationCustomization/compile'

  # query parameters
  query_params = {}
  query_params[:'orderId'] = order_id
  query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomizationApi#compile_order_creation_customization_zeppa_script\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#compile_plan_selection_customization_zeppa_script(account_id, body, opts = {}) ⇒ nil

Compile and Verify a plan selection customization for correctness if this endpoint returns OK it means the plan selection customization zeppa script has successfully compiled

Parameters:

  • account_id —

    account id against which the compilation should happen

  • body —

    the zeppa script that needs to be compiled

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

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/subskribe_sandbox/api/customization_api.rb', line 91

def compile_plan_selection_customization_zeppa_script(, body, opts = {})
  compile_plan_selection_customization_zeppa_script_with_http_info(, body, opts)
  nil
end

#compile_plan_selection_customization_zeppa_script_with_http_info(account_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Compile and Verify a plan selection customization for correctness if this endpoint returns OK it means the plan selection customization zeppa script has successfully compiled

Parameters:

  • account_id —

    account id against which the compilation should happen

  • body —

    the zeppa script that needs to be compiled

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



102
103
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
 
# File 'lib/subskribe_sandbox/api/customization_api.rb', line 102

def compile_plan_selection_customization_zeppa_script_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomizationApi.compile_plan_selection_customization_zeppa_script ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomizationApi.compile_plan_selection_customization_zeppa_script"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CustomizationApi.compile_plan_selection_customization_zeppa_script"
  end
  # resource path
  local_var_path = '/beta/customization/planSelectionCustomization/compile'

  # query parameters
  query_params = {}
  query_params[:'accountId'] = 

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomizationApi#compile_plan_selection_customization_zeppa_script\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_order_creation_customization_zeppa_script(order_id, body, opts = {}) ⇒ nil

Test a order creation customization zeppa script runs the provided zeppa script and returns a list of Rule actions that were applicable after zeppa script ran

Parameters:

  • order_id —

    order id against which the test needs to happen

  • body —

    the zeppa script that needs to be tested

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    the user id against which this test needs to happen, the user should be part of the tenancy

Returns:

  • (nil) 


152
153
154
155
 
# File 'lib/subskribe_sandbox/api/customization_api.rb', line 152

def test_order_creation_customization_zeppa_script(order_id, body, opts = {})
  test_order_creation_customization_zeppa_script_with_http_info(order_id, body, opts)
  nil
end

#test_order_creation_customization_zeppa_script_with_http_info(order_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Test a order creation customization zeppa script runs the provided zeppa script and returns a list of Rule actions that were applicable after zeppa script ran

Parameters:

  • order_id —

    order id against which the test needs to happen

  • body —

    the zeppa script that needs to be tested

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    the user id against which this test needs to happen, the user should be part of the tenancy

Returns:

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

    nil, response status code and response headers



164
165
166
167
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
 
# File 'lib/subskribe_sandbox/api/customization_api.rb', line 164

def test_order_creation_customization_zeppa_script_with_http_info(order_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomizationApi.test_order_creation_customization_zeppa_script ...'
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling CustomizationApi.test_order_creation_customization_zeppa_script"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CustomizationApi.test_order_creation_customization_zeppa_script"
  end
  # resource path
  local_var_path = '/beta/customization/orderCreationCustomization/test'

  # query parameters
  query_params = {}
  query_params[:'orderId'] = order_id
  query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomizationApi#test_order_creation_customization_zeppa_script\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_plan_selection_customization_zeppa_script(account_id, body, opts = {}) ⇒ nil

Test a plan selection customization zeppa script runs the provided zeppa script and returns a list of Rule actions that were applicable after zeppa script ran

Parameters:

  • account_id —

    account id against which the test needs to happen

  • body —

    the zeppa script that needs to be tested

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

    the optional parameters

Returns:

  • (nil) 


214
215
216
217
 
# File 'lib/subskribe_sandbox/api/customization_api.rb', line 214

def test_plan_selection_customization_zeppa_script(, body, opts = {})
  test_plan_selection_customization_zeppa_script_with_http_info(, body, opts)
  nil
end

#test_plan_selection_customization_zeppa_script_with_http_info(account_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Test a plan selection customization zeppa script runs the provided zeppa script and returns a list of Rule actions that were applicable after zeppa script ran

Parameters:

  • account_id —

    account id against which the test needs to happen

  • body —

    the zeppa script that needs to be tested

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



225
226
227
228
229
230
231
232
233
234
235
236
237
238
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
 
# File 'lib/subskribe_sandbox/api/customization_api.rb', line 225

def test_plan_selection_customization_zeppa_script_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomizationApi.test_plan_selection_customization_zeppa_script ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomizationApi.test_plan_selection_customization_zeppa_script"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CustomizationApi.test_plan_selection_customization_zeppa_script"
  end
  # resource path
  local_var_path = '/beta/customization/planSelectionCustomization/test'

  # query parameters
  query_params = {}
  query_params[:'accountId'] = 

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomizationApi#test_plan_selection_customization_zeppa_script\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end