Class: Stripe::Privacy::RedactionJobService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/privacy/redaction_job_service.rb

Defined Under Namespace

Classes: CancelParams, CreateParams, ListParams, RetrieveParams, RunParams, UpdateParams, ValidateParams

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from StripeService

#request, #request_stream

Constructor Details

#initialize(requestor) ⇒ RedactionJobService

Returns a new instance of RedactionJobService.



9
10
11
12
 
# File 'lib/stripe/services/privacy/redaction_job_service.rb', line 9

def initialize(requestor)
  super
  @validation_errors = Stripe::Privacy::RedactionJobValidationErrorService.new(@requestor)
end

Instance Attribute Details

#validation_errors ⇒ Object (readonly)

Returns the value of attribute validation_errors.



7
8
9
 
# File 'lib/stripe/services/privacy/redaction_job_service.rb', line 7

def validation_errors
  @validation_errors
end

Instance Method Details

#cancel(job, params = {}, opts = {}) ⇒ Object

Cancel redaction job method



154
155
156
157
158
159
160
161
162
 
# File 'lib/stripe/services/privacy/redaction_job_service.rb', line 154

def cancel(job, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/privacy/redaction_jobs/%<job>s/cancel", { job: CGI.escape(job) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#create(params = {}, opts = {}) ⇒ Object

Create redaction job method



165
166
167
168
169
170
171
172
173
 
# File 'lib/stripe/services/privacy/redaction_job_service.rb', line 165

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/privacy/redaction_jobs",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(params = {}, opts = {}) ⇒ Object

List redaction jobs method…



176
177
178
179
180
181
182
183
184
 
# File 'lib/stripe/services/privacy/redaction_job_service.rb', line 176

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/privacy/redaction_jobs",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(job, params = {}, opts = {}) ⇒ Object

Retrieve redaction job method



187
188
189
190
191
192
193
194
195
 
# File 'lib/stripe/services/privacy/redaction_job_service.rb', line 187

def retrieve(job, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/privacy/redaction_jobs/%<job>s", { job: CGI.escape(job) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#run(job, params = {}, opts = {}) ⇒ Object

Run redaction job method



198
199
200
201
202
203
204
205
206
 
# File 'lib/stripe/services/privacy/redaction_job_service.rb', line 198

def run(job, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/privacy/redaction_jobs/%<job>s/run", { job: CGI.escape(job) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(job, params = {}, opts = {}) ⇒ Object

Update redaction job method



209
210
211
212
213
214
215
216
217
 
# File 'lib/stripe/services/privacy/redaction_job_service.rb', line 209

def update(job, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/privacy/redaction_jobs/%<job>s", { job: CGI.escape(job) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#validate(job, params = {}, opts = {}) ⇒ Object

Validate redaction job method



220
221
222
223
224
225
226
227
228
 
# File 'lib/stripe/services/privacy/redaction_job_service.rb', line 220

def validate(job, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/privacy/redaction_jobs/%<job>s/validate", { job: CGI.escape(job) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end