xero-ruby 4.3.0 → 5.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -20,6 +20,7 @@ module XeroRuby
20
20
  # @param xero_tenant_id [String] Xero identifier for Tenant
21
21
  # @param timesheet_id [String] Identifier for the timesheet
22
22
  # @param [Hash] opts the optional parameters
23
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
23
24
  # @return [TimesheetObject]
24
25
  def approve_timesheet(xero_tenant_id, timesheet_id, opts = {})
25
26
  data, _status_code, _headers = approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts)
@@ -30,6 +31,7 @@ module XeroRuby
30
31
  # @param xero_tenant_id [String] Xero identifier for Tenant
31
32
  # @param timesheet_id [String] Identifier for the timesheet
32
33
  # @param [Hash] opts the optional parameters
34
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
33
35
  # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers
34
36
  def approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
35
37
  opts = options.dup
@@ -62,6 +64,7 @@ module XeroRuby
62
64
  # HTTP header 'Accept' (if needed)
63
65
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
64
66
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
67
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
65
68
 
66
69
  # form parameters
67
70
  form_params = opts[:form_params] || {}
@@ -95,6 +98,7 @@ module XeroRuby
95
98
  # @param xero_tenant_id [String] Xero identifier for Tenant
96
99
  # @param benefit [Benefit]
97
100
  # @param [Hash] opts the optional parameters
101
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
98
102
  # @return [BenefitObject]
99
103
  def create_benefit(xero_tenant_id, benefit, opts = {})
100
104
  data, _status_code, _headers = create_benefit_with_http_info(xero_tenant_id, benefit, opts)
@@ -105,6 +109,7 @@ module XeroRuby
105
109
  # @param xero_tenant_id [String] Xero identifier for Tenant
106
110
  # @param benefit [Benefit]
107
111
  # @param [Hash] opts the optional parameters
112
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
108
113
  # @return [Array<(BenefitObject, Integer, Hash)>] BenefitObject data, response status code and response headers
109
114
  def create_benefit_with_http_info(xero_tenant_id, benefit, options = {})
110
115
  opts = options.dup
@@ -139,6 +144,7 @@ module XeroRuby
139
144
  # HTTP header 'Content-Type'
140
145
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
141
146
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
147
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
142
148
 
143
149
  # form parameters
144
150
  form_params = opts[:form_params] || {}
@@ -172,6 +178,7 @@ module XeroRuby
172
178
  # @param xero_tenant_id [String] Xero identifier for Tenant
173
179
  # @param deduction [Deduction]
174
180
  # @param [Hash] opts the optional parameters
181
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
175
182
  # @return [DeductionObject]
176
183
  def create_deduction(xero_tenant_id, deduction, opts = {})
177
184
  data, _status_code, _headers = create_deduction_with_http_info(xero_tenant_id, deduction, opts)
@@ -182,6 +189,7 @@ module XeroRuby
182
189
  # @param xero_tenant_id [String] Xero identifier for Tenant
183
190
  # @param deduction [Deduction]
184
191
  # @param [Hash] opts the optional parameters
192
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
185
193
  # @return [Array<(DeductionObject, Integer, Hash)>] DeductionObject data, response status code and response headers
186
194
  def create_deduction_with_http_info(xero_tenant_id, deduction, options = {})
187
195
  opts = options.dup
@@ -216,6 +224,7 @@ module XeroRuby
216
224
  # HTTP header 'Content-Type'
217
225
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
218
226
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
227
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
219
228
 
220
229
  # form parameters
221
230
  form_params = opts[:form_params] || {}
@@ -249,6 +258,7 @@ module XeroRuby
249
258
  # @param xero_tenant_id [String] Xero identifier for Tenant
250
259
  # @param earnings_rate [EarningsRate]
251
260
  # @param [Hash] opts the optional parameters
261
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
252
262
  # @return [EarningsRateObject]
253
263
  def create_earnings_rate(xero_tenant_id, earnings_rate, opts = {})
254
264
  data, _status_code, _headers = create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, opts)
@@ -259,6 +269,7 @@ module XeroRuby
259
269
  # @param xero_tenant_id [String] Xero identifier for Tenant
260
270
  # @param earnings_rate [EarningsRate]
261
271
  # @param [Hash] opts the optional parameters
272
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
262
273
  # @return [Array<(EarningsRateObject, Integer, Hash)>] EarningsRateObject data, response status code and response headers
263
274
  def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = {})
264
275
  opts = options.dup
@@ -293,6 +304,7 @@ module XeroRuby
293
304
  # HTTP header 'Content-Type'
294
305
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
295
306
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
307
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
296
308
 
297
309
  # form parameters
298
310
  form_params = opts[:form_params] || {}
@@ -326,6 +338,7 @@ module XeroRuby
326
338
  # @param xero_tenant_id [String] Xero identifier for Tenant
327
339
  # @param employee [Employee]
328
340
  # @param [Hash] opts the optional parameters
341
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
329
342
  # @return [EmployeeObject]
330
343
  def create_employee(xero_tenant_id, employee, opts = {})
331
344
  data, _status_code, _headers = create_employee_with_http_info(xero_tenant_id, employee, opts)
@@ -336,6 +349,7 @@ module XeroRuby
336
349
  # @param xero_tenant_id [String] Xero identifier for Tenant
337
350
  # @param employee [Employee]
338
351
  # @param [Hash] opts the optional parameters
352
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
339
353
  # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers
340
354
  def create_employee_with_http_info(xero_tenant_id, employee, options = {})
341
355
  opts = options.dup
@@ -370,6 +384,7 @@ module XeroRuby
370
384
  # HTTP header 'Content-Type'
371
385
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
372
386
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
387
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
373
388
 
374
389
  # form parameters
375
390
  form_params = opts[:form_params] || {}
@@ -404,6 +419,7 @@ module XeroRuby
404
419
  # @param employee_id [String] Employee id for single object
405
420
  # @param earnings_template [EarningsTemplate]
406
421
  # @param [Hash] opts the optional parameters
422
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
407
423
  # @return [EarningsTemplateObject]
408
424
  def create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts = {})
409
425
  data, _status_code, _headers = create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts)
@@ -415,6 +431,7 @@ module XeroRuby
415
431
  # @param employee_id [String] Employee id for single object
416
432
  # @param earnings_template [EarningsTemplate]
417
433
  # @param [Hash] opts the optional parameters
434
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
418
435
  # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers
419
436
  def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {})
420
437
  opts = options.dup
@@ -453,6 +470,7 @@ module XeroRuby
453
470
  # HTTP header 'Content-Type'
454
471
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
455
472
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
473
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
456
474
 
457
475
  # form parameters
458
476
  form_params = opts[:form_params] || {}
@@ -487,6 +505,7 @@ module XeroRuby
487
505
  # @param employee_id [String] Employee id for single object
488
506
  # @param employee_leave [EmployeeLeave]
489
507
  # @param [Hash] opts the optional parameters
508
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
490
509
  # @return [EmployeeLeaveObject]
491
510
  def create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts = {})
492
511
  data, _status_code, _headers = create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, opts)
@@ -498,6 +517,7 @@ module XeroRuby
498
517
  # @param employee_id [String] Employee id for single object
499
518
  # @param employee_leave [EmployeeLeave]
500
519
  # @param [Hash] opts the optional parameters
520
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
501
521
  # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers
502
522
  def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, options = {})
503
523
  opts = options.dup
@@ -536,6 +556,7 @@ module XeroRuby
536
556
  # HTTP header 'Content-Type'
537
557
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
538
558
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
559
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
539
560
 
540
561
  # form parameters
541
562
  form_params = opts[:form_params] || {}
@@ -570,6 +591,7 @@ module XeroRuby
570
591
  # @param employee_id [String] Employee id for single object
571
592
  # @param employee_leave_type [EmployeeLeaveType]
572
593
  # @param [Hash] opts the optional parameters
594
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
573
595
  # @return [EmployeeLeaveTypeObject]
574
596
  def create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, opts = {})
575
597
  data, _status_code, _headers = create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, opts)
@@ -581,6 +603,7 @@ module XeroRuby
581
603
  # @param employee_id [String] Employee id for single object
582
604
  # @param employee_leave_type [EmployeeLeaveType]
583
605
  # @param [Hash] opts the optional parameters
606
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
584
607
  # @return [Array<(EmployeeLeaveTypeObject, Integer, Hash)>] EmployeeLeaveTypeObject data, response status code and response headers
585
608
  def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, options = {})
586
609
  opts = options.dup
@@ -619,6 +642,7 @@ module XeroRuby
619
642
  # HTTP header 'Content-Type'
620
643
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
621
644
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
645
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
622
646
 
623
647
  # form parameters
624
648
  form_params = opts[:form_params] || {}
@@ -653,6 +677,7 @@ module XeroRuby
653
677
  # @param employee_id [String] Employee id for single object
654
678
  # @param employee_opening_balances [EmployeeOpeningBalances]
655
679
  # @param [Hash] opts the optional parameters
680
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
656
681
  # @return [EmployeeOpeningBalancesObject]
657
682
  def create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts = {})
658
683
  data, _status_code, _headers = create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, opts)
@@ -664,6 +689,7 @@ module XeroRuby
664
689
  # @param employee_id [String] Employee id for single object
665
690
  # @param employee_opening_balances [EmployeeOpeningBalances]
666
691
  # @param [Hash] opts the optional parameters
692
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
667
693
  # @return [Array<(EmployeeOpeningBalancesObject, Integer, Hash)>] EmployeeOpeningBalancesObject data, response status code and response headers
668
694
  def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, options = {})
669
695
  opts = options.dup
@@ -702,6 +728,7 @@ module XeroRuby
702
728
  # HTTP header 'Content-Type'
703
729
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
704
730
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
731
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
705
732
 
706
733
  # form parameters
707
734
  form_params = opts[:form_params] || {}
@@ -736,6 +763,7 @@ module XeroRuby
736
763
  # @param employee_id [String] Employee id for single object
737
764
  # @param payment_method [PaymentMethod]
738
765
  # @param [Hash] opts the optional parameters
766
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
739
767
  # @return [PaymentMethodObject]
740
768
  def create_employee_payment_method(xero_tenant_id, employee_id, payment_method, opts = {})
741
769
  data, _status_code, _headers = create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, opts)
@@ -747,6 +775,7 @@ module XeroRuby
747
775
  # @param employee_id [String] Employee id for single object
748
776
  # @param payment_method [PaymentMethod]
749
777
  # @param [Hash] opts the optional parameters
778
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
750
779
  # @return [Array<(PaymentMethodObject, Integer, Hash)>] PaymentMethodObject data, response status code and response headers
751
780
  def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, options = {})
752
781
  opts = options.dup
@@ -785,6 +814,7 @@ module XeroRuby
785
814
  # HTTP header 'Content-Type'
786
815
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
787
816
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
817
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
788
818
 
789
819
  # form parameters
790
820
  form_params = opts[:form_params] || {}
@@ -819,6 +849,7 @@ module XeroRuby
819
849
  # @param employee_id [String] Employee id for single object
820
850
  # @param salary_and_wage [SalaryAndWage]
821
851
  # @param [Hash] opts the optional parameters
852
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
822
853
  # @return [SalaryAndWageObject]
823
854
  def create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, opts = {})
824
855
  data, _status_code, _headers = create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, opts)
@@ -830,6 +861,7 @@ module XeroRuby
830
861
  # @param employee_id [String] Employee id for single object
831
862
  # @param salary_and_wage [SalaryAndWage]
832
863
  # @param [Hash] opts the optional parameters
864
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
833
865
  # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers
834
866
  def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, options = {})
835
867
  opts = options.dup
@@ -868,6 +900,7 @@ module XeroRuby
868
900
  # HTTP header 'Content-Type'
869
901
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
870
902
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
903
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
871
904
 
872
905
  # form parameters
873
906
  form_params = opts[:form_params] || {}
@@ -901,6 +934,7 @@ module XeroRuby
901
934
  # @param xero_tenant_id [String] Xero identifier for Tenant
902
935
  # @param employee_statutory_sick_leave [EmployeeStatutorySickLeave]
903
936
  # @param [Hash] opts the optional parameters
937
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
904
938
  # @return [EmployeeStatutorySickLeaveObject]
905
939
  def create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave, opts = {})
906
940
  data, _status_code, _headers = create_employee_statutory_sick_leave_with_http_info(xero_tenant_id, employee_statutory_sick_leave, opts)
@@ -911,6 +945,7 @@ module XeroRuby
911
945
  # @param xero_tenant_id [String] Xero identifier for Tenant
912
946
  # @param employee_statutory_sick_leave [EmployeeStatutorySickLeave]
913
947
  # @param [Hash] opts the optional parameters
948
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
914
949
  # @return [Array<(EmployeeStatutorySickLeaveObject, Integer, Hash)>] EmployeeStatutorySickLeaveObject data, response status code and response headers
915
950
  def create_employee_statutory_sick_leave_with_http_info(xero_tenant_id, employee_statutory_sick_leave, options = {})
916
951
  opts = options.dup
@@ -945,6 +980,7 @@ module XeroRuby
945
980
  # HTTP header 'Content-Type'
946
981
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
947
982
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
983
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
948
984
 
949
985
  # form parameters
950
986
  form_params = opts[:form_params] || {}
@@ -979,6 +1015,7 @@ module XeroRuby
979
1015
  # @param employee_id [String] Employee id for single object
980
1016
  # @param employment [Employment]
981
1017
  # @param [Hash] opts the optional parameters
1018
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
982
1019
  # @return [EmploymentObject]
983
1020
  def create_employment(xero_tenant_id, employee_id, employment, opts = {})
984
1021
  data, _status_code, _headers = create_employment_with_http_info(xero_tenant_id, employee_id, employment, opts)
@@ -990,6 +1027,7 @@ module XeroRuby
990
1027
  # @param employee_id [String] Employee id for single object
991
1028
  # @param employment [Employment]
992
1029
  # @param [Hash] opts the optional parameters
1030
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
993
1031
  # @return [Array<(EmploymentObject, Integer, Hash)>] EmploymentObject data, response status code and response headers
994
1032
  def create_employment_with_http_info(xero_tenant_id, employee_id, employment, options = {})
995
1033
  opts = options.dup
@@ -1028,6 +1066,7 @@ module XeroRuby
1028
1066
  # HTTP header 'Content-Type'
1029
1067
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1030
1068
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
1069
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
1031
1070
 
1032
1071
  # form parameters
1033
1072
  form_params = opts[:form_params] || {}
@@ -1061,6 +1100,7 @@ module XeroRuby
1061
1100
  # @param xero_tenant_id [String] Xero identifier for Tenant
1062
1101
  # @param leave_type [LeaveType]
1063
1102
  # @param [Hash] opts the optional parameters
1103
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1064
1104
  # @return [LeaveTypeObject]
1065
1105
  def create_leave_type(xero_tenant_id, leave_type, opts = {})
1066
1106
  data, _status_code, _headers = create_leave_type_with_http_info(xero_tenant_id, leave_type, opts)
@@ -1071,6 +1111,7 @@ module XeroRuby
1071
1111
  # @param xero_tenant_id [String] Xero identifier for Tenant
1072
1112
  # @param leave_type [LeaveType]
1073
1113
  # @param [Hash] opts the optional parameters
1114
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1074
1115
  # @return [Array<(LeaveTypeObject, Integer, Hash)>] LeaveTypeObject data, response status code and response headers
1075
1116
  def create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {})
1076
1117
  opts = options.dup
@@ -1105,6 +1146,7 @@ module XeroRuby
1105
1146
  # HTTP header 'Content-Type'
1106
1147
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1107
1148
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
1149
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
1108
1150
 
1109
1151
  # form parameters
1110
1152
  form_params = opts[:form_params] || {}
@@ -1139,6 +1181,7 @@ module XeroRuby
1139
1181
  # @param employee_id [String] Employee id for single object
1140
1182
  # @param earnings_template [Array<EarningsTemplate>]
1141
1183
  # @param [Hash] opts the optional parameters
1184
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1142
1185
  # @return [EmployeePayTemplates]
1143
1186
  def create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts = {})
1144
1187
  data, _status_code, _headers = create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts)
@@ -1150,6 +1193,7 @@ module XeroRuby
1150
1193
  # @param employee_id [String] Employee id for single object
1151
1194
  # @param earnings_template [Array<EarningsTemplate>]
1152
1195
  # @param [Hash] opts the optional parameters
1196
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1153
1197
  # @return [Array<(EmployeePayTemplates, Integer, Hash)>] EmployeePayTemplates data, response status code and response headers
1154
1198
  def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {})
1155
1199
  opts = options.dup
@@ -1188,6 +1232,7 @@ module XeroRuby
1188
1232
  # HTTP header 'Content-Type'
1189
1233
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1190
1234
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
1235
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
1191
1236
 
1192
1237
  # form parameters
1193
1238
  form_params = opts[:form_params] || {}
@@ -1221,6 +1266,7 @@ module XeroRuby
1221
1266
  # @param xero_tenant_id [String] Xero identifier for Tenant
1222
1267
  # @param pay_run_calendar [PayRunCalendar]
1223
1268
  # @param [Hash] opts the optional parameters
1269
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1224
1270
  # @return [PayRunCalendarObject]
1225
1271
  def create_pay_run_calendar(xero_tenant_id, pay_run_calendar, opts = {})
1226
1272
  data, _status_code, _headers = create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, opts)
@@ -1231,6 +1277,7 @@ module XeroRuby
1231
1277
  # @param xero_tenant_id [String] Xero identifier for Tenant
1232
1278
  # @param pay_run_calendar [PayRunCalendar]
1233
1279
  # @param [Hash] opts the optional parameters
1280
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1234
1281
  # @return [Array<(PayRunCalendarObject, Integer, Hash)>] PayRunCalendarObject data, response status code and response headers
1235
1282
  def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, options = {})
1236
1283
  opts = options.dup
@@ -1265,6 +1312,7 @@ module XeroRuby
1265
1312
  # HTTP header 'Content-Type'
1266
1313
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1267
1314
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
1315
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
1268
1316
 
1269
1317
  # form parameters
1270
1318
  form_params = opts[:form_params] || {}
@@ -1298,6 +1346,7 @@ module XeroRuby
1298
1346
  # @param xero_tenant_id [String] Xero identifier for Tenant
1299
1347
  # @param reimbursement [Reimbursement]
1300
1348
  # @param [Hash] opts the optional parameters
1349
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1301
1350
  # @return [ReimbursementObject]
1302
1351
  def create_reimbursement(xero_tenant_id, reimbursement, opts = {})
1303
1352
  data, _status_code, _headers = create_reimbursement_with_http_info(xero_tenant_id, reimbursement, opts)
@@ -1308,6 +1357,7 @@ module XeroRuby
1308
1357
  # @param xero_tenant_id [String] Xero identifier for Tenant
1309
1358
  # @param reimbursement [Reimbursement]
1310
1359
  # @param [Hash] opts the optional parameters
1360
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1311
1361
  # @return [Array<(ReimbursementObject, Integer, Hash)>] ReimbursementObject data, response status code and response headers
1312
1362
  def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = {})
1313
1363
  opts = options.dup
@@ -1342,6 +1392,7 @@ module XeroRuby
1342
1392
  # HTTP header 'Content-Type'
1343
1393
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1344
1394
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
1395
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
1345
1396
 
1346
1397
  # form parameters
1347
1398
  form_params = opts[:form_params] || {}
@@ -1375,6 +1426,7 @@ module XeroRuby
1375
1426
  # @param xero_tenant_id [String] Xero identifier for Tenant
1376
1427
  # @param timesheet [Timesheet]
1377
1428
  # @param [Hash] opts the optional parameters
1429
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1378
1430
  # @return [TimesheetObject]
1379
1431
  def create_timesheet(xero_tenant_id, timesheet, opts = {})
1380
1432
  data, _status_code, _headers = create_timesheet_with_http_info(xero_tenant_id, timesheet, opts)
@@ -1385,6 +1437,7 @@ module XeroRuby
1385
1437
  # @param xero_tenant_id [String] Xero identifier for Tenant
1386
1438
  # @param timesheet [Timesheet]
1387
1439
  # @param [Hash] opts the optional parameters
1440
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1388
1441
  # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers
1389
1442
  def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {})
1390
1443
  opts = options.dup
@@ -1419,6 +1472,7 @@ module XeroRuby
1419
1472
  # HTTP header 'Content-Type'
1420
1473
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1421
1474
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
1475
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
1422
1476
 
1423
1477
  # form parameters
1424
1478
  form_params = opts[:form_params] || {}
@@ -1453,6 +1507,7 @@ module XeroRuby
1453
1507
  # @param timesheet_id [String] Identifier for the timesheet
1454
1508
  # @param timesheet_line [TimesheetLine]
1455
1509
  # @param [Hash] opts the optional parameters
1510
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1456
1511
  # @return [TimesheetLineObject]
1457
1512
  def create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts = {})
1458
1513
  data, _status_code, _headers = create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, opts)
@@ -1464,6 +1519,7 @@ module XeroRuby
1464
1519
  # @param timesheet_id [String] Identifier for the timesheet
1465
1520
  # @param timesheet_line [TimesheetLine]
1466
1521
  # @param [Hash] opts the optional parameters
1522
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1467
1523
  # @return [Array<(TimesheetLineObject, Integer, Hash)>] TimesheetLineObject data, response status code and response headers
1468
1524
  def create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, options = {})
1469
1525
  opts = options.dup
@@ -1502,6 +1558,7 @@ module XeroRuby
1502
1558
  # HTTP header 'Content-Type'
1503
1559
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1504
1560
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
1561
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
1505
1562
 
1506
1563
  # form parameters
1507
1564
  form_params = opts[:form_params] || {}
@@ -4800,6 +4857,7 @@ module XeroRuby
4800
4857
  # @param xero_tenant_id [String] Xero identifier for Tenant
4801
4858
  # @param timesheet_id [String] Identifier for the timesheet
4802
4859
  # @param [Hash] opts the optional parameters
4860
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
4803
4861
  # @return [TimesheetObject]
4804
4862
  def revert_timesheet(xero_tenant_id, timesheet_id, opts = {})
4805
4863
  data, _status_code, _headers = revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts)
@@ -4810,6 +4868,7 @@ module XeroRuby
4810
4868
  # @param xero_tenant_id [String] Xero identifier for Tenant
4811
4869
  # @param timesheet_id [String] Identifier for the timesheet
4812
4870
  # @param [Hash] opts the optional parameters
4871
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
4813
4872
  # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers
4814
4873
  def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
4815
4874
  opts = options.dup
@@ -4842,6 +4901,7 @@ module XeroRuby
4842
4901
  # HTTP header 'Accept' (if needed)
4843
4902
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4844
4903
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
4904
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
4845
4905
 
4846
4906
  # form parameters
4847
4907
  form_params = opts[:form_params] || {}
@@ -4876,6 +4936,7 @@ module XeroRuby
4876
4936
  # @param employee_id [String] Employee id for single object
4877
4937
  # @param employee [Employee]
4878
4938
  # @param [Hash] opts the optional parameters
4939
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
4879
4940
  # @return [EmployeeObject]
4880
4941
  def update_employee(xero_tenant_id, employee_id, employee, opts = {})
4881
4942
  data, _status_code, _headers = update_employee_with_http_info(xero_tenant_id, employee_id, employee, opts)
@@ -4887,6 +4948,7 @@ module XeroRuby
4887
4948
  # @param employee_id [String] Employee id for single object
4888
4949
  # @param employee [Employee]
4889
4950
  # @param [Hash] opts the optional parameters
4951
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
4890
4952
  # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers
4891
4953
  def update_employee_with_http_info(xero_tenant_id, employee_id, employee, options = {})
4892
4954
  opts = options.dup
@@ -4925,6 +4987,7 @@ module XeroRuby
4925
4987
  # HTTP header 'Content-Type'
4926
4988
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4927
4989
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
4990
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
4928
4991
 
4929
4992
  # form parameters
4930
4993
  form_params = opts[:form_params] || {}
@@ -4960,6 +5023,7 @@ module XeroRuby
4960
5023
  # @param pay_template_earning_id [String] Id for single pay template earnings object
4961
5024
  # @param earnings_template [EarningsTemplate]
4962
5025
  # @param [Hash] opts the optional parameters
5026
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
4963
5027
  # @return [EarningsTemplateObject]
4964
5028
  def update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts = {})
4965
5029
  data, _status_code, _headers = update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts)
@@ -4972,6 +5036,7 @@ module XeroRuby
4972
5036
  # @param pay_template_earning_id [String] Id for single pay template earnings object
4973
5037
  # @param earnings_template [EarningsTemplate]
4974
5038
  # @param [Hash] opts the optional parameters
5039
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
4975
5040
  # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers
4976
5041
  def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, options = {})
4977
5042
  opts = options.dup
@@ -5014,6 +5079,7 @@ module XeroRuby
5014
5079
  # HTTP header 'Content-Type'
5015
5080
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5016
5081
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
5082
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
5017
5083
 
5018
5084
  # form parameters
5019
5085
  form_params = opts[:form_params] || {}
@@ -5049,6 +5115,7 @@ module XeroRuby
5049
5115
  # @param leave_id [String] Leave id for single object
5050
5116
  # @param employee_leave [EmployeeLeave]
5051
5117
  # @param [Hash] opts the optional parameters
5118
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5052
5119
  # @return [EmployeeLeaveObject]
5053
5120
  def update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, opts = {})
5054
5121
  data, _status_code, _headers = update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, opts)
@@ -5061,6 +5128,7 @@ module XeroRuby
5061
5128
  # @param leave_id [String] Leave id for single object
5062
5129
  # @param employee_leave [EmployeeLeave]
5063
5130
  # @param [Hash] opts the optional parameters
5131
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5064
5132
  # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers
5065
5133
  def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, options = {})
5066
5134
  opts = options.dup
@@ -5103,6 +5171,7 @@ module XeroRuby
5103
5171
  # HTTP header 'Content-Type'
5104
5172
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5105
5173
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
5174
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
5106
5175
 
5107
5176
  # form parameters
5108
5177
  form_params = opts[:form_params] || {}
@@ -5137,6 +5206,7 @@ module XeroRuby
5137
5206
  # @param employee_id [String] Employee id for single object
5138
5207
  # @param employee_opening_balances [EmployeeOpeningBalances]
5139
5208
  # @param [Hash] opts the optional parameters
5209
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5140
5210
  # @return [EmployeeOpeningBalancesObject]
5141
5211
  def update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts = {})
5142
5212
  data, _status_code, _headers = update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, opts)
@@ -5148,6 +5218,7 @@ module XeroRuby
5148
5218
  # @param employee_id [String] Employee id for single object
5149
5219
  # @param employee_opening_balances [EmployeeOpeningBalances]
5150
5220
  # @param [Hash] opts the optional parameters
5221
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5151
5222
  # @return [Array<(EmployeeOpeningBalancesObject, Integer, Hash)>] EmployeeOpeningBalancesObject data, response status code and response headers
5152
5223
  def update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, options = {})
5153
5224
  opts = options.dup
@@ -5186,6 +5257,7 @@ module XeroRuby
5186
5257
  # HTTP header 'Content-Type'
5187
5258
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5188
5259
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
5260
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
5189
5261
 
5190
5262
  # form parameters
5191
5263
  form_params = opts[:form_params] || {}
@@ -5221,6 +5293,7 @@ module XeroRuby
5221
5293
  # @param salary_and_wages_id [String] Id for single pay template earnings object
5222
5294
  # @param salary_and_wage [SalaryAndWage]
5223
5295
  # @param [Hash] opts the optional parameters
5296
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5224
5297
  # @return [SalaryAndWageObject]
5225
5298
  def update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts = {})
5226
5299
  data, _status_code, _headers = update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts)
@@ -5233,6 +5306,7 @@ module XeroRuby
5233
5306
  # @param salary_and_wages_id [String] Id for single pay template earnings object
5234
5307
  # @param salary_and_wage [SalaryAndWage]
5235
5308
  # @param [Hash] opts the optional parameters
5309
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5236
5310
  # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers
5237
5311
  def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, options = {})
5238
5312
  opts = options.dup
@@ -5275,6 +5349,7 @@ module XeroRuby
5275
5349
  # HTTP header 'Content-Type'
5276
5350
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5277
5351
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
5352
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
5278
5353
 
5279
5354
  # form parameters
5280
5355
  form_params = opts[:form_params] || {}
@@ -5309,6 +5384,7 @@ module XeroRuby
5309
5384
  # @param pay_run_id [String] Identifier for the pay run
5310
5385
  # @param pay_run [PayRun]
5311
5386
  # @param [Hash] opts the optional parameters
5387
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5312
5388
  # @return [PayRunObject]
5313
5389
  def update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts = {})
5314
5390
  data, _status_code, _headers = update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, opts)
@@ -5320,6 +5396,7 @@ module XeroRuby
5320
5396
  # @param pay_run_id [String] Identifier for the pay run
5321
5397
  # @param pay_run [PayRun]
5322
5398
  # @param [Hash] opts the optional parameters
5399
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5323
5400
  # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers
5324
5401
  def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = {})
5325
5402
  opts = options.dup
@@ -5358,6 +5435,7 @@ module XeroRuby
5358
5435
  # HTTP header 'Content-Type'
5359
5436
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5360
5437
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
5438
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
5361
5439
 
5362
5440
  # form parameters
5363
5441
  form_params = opts[:form_params] || {}
@@ -5393,6 +5471,7 @@ module XeroRuby
5393
5471
  # @param timesheet_line_id [String] Identifier for the timesheet line
5394
5472
  # @param timesheet_line [TimesheetLine]
5395
5473
  # @param [Hash] opts the optional parameters
5474
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5396
5475
  # @return [TimesheetLineObject]
5397
5476
  def update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts = {})
5398
5477
  data, _status_code, _headers = update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts)
@@ -5405,6 +5484,7 @@ module XeroRuby
5405
5484
  # @param timesheet_line_id [String] Identifier for the timesheet line
5406
5485
  # @param timesheet_line [TimesheetLine]
5407
5486
  # @param [Hash] opts the optional parameters
5487
+ # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5408
5488
  # @return [Array<(TimesheetLineObject, Integer, Hash)>] TimesheetLineObject data, response status code and response headers
5409
5489
  def update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, options = {})
5410
5490
  opts = options.dup
@@ -5447,6 +5527,7 @@ module XeroRuby
5447
5527
  # HTTP header 'Content-Type'
5448
5528
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5449
5529
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id
5530
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
5450
5531
 
5451
5532
  # form parameters
5452
5533
  form_params = opts[:form_params] || {}