Class: GustoEmbedded::TaxRequirements

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/gusto_embedded/taxrequirements.rb

Instance Method Summary collapse

Constructor Details

#initialize(sdk_config) ⇒ TaxRequirements

Returns a new instance of TaxRequirements.



17
18
19
 
# File 'lib/gusto_embedded/taxrequirements.rb', line 17

def initialize(sdk_config)
  @sdk_configuration = sdk_config
end

Instance Method Details

#get(company_uuid, state, scheduling = nil, x_gusto_api_version = nil) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/gusto_embedded/taxrequirements.rb', line 23

def get(company_uuid, state, scheduling = nil, x_gusto_api_version = nil)
  # get - Get State Tax Requirements
  # Get all tax requirements for a given state.
  # 
  # ### Metadata Examples
  # 
  # ```json select
  # {
  #   "type": "select",
  #   "options": [
  #     { "label": "Semiweekly",  value: "Semi-weekly" },
  #     { "label": "Monthly",  value: "Monthly" },
  #     { "label": "Quarterly",  value: "Quarterly" },
  #   ]
  # }
  # ```
  # ```json radio
  # {
  #   "type": "radio",
  #   "options": [
  #     { "label": "No, we cannot reimburse",  value: false, short_label: "Not Reimbursable" },
  #     { "label": "Yes, we can reimburse",  value: true, short_label: "Reimbursable" },
  #   ]
  # }
  # ```
  # ```json account_number
  # {
  #   "type": "account_number",
  #   "mask": "######-##',
  #   "prefix": null
  # }
  # ```
  # ```json tax_rate
  # {
  #   "type": "tax_rate",
  #   "validation": {
  #     "type": "min_max",
  #     "min": "0.0004",
  #     "max": "0.081"
  #   }
  # }
  # ```
  # 
  # scope: `company_tax_requirements:read`
  # 
  request = ::GustoEmbedded::Operations::GetV1CompaniesCompanyUuidTaxRequirementsStateRequest.new(
    
    company_uuid: company_uuid,
    state: state,
    scheduling: scheduling,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::GetV1CompaniesCompanyUuidTaxRequirementsStateRequest,
    base_url,
    '/v1/companies/{company_uuid}/tax_requirements/{state}',
    request
  )
  headers = Utils.get_headers(request)
  query_params = Utils.get_query_params(::GustoEmbedded::Operations::GetV1CompaniesCompanyUuidTaxRequirementsStateRequest, request)
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.get(url) do |req|
    req.headers = headers
    req.params = query_params
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::GetV1CompaniesCompanyUuidTaxRequirementsStateResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::GustoEmbedded::Shared::TaxRequirementsState)
      res.tax_requirements_state = out
    end
  elsif r.status == 404
  end

  res
end

#get_all(company_uuid, x_gusto_api_version = nil) ⇒ Object 



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/gusto_embedded/taxrequirements.rb', line 172

def get_all(company_uuid, x_gusto_api_version = nil)
  # get_all - Get All Tax Requirement States
  # Returns objects describing the states that have tax requirements for the company
  # 
  # scope: `company_tax_requirements:read`
  request = ::GustoEmbedded::Operations::GetV1CompaniesCompanyUuidTaxRequirementsRequest.new(
    
    company_uuid: company_uuid,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::GetV1CompaniesCompanyUuidTaxRequirementsRequest,
    base_url,
    '/v1/companies/{company_uuid}/tax_requirements',
    request
  )
  headers = Utils.get_headers(request)
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.get(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::GetV1CompaniesCompanyUuidTaxRequirementsResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), T::Array[::GustoEmbedded::Operations::GetV1CompaniesCompanyUuidTaxRequirementsResponseBody])
      res.response_bodies = out
    end
  elsif r.status == 404
  end

  res
end

#update_state(company_uuid, state, request_body, x_gusto_api_version = nil) ⇒ Object

Raises:

  • (StandardError) 


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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/gusto_embedded/taxrequirements.rb', line 113

def update_state(company_uuid, state, request_body, x_gusto_api_version = nil)
  # update_state - Update State Tax Requirements
  # Update State Tax Requirements
  # 
  # scope: `company_tax_requirements:write`
  request = ::GustoEmbedded::Operations::PutV1CompaniesCompanyUuidTaxRequirementsStateRequest.new(
    
    company_uuid: company_uuid,
    state: state,
    request_body: request_body,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::PutV1CompaniesCompanyUuidTaxRequirementsStateRequest,
    base_url,
    '/v1/companies/{company_uuid}/tax_requirements/{state}',
    request
  )
  headers = Utils.get_headers(request)
  req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :json)
  headers['content-type'] = req_content_type
  raise StandardError, 'request body is required' if data.nil? && form.nil?
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.put(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
    if form
      req.body = Utils.encode_form(form)
    elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
      req.body = URI.encode_www_form(data)
    else
      req.body = data
    end
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::PutV1CompaniesCompanyUuidTaxRequirementsStateResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
  elsif r.status == 404
  elsif r.status == 422
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::GustoEmbedded::Shared::UnprocessableEntityErrorObject)
      res.unprocessable_entity_error_object = out
    end
  end

  res
end