Class: Phyllo::IncomeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phyllo/api/income_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IncomeApi

Returns a new instance of IncomeApi.



17
18
19
 
# File 'lib/phyllo/api/income_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/phyllo/api/income_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#v1_fetch_historic_commerce_income_balances(opts = {}) ⇒ FetchHistoric1

Fetch historic e-commerce balances for an account Fetch balances for a connected e-commerce account starting from a specific date till today by providing the ‘from_date`. Once Phyllo processes the request, you can fetch the updated balances by calling the [retrieve e-commerce balances API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1balances/get). Subscribe to the "BALANCES.ADDED" and "BALANCES.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce balances in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1balances~1search/post) for optimal performance. Check the `category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



26
27
28
29
 
# File 'lib/phyllo/api/income_api.rb', line 26

def v1_fetch_historic_commerce_income_balances(opts = {})
  data, _status_code, _headers = v1_fetch_historic_commerce_income_balances_with_http_info(opts)
  data
end

#v1_fetch_historic_commerce_income_balances_with_http_info(opts = {}) ⇒ Array<(FetchHistoric1, Integer, Hash)>

Fetch historic e-commerce balances for an account Fetch balances for a connected e-commerce account starting from a specific date till today by providing the &#x60;from_date&#x60;. Once Phyllo processes the request, you can fetch the updated balances by calling the [retrieve e-commerce balances API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1balances/get). Subscribe to the &quot;BALANCES.ADDED&quot; and &quot;BALANCES.UPDATED&quot; webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce balances in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1balances~1search/post) for optimal performance. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(FetchHistoric1, Integer, Hash)>) —

    FetchHistoric1 data, response status code and response headers



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
 
# File 'lib/phyllo/api/income_api.rb', line 36

def v1_fetch_historic_commerce_income_balances_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_fetch_historic_commerce_income_balances ..."
  end
  # resource path
  local_var_path = "/v1/commerce/income/balances/fetch-historic"

  # 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(opts[:fetch_historic1])

  # return_type
  return_type = opts[:debug_return_type] || "FetchHistoric1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_fetch_historic_commerce_income_payouts(opts = {}) ⇒ FetchHistoric1

Fetch historic e-commerce payouts for an account Fetch payouts for a connected e-commerce account starting from a specific date till today by providing the ‘from_date`. Once Phyllo processes the request, you can fetch the updated payouts by calling the [retrieve e-commerce payouts API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1payouts/get). Subscribe to the "PAYOUTS.ADDED" and "PAYOUTS.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce payouts in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1payouts~1search/post) for optimal performance. Check the `category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



90
91
92
93
 
# File 'lib/phyllo/api/income_api.rb', line 90

def v1_fetch_historic_commerce_income_payouts(opts = {})
  data, _status_code, _headers = v1_fetch_historic_commerce_income_payouts_with_http_info(opts)
  data
end

#v1_fetch_historic_commerce_income_payouts_with_http_info(opts = {}) ⇒ Array<(FetchHistoric1, Integer, Hash)>

Fetch historic e-commerce payouts for an account Fetch payouts for a connected e-commerce account starting from a specific date till today by providing the &#x60;from_date&#x60;. Once Phyllo processes the request, you can fetch the updated payouts by calling the [retrieve e-commerce payouts API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1payouts/get). Subscribe to the &quot;PAYOUTS.ADDED&quot; and &quot;PAYOUTS.UPDATED&quot; webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce payouts in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1payouts~1search/post) for optimal performance. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(FetchHistoric1, Integer, Hash)>) —

    FetchHistoric1 data, response status code and response headers



100
101
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
145
146
147
 
# File 'lib/phyllo/api/income_api.rb', line 100

def v1_fetch_historic_commerce_income_payouts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_fetch_historic_commerce_income_payouts ..."
  end
  # resource path
  local_var_path = "/v1/commerce/income/payouts/fetch-historic"

  # 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(opts[:fetch_historic1])

  # return_type
  return_type = opts[:debug_return_type] || "FetchHistoric1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_fetch_historic_commerce_income_transactions(opts = {}) ⇒ FetchHistoric1

Fetch historic e-commerce transactions for an account Fetch transactions for a connected e-commerce account starting from a specific date till today by providing the ‘from_date`. Once Phyllo processes the request, you can fetch the updated transactions by calling the [retrieve e-commerce transactions API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1transactions/get). Subscribe to the "TRANSACTIONS.ADDED" and "TRANSACTIONS.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce transactions in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1transactions~1search/post) for optimal performance. Check the `category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



154
155
156
157
 
# File 'lib/phyllo/api/income_api.rb', line 154

def v1_fetch_historic_commerce_income_transactions(opts = {})
  data, _status_code, _headers = v1_fetch_historic_commerce_income_transactions_with_http_info(opts)
  data
end

#v1_fetch_historic_commerce_income_transactions_with_http_info(opts = {}) ⇒ Array<(FetchHistoric1, Integer, Hash)>

Fetch historic e-commerce transactions for an account Fetch transactions for a connected e-commerce account starting from a specific date till today by providing the &#x60;from_date&#x60;. Once Phyllo processes the request, you can fetch the updated transactions by calling the [retrieve e-commerce transactions API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1transactions/get). Subscribe to the &quot;TRANSACTIONS.ADDED&quot; and &quot;TRANSACTIONS.UPDATED&quot; webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce transactions in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1transactions~1search/post) for optimal performance. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(FetchHistoric1, Integer, Hash)>) —

    FetchHistoric1 data, 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
208
209
210
211
 
# File 'lib/phyllo/api/income_api.rb', line 164

def v1_fetch_historic_commerce_income_transactions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_fetch_historic_commerce_income_transactions ..."
  end
  # resource path
  local_var_path = "/v1/commerce/income/transactions/fetch-historic"

  # 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(opts[:fetch_historic1])

  # return_type
  return_type = opts[:debug_return_type] || "FetchHistoric1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_fetch_historic_social_income_payouts(opts = {}) ⇒ FetchHistoric1

Fetch historic social payouts for an account Fetch payouts for a connected social account starting from a specific date till today by providing the ‘from_date`. Once Phyllo processes the request, you can fetch the updated payouts by calling the [retrieve social payouts API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1payouts/get). Subscribe to the "PAYOUTS.ADDED" and "PAYOUTS.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve social payouts in bulk API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1payouts~1search/post) for optimal performance. Check the `category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "social".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



218
219
220
221
 
# File 'lib/phyllo/api/income_api.rb', line 218

def v1_fetch_historic_social_income_payouts(opts = {})
  data, _status_code, _headers = v1_fetch_historic_social_income_payouts_with_http_info(opts)
  data
end

#v1_fetch_historic_social_income_payouts_with_http_info(opts = {}) ⇒ Array<(FetchHistoric1, Integer, Hash)>

Fetch historic social payouts for an account Fetch payouts for a connected social account starting from a specific date till today by providing the &#x60;from_date&#x60;. Once Phyllo processes the request, you can fetch the updated payouts by calling the [retrieve social payouts API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1payouts/get). Subscribe to the &quot;PAYOUTS.ADDED&quot; and &quot;PAYOUTS.UPDATED&quot; webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve social payouts in bulk API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1payouts~1search/post) for optimal performance. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;social&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(FetchHistoric1, Integer, Hash)>) —

    FetchHistoric1 data, response status code and response headers



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
268
269
270
271
272
273
274
275
 
# File 'lib/phyllo/api/income_api.rb', line 228

def v1_fetch_historic_social_income_payouts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_fetch_historic_social_income_payouts ..."
  end
  # resource path
  local_var_path = "/v1/social/income/payouts/fetch-historic"

  # 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(opts[:fetch_historic1])

  # return_type
  return_type = opts[:debug_return_type] || "FetchHistoric1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_fetch_historic_social_income_transactions(opts = {}) ⇒ FetchHistoric1

Fetch historic social transactions for an account Fetch transactions for a connected social account starting from a specific date till today by providing the ‘from_date`. Once Phyllo processes the request, you can fetch the updated transactions by calling the [retrieve social transactions API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1transactions/get). Subscribe to the "TRANSACTIONS.ADDED" and "TRANSACTIONS.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve social transactions in bulk API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1transactions~1search/post) for optimal performance. Check the `category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "social".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



282
283
284
285
 
# File 'lib/phyllo/api/income_api.rb', line 282

def v1_fetch_historic_social_income_transactions(opts = {})
  data, _status_code, _headers = v1_fetch_historic_social_income_transactions_with_http_info(opts)
  data
end

#v1_fetch_historic_social_income_transactions_with_http_info(opts = {}) ⇒ Array<(FetchHistoric1, Integer, Hash)>

Fetch historic social transactions for an account Fetch transactions for a connected social account starting from a specific date till today by providing the &#x60;from_date&#x60;. Once Phyllo processes the request, you can fetch the updated transactions by calling the [retrieve social transactions API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1transactions/get). Subscribe to the &quot;TRANSACTIONS.ADDED&quot; and &quot;TRANSACTIONS.UPDATED&quot; webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve social transactions in bulk API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1transactions~1search/post) for optimal performance. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;social&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(FetchHistoric1, Integer, Hash)>) —

    FetchHistoric1 data, response status code and response headers



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/phyllo/api/income_api.rb', line 292

def v1_fetch_historic_social_income_transactions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_fetch_historic_social_income_transactions ..."
  end
  # resource path
  local_var_path = "/v1/social/income/transactions/fetch-historic"

  # 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(opts[:fetch_historic1])

  # return_type
  return_type = opts[:debug_return_type] || "FetchHistoric1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_get_commerce_income_balance_by_id(id, opts = {}) ⇒ CommerceBalance1

Retrieve a e-commerce balance Retrieve the information of the balance with the supplied balance ID. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

  • id (String) —

    Unique identifier for the balance

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

    the optional parameters

Returns:



346
347
348
349
 
# File 'lib/phyllo/api/income_api.rb', line 346

def v1_get_commerce_income_balance_by_id(id, opts = {})
  data, _status_code, _headers = v1_get_commerce_income_balance_by_id_with_http_info(id, opts)
  data
end

#v1_get_commerce_income_balance_by_id_with_http_info(id, opts = {}) ⇒ Array<(CommerceBalance1, Integer, Hash)>

Retrieve a e-commerce balance Retrieve the information of the balance with the supplied balance ID. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

  • id (String) —

    Unique identifier for the balance

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

    the optional parameters

Returns:

  • (Array<(CommerceBalance1, Integer, Hash)>) —

    CommerceBalance1 data, response status code and response headers



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/phyllo/api/income_api.rb', line 356

def v1_get_commerce_income_balance_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_get_commerce_income_balance_by_id ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IncomeApi.v1_get_commerce_income_balance_by_id"
  end
  # resource path
  local_var_path = "/v1/commerce/income/balances/{id}".sub("{" + "id" + "}", CGI.escape(id.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] || "CommerceBalance1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_get_commerce_income_balances(balance_from_date, balance_to_date, account_id, opts = {}) ⇒ CommerceBalanceList1

Retrieve e-commerce balances for an account Lists all daily balances of the given e-commerce account. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

  • balance_from_date (Date) —

    Return daily balances on or after this date. (YYYY-MM-DD)

  • balance_to_date (Date) —

    Return daily balances on or before this date. (YYYY-MM-DD)

  • account_id (String) —

    Unique ID of the connected account.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:



413
414
415
416
 
# File 'lib/phyllo/api/income_api.rb', line 413

def v1_get_commerce_income_balances(balance_from_date, balance_to_date, , opts = {})
  data, _status_code, _headers = v1_get_commerce_income_balances_with_http_info(balance_from_date, balance_to_date, , opts)
  data
end

#v1_get_commerce_income_balances_with_http_info(balance_from_date, balance_to_date, account_id, opts = {}) ⇒ Array<(CommerceBalanceList1, Integer, Hash)>

Retrieve e-commerce balances for an account Lists all daily balances of the given e-commerce account. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

  • balance_from_date (Date) —

    Return daily balances on or after this date. (YYYY-MM-DD)

  • balance_to_date (Date) —

    Return daily balances on or before this date. (YYYY-MM-DD)

  • account_id (String) —

    Unique ID of the connected account.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:

  • (Array<(CommerceBalanceList1, Integer, Hash)>) —

    CommerceBalanceList1 data, response status code and response headers



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/phyllo/api/income_api.rb', line 427

def v1_get_commerce_income_balances_with_http_info(balance_from_date, balance_to_date, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_get_commerce_income_balances ..."
  end
  # verify the required parameter 'balance_from_date' is set
  if @api_client.config.client_side_validation && balance_from_date.nil?
    fail ArgumentError, "Missing the required parameter 'balance_from_date' when calling IncomeApi.v1_get_commerce_income_balances"
  end
  # verify the required parameter 'balance_to_date' is set
  if @api_client.config.client_side_validation && balance_to_date.nil?
    fail ArgumentError, "Missing the required parameter 'balance_to_date' when calling IncomeApi.v1_get_commerce_income_balances"
  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 IncomeApi.v1_get_commerce_income_balances"
  end
  # resource path
  local_var_path = "/v1/commerce/income/balances"

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:balance_from_date] = balance_from_date
  query_params[:balance_to_date] = balance_to_date
  query_params[:account_id] = 
  query_params[:limit] = opts[:limit] if !opts[:limit].nil?
  query_params[:offset] = opts[:offset] if !opts[:offset].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] || "CommerceBalanceList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_get_commerce_income_payout_by_id(id, opts = {}) ⇒ CommercePayout1

Retrieve a e-commerce payout Retrieve the information of the payout with the supplied payout ID. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

  • id (String) —

    Unique identifier for the payout

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

    the optional parameters

Returns:



493
494
495
496
 
# File 'lib/phyllo/api/income_api.rb', line 493

def v1_get_commerce_income_payout_by_id(id, opts = {})
  data, _status_code, _headers = v1_get_commerce_income_payout_by_id_with_http_info(id, opts)
  data
end

#v1_get_commerce_income_payout_by_id_with_http_info(id, opts = {}) ⇒ Array<(CommercePayout1, Integer, Hash)>

Retrieve a e-commerce payout Retrieve the information of the payout with the supplied payout ID. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

  • id (String) —

    Unique identifier for the payout

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

    the optional parameters

Returns:

  • (Array<(CommercePayout1, Integer, Hash)>) —

    CommercePayout1 data, response status code and response headers



503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/phyllo/api/income_api.rb', line 503

def v1_get_commerce_income_payout_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_get_commerce_income_payout_by_id ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IncomeApi.v1_get_commerce_income_payout_by_id"
  end
  # resource path
  local_var_path = "/v1/commerce/income/payouts/{id}".sub("{" + "id" + "}", CGI.escape(id.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] || "CommercePayout1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_get_commerce_income_payouts(payout_from_date, payout_to_date, account_id, opts = {}) ⇒ CommercePayoutList1

Retrieve e-commerce payouts for an account Lists all payouts of the given e-commerce account. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

  • payout_from_date (Date) —

    Return payouts on or after this date. (YYYY-MM-DD)

  • payout_to_date (Date) —

    Return payouts on or before this date. (YYYY-MM-DD)

  • account_id (String) —

    Unique ID of the connected account.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:



560
561
562
563
 
# File 'lib/phyllo/api/income_api.rb', line 560

def v1_get_commerce_income_payouts(payout_from_date, payout_to_date, , opts = {})
  data, _status_code, _headers = v1_get_commerce_income_payouts_with_http_info(payout_from_date, payout_to_date, , opts)
  data
end

#v1_get_commerce_income_payouts_with_http_info(payout_from_date, payout_to_date, account_id, opts = {}) ⇒ Array<(CommercePayoutList1, Integer, Hash)>

Retrieve e-commerce payouts for an account Lists all payouts of the given e-commerce account. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

  • payout_from_date (Date) —

    Return payouts on or after this date. (YYYY-MM-DD)

  • payout_to_date (Date) —

    Return payouts on or before this date. (YYYY-MM-DD)

  • account_id (String) —

    Unique ID of the connected account.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:

  • (Array<(CommercePayoutList1, Integer, Hash)>) —

    CommercePayoutList1 data, response status code and response headers



574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/phyllo/api/income_api.rb', line 574

def v1_get_commerce_income_payouts_with_http_info(payout_from_date, payout_to_date, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_get_commerce_income_payouts ..."
  end
  # verify the required parameter 'payout_from_date' is set
  if @api_client.config.client_side_validation && payout_from_date.nil?
    fail ArgumentError, "Missing the required parameter 'payout_from_date' when calling IncomeApi.v1_get_commerce_income_payouts"
  end
  # verify the required parameter 'payout_to_date' is set
  if @api_client.config.client_side_validation && payout_to_date.nil?
    fail ArgumentError, "Missing the required parameter 'payout_to_date' when calling IncomeApi.v1_get_commerce_income_payouts"
  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 IncomeApi.v1_get_commerce_income_payouts"
  end
  # resource path
  local_var_path = "/v1/commerce/income/payouts"

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:payout_from_date] = payout_from_date
  query_params[:payout_to_date] = payout_to_date
  query_params[:account_id] = 
  query_params[:limit] = opts[:limit] if !opts[:limit].nil?
  query_params[:offset] = opts[:offset] if !opts[:offset].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] || "CommercePayoutList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_get_commerce_income_transaction_by_id(id, opts = {}) ⇒ CommerceTransaction1

Retrieve a e-commerce transaction Retrieve the information of the transaction with the supplied transaction ID. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

  • id (String) —

    Unique identifier for the transaction

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

    the optional parameters

Returns:



640
641
642
643
 
# File 'lib/phyllo/api/income_api.rb', line 640

def v1_get_commerce_income_transaction_by_id(id, opts = {})
  data, _status_code, _headers = v1_get_commerce_income_transaction_by_id_with_http_info(id, opts)
  data
end

#v1_get_commerce_income_transaction_by_id_with_http_info(id, opts = {}) ⇒ Array<(CommerceTransaction1, Integer, Hash)>

Retrieve a e-commerce transaction Retrieve the information of the transaction with the supplied transaction ID. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

  • id (String) —

    Unique identifier for the transaction

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

    the optional parameters

Returns:

  • (Array<(CommerceTransaction1, Integer, Hash)>) —

    CommerceTransaction1 data, response status code and response headers



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/phyllo/api/income_api.rb', line 650

def v1_get_commerce_income_transaction_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_get_commerce_income_transaction_by_id ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IncomeApi.v1_get_commerce_income_transaction_by_id"
  end
  # resource path
  local_var_path = "/v1/commerce/income/transactions/{id}".sub("{" + "id" + "}", CGI.escape(id.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] || "CommerceTransaction1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_get_commerce_income_transactions(transaction_from_date, transaction_to_date, account_id, opts = {}) ⇒ CommerceTransactionList1

Retrieve e-commerce transactions for an account Lists all transactions of the given e-commerce account. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

  • transaction_from_date (Date) —

    Return transactions on or after this date. (YYYY-MM-DD)

  • transaction_to_date (Date) —

    Return transactions on or before this date. (YYYY-MM-DD)

  • account_id (String) —

    Unique ID of the connected account.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Type of transaction on the e-commerce platform

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:



708
709
710
711
 
# File 'lib/phyllo/api/income_api.rb', line 708

def v1_get_commerce_income_transactions(transaction_from_date, transaction_to_date, , opts = {})
  data, _status_code, _headers = v1_get_commerce_income_transactions_with_http_info(transaction_from_date, transaction_to_date, , opts)
  data
end

#v1_get_commerce_income_transactions_with_http_info(transaction_from_date, transaction_to_date, account_id, opts = {}) ⇒ Array<(CommerceTransactionList1, Integer, Hash)>

Retrieve e-commerce transactions for an account Lists all transactions of the given e-commerce account. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

  • transaction_from_date (Date) —

    Return transactions on or after this date. (YYYY-MM-DD)

  • transaction_to_date (Date) —

    Return transactions on or before this date. (YYYY-MM-DD)

  • account_id (String) —

    Unique ID of the connected account.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Type of transaction on the e-commerce platform

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:

  • (Array<(CommerceTransactionList1, Integer, Hash)>) —

    CommerceTransactionList1 data, response status code and response headers



723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/phyllo/api/income_api.rb', line 723

def v1_get_commerce_income_transactions_with_http_info(transaction_from_date, transaction_to_date, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_get_commerce_income_transactions ..."
  end
  # verify the required parameter 'transaction_from_date' is set
  if @api_client.config.client_side_validation && transaction_from_date.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_from_date' when calling IncomeApi.v1_get_commerce_income_transactions"
  end
  # verify the required parameter 'transaction_to_date' is set
  if @api_client.config.client_side_validation && transaction_to_date.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_to_date' when calling IncomeApi.v1_get_commerce_income_transactions"
  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 IncomeApi.v1_get_commerce_income_transactions"
  end
  allowable_values = ["SALE", "REFUND", "CANCELLED", "VOID", "OTHER"]
  if @api_client.config.client_side_validation && opts[:type] && !allowable_values.include?(opts[:type])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = "/v1/commerce/income/transactions"

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:transaction_from_date] = transaction_from_date
  query_params[:transaction_to_date] = transaction_to_date
  query_params[:account_id] = 
  query_params[:type] = opts[:type] if !opts[:type].nil?
  query_params[:limit] = opts[:limit] if !opts[:limit].nil?
  query_params[:offset] = opts[:offset] if !opts[:offset].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] || "CommerceTransactionList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_get_social_income_payout_by_id(id, opts = {}) ⇒ CommercePayout1

Retrieve a social payout Retrieve the information of the payout with the supplied payout ID. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "social".

Parameters:

  • id (String) —

    Unique identifier for the transaction

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

    the optional parameters

Returns:



794
795
796
797
 
# File 'lib/phyllo/api/income_api.rb', line 794

def v1_get_social_income_payout_by_id(id, opts = {})
  data, _status_code, _headers = v1_get_social_income_payout_by_id_with_http_info(id, opts)
  data
end

#v1_get_social_income_payout_by_id_with_http_info(id, opts = {}) ⇒ Array<(CommercePayout1, Integer, Hash)>

Retrieve a social payout Retrieve the information of the payout with the supplied payout ID. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;social&quot;.

Parameters:

  • id (String) —

    Unique identifier for the transaction

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

    the optional parameters

Returns:

  • (Array<(CommercePayout1, Integer, Hash)>) —

    CommercePayout1 data, response status code and response headers



804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/phyllo/api/income_api.rb', line 804

def v1_get_social_income_payout_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_get_social_income_payout_by_id ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IncomeApi.v1_get_social_income_payout_by_id"
  end
  # resource path
  local_var_path = "/v1/social/income/payouts/{id}".sub("{" + "id" + "}", CGI.escape(id.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] || "CommercePayout1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_get_social_income_payouts(payout_from_date, payout_to_date, account_id, opts = {}) ⇒ CommercePayoutList1

Retrieve social payouts for an account Lists all payouts of the given social account. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "social".

Parameters:

  • payout_from_date (Date) —

    Return payouts on or after this date. (YYYY-MM-DD)

  • payout_to_date (Date) —

    Return payouts on or before this date. (YYYY-MM-DD)

  • account_id (String) —

    Unique ID of the connected account.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:



861
862
863
864
 
# File 'lib/phyllo/api/income_api.rb', line 861

def v1_get_social_income_payouts(payout_from_date, payout_to_date, , opts = {})
  data, _status_code, _headers = v1_get_social_income_payouts_with_http_info(payout_from_date, payout_to_date, , opts)
  data
end

#v1_get_social_income_payouts_with_http_info(payout_from_date, payout_to_date, account_id, opts = {}) ⇒ Array<(CommercePayoutList1, Integer, Hash)>

Retrieve social payouts for an account Lists all payouts of the given social account. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;social&quot;.

Parameters:

  • payout_from_date (Date) —

    Return payouts on or after this date. (YYYY-MM-DD)

  • payout_to_date (Date) —

    Return payouts on or before this date. (YYYY-MM-DD)

  • account_id (String) —

    Unique ID of the connected account.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:

  • (Array<(CommercePayoutList1, Integer, Hash)>) —

    CommercePayoutList1 data, response status code and response headers



875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'lib/phyllo/api/income_api.rb', line 875

def v1_get_social_income_payouts_with_http_info(payout_from_date, payout_to_date, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_get_social_income_payouts ..."
  end
  # verify the required parameter 'payout_from_date' is set
  if @api_client.config.client_side_validation && payout_from_date.nil?
    fail ArgumentError, "Missing the required parameter 'payout_from_date' when calling IncomeApi.v1_get_social_income_payouts"
  end
  # verify the required parameter 'payout_to_date' is set
  if @api_client.config.client_side_validation && payout_to_date.nil?
    fail ArgumentError, "Missing the required parameter 'payout_to_date' when calling IncomeApi.v1_get_social_income_payouts"
  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 IncomeApi.v1_get_social_income_payouts"
  end
  # resource path
  local_var_path = "/v1/social/income/payouts"

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:payout_from_date] = payout_from_date
  query_params[:payout_to_date] = payout_to_date
  query_params[:account_id] = 
  query_params[:limit] = opts[:limit] if !opts[:limit].nil?
  query_params[:offset] = opts[:offset] if !opts[:offset].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] || "CommercePayoutList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_get_social_income_transaction_by_id(id, opts = {}) ⇒ SocialTransaction1

Retrieve a social transaction Retrieve the information of the transaction with the supplied transaction ID. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "social".

Parameters:

  • id (String) —

    Unique identifier for the transaction

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

    the optional parameters

Returns:



941
942
943
944
 
# File 'lib/phyllo/api/income_api.rb', line 941

def v1_get_social_income_transaction_by_id(id, opts = {})
  data, _status_code, _headers = v1_get_social_income_transaction_by_id_with_http_info(id, opts)
  data
end

#v1_get_social_income_transaction_by_id_with_http_info(id, opts = {}) ⇒ Array<(SocialTransaction1, Integer, Hash)>

Retrieve a social transaction Retrieve the information of the transaction with the supplied transaction ID. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;social&quot;.

Parameters:

  • id (String) —

    Unique identifier for the transaction

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

    the optional parameters

Returns:

  • (Array<(SocialTransaction1, Integer, Hash)>) —

    SocialTransaction1 data, response status code and response headers



951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/phyllo/api/income_api.rb', line 951

def v1_get_social_income_transaction_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_get_social_income_transaction_by_id ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IncomeApi.v1_get_social_income_transaction_by_id"
  end
  # resource path
  local_var_path = "/v1/social/income/transactions/{id}".sub("{" + "id" + "}", CGI.escape(id.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] || "SocialTransaction1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_get_social_income_transactions(transaction_from_date, transaction_to_date, account_id, opts = {}) ⇒ SocialTransactionList1

Retrieve social transactions for an account Lists all transactions of the given social account. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "social".

Parameters:

  • transaction_from_date (Date) —

    Return transactions on or after this date. (YYYY-MM-DD)

  • transaction_to_date (Date) —

    Return transactions on or before this date. (YYYY-MM-DD)

  • account_id (String) —

    Unique ID of the connected account.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Type of transaction on the social platform

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:



1009
1010
1011
1012
 
# File 'lib/phyllo/api/income_api.rb', line 1009

def v1_get_social_income_transactions(transaction_from_date, transaction_to_date, , opts = {})
  data, _status_code, _headers = v1_get_social_income_transactions_with_http_info(transaction_from_date, transaction_to_date, , opts)
  data
end

#v1_get_social_income_transactions_with_http_info(transaction_from_date, transaction_to_date, account_id, opts = {}) ⇒ Array<(SocialTransactionList1, Integer, Hash)>

Retrieve social transactions for an account Lists all transactions of the given social account. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;social&quot;.

Parameters:

  • transaction_from_date (Date) —

    Return transactions on or after this date. (YYYY-MM-DD)

  • transaction_to_date (Date) —

    Return transactions on or before this date. (YYYY-MM-DD)

  • account_id (String) —

    Unique ID of the connected account.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Type of transaction on the social platform

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:

  • (Array<(SocialTransactionList1, Integer, Hash)>) —

    SocialTransactionList1 data, response status code and response headers



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/phyllo/api/income_api.rb', line 1024

def v1_get_social_income_transactions_with_http_info(transaction_from_date, transaction_to_date, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_get_social_income_transactions ..."
  end
  # verify the required parameter 'transaction_from_date' is set
  if @api_client.config.client_side_validation && transaction_from_date.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_from_date' when calling IncomeApi.v1_get_social_income_transactions"
  end
  # verify the required parameter 'transaction_to_date' is set
  if @api_client.config.client_side_validation && transaction_to_date.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_to_date' when calling IncomeApi.v1_get_social_income_transactions"
  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 IncomeApi.v1_get_social_income_transactions"
  end
  allowable_values = ["AD", "SUBSCRIPTION", "ADDITIONAL"]
  if @api_client.config.client_side_validation && opts[:type] && !allowable_values.include?(opts[:type])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = "/v1/social/income/transactions"

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:transaction_from_date] = transaction_from_date
  query_params[:transaction_to_date] = transaction_to_date
  query_params[:account_id] = 
  query_params[:type] = opts[:type] if !opts[:type].nil?
  query_params[:limit] = opts[:limit] if !opts[:limit].nil?
  query_params[:offset] = opts[:offset] if !opts[:offset].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] || "SocialTransactionList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_refresh_commerce_income_balances(opts = {}) ⇒ Refresh1

Refresh e-commerce balances for an account Refresh balances for a connected e-commerce account for the default refresh period, which is T-12 months for balances. Once Phyllo processes the request, you can fetch the updated balances by calling the [retrieve e-commerce balances API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1balances/get). Subscribe to the "BALANCES.ADDED" and "BALANCES.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce balances in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1balances~1search/post) for optimal performance. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1095
1096
1097
1098
 
# File 'lib/phyllo/api/income_api.rb', line 1095

def v1_refresh_commerce_income_balances(opts = {})
  data, _status_code, _headers = v1_refresh_commerce_income_balances_with_http_info(opts)
  data
end

#v1_refresh_commerce_income_balances_with_http_info(opts = {}) ⇒ Array<(Refresh1, Integer, Hash)>

Refresh e-commerce balances for an account Refresh balances for a connected e-commerce account for the default refresh period, which is T-12 months for balances. Once Phyllo processes the request, you can fetch the updated balances by calling the [retrieve e-commerce balances API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1balances/get). Subscribe to the &quot;BALANCES.ADDED&quot; and &quot;BALANCES.UPDATED&quot; webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce balances in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1balances~1search/post) for optimal performance. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Refresh1, Integer, Hash)>) —

    Refresh1 data, response status code and response headers



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'lib/phyllo/api/income_api.rb', line 1105

def v1_refresh_commerce_income_balances_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_refresh_commerce_income_balances ..."
  end
  # resource path
  local_var_path = "/v1/commerce/income/balances/refresh"

  # 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(opts[:refresh1])

  # return_type
  return_type = opts[:debug_return_type] || "Refresh1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_refresh_commerce_income_payouts(opts = {}) ⇒ Refresh1

Refresh e-commerce payouts for an account Refresh payouts for a connected e-commerce account for the default refresh period, which is T-12 months for payouts. Once Phyllo processes the request, you can fetch the updated payouts by calling the [retrieve e-commerce payouts API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1payouts/get). Subscribe to the "PAYOUTS.ADDED" and "PAYOUTS.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce payouts in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1payouts~1search/post) for optimal performance. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1159
1160
1161
1162
 
# File 'lib/phyllo/api/income_api.rb', line 1159

def v1_refresh_commerce_income_payouts(opts = {})
  data, _status_code, _headers = v1_refresh_commerce_income_payouts_with_http_info(opts)
  data
end

#v1_refresh_commerce_income_payouts_with_http_info(opts = {}) ⇒ Array<(Refresh1, Integer, Hash)>

Refresh e-commerce payouts for an account Refresh payouts for a connected e-commerce account for the default refresh period, which is T-12 months for payouts. Once Phyllo processes the request, you can fetch the updated payouts by calling the [retrieve e-commerce payouts API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1payouts/get). Subscribe to the &quot;PAYOUTS.ADDED&quot; and &quot;PAYOUTS.UPDATED&quot; webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce payouts in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1payouts~1search/post) for optimal performance. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Refresh1, Integer, Hash)>) —

    Refresh1 data, response status code and response headers



1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/phyllo/api/income_api.rb', line 1169

def v1_refresh_commerce_income_payouts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_refresh_commerce_income_payouts ..."
  end
  # resource path
  local_var_path = "/v1/commerce/income/payouts/refresh"

  # 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(opts[:refresh1])

  # return_type
  return_type = opts[:debug_return_type] || "Refresh1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_refresh_commerce_income_transactions(opts = {}) ⇒ Refresh1

Refresh e-commerce transactions for an account Refresh transactions for a connected e-commerce account for the default refresh period, which is T-12 months for transactions. Once Phyllo processes the request, you can fetch the updated transactions by calling the [retrieve e-commerce transactions API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1transactions/get). Subscribe to the "TRANSACTIONS.ADDED" and "TRANSACTIONS.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce transactions in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1transactions~1search/post) for optimal performance. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1223
1224
1225
1226
 
# File 'lib/phyllo/api/income_api.rb', line 1223

def v1_refresh_commerce_income_transactions(opts = {})
  data, _status_code, _headers = v1_refresh_commerce_income_transactions_with_http_info(opts)
  data
end

#v1_refresh_commerce_income_transactions_with_http_info(opts = {}) ⇒ Array<(Refresh1, Integer, Hash)>

Refresh e-commerce transactions for an account Refresh transactions for a connected e-commerce account for the default refresh period, which is T-12 months for transactions. Once Phyllo processes the request, you can fetch the updated transactions by calling the [retrieve e-commerce transactions API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1transactions/get). Subscribe to the &quot;TRANSACTIONS.ADDED&quot; and &quot;TRANSACTIONS.UPDATED&quot; webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve e-commerce transactions in bulk API](../reference/openapi.v1.yml/paths/~1v1~1commerce~1income~1transactions~1search/post) for optimal performance. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Refresh1, Integer, Hash)>) —

    Refresh1 data, response status code and response headers



1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
 
# File 'lib/phyllo/api/income_api.rb', line 1233

def v1_refresh_commerce_income_transactions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_refresh_commerce_income_transactions ..."
  end
  # resource path
  local_var_path = "/v1/commerce/income/transactions/refresh"

  # 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(opts[:refresh1])

  # return_type
  return_type = opts[:debug_return_type] || "Refresh1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_refresh_social_income_payouts(opts = {}) ⇒ Refresh1

Refresh social payouts for an account Refresh payouts for a connected social account for the default refresh period, which is T-12 months for payouts. Once Phyllo processes the request, you can fetch the updated payouts by calling the [retrieve social payouts API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1payouts/get). Subscribe to the "PAYOUTS.ADDED" and "PAYOUTS.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve social payouts in bulk API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1payouts~1search/post) for optimal performance. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "social".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1287
1288
1289
1290
 
# File 'lib/phyllo/api/income_api.rb', line 1287

def v1_refresh_social_income_payouts(opts = {})
  data, _status_code, _headers = v1_refresh_social_income_payouts_with_http_info(opts)
  data
end

#v1_refresh_social_income_payouts_with_http_info(opts = {}) ⇒ Array<(Refresh1, Integer, Hash)>

Refresh social payouts for an account Refresh payouts for a connected social account for the default refresh period, which is T-12 months for payouts. Once Phyllo processes the request, you can fetch the updated payouts by calling the [retrieve social payouts API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1payouts/get). Subscribe to the &quot;PAYOUTS.ADDED&quot; and &quot;PAYOUTS.UPDATED&quot; webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve social payouts in bulk API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1payouts~1search/post) for optimal performance. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;social&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Refresh1, Integer, Hash)>) —

    Refresh1 data, response status code and response headers



1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'lib/phyllo/api/income_api.rb', line 1297

def v1_refresh_social_income_payouts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_refresh_social_income_payouts ..."
  end
  # resource path
  local_var_path = "/v1/social/income/payouts/refresh"

  # 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(opts[:refresh1])

  # return_type
  return_type = opts[:debug_return_type] || "Refresh1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_refresh_social_income_transactions(opts = {}) ⇒ Refresh1

Refresh social transactions for an account Refresh transactions for a connected social account for the default refresh period, which is T-12 months for transactions. Once Phyllo processes the request, you can fetch the updated transactions by calling the [retrieve social transactions API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1transactions/get). Subscribe to the "TRANSACTIONS.ADDED" and "TRANSACTIONS.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve social transactions in bulk API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1transactions~1search/post) for optimal performance. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "social".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1351
1352
1353
1354
 
# File 'lib/phyllo/api/income_api.rb', line 1351

def v1_refresh_social_income_transactions(opts = {})
  data, _status_code, _headers = v1_refresh_social_income_transactions_with_http_info(opts)
  data
end

#v1_refresh_social_income_transactions_with_http_info(opts = {}) ⇒ Array<(Refresh1, Integer, Hash)>

Refresh social transactions for an account Refresh transactions for a connected social account for the default refresh period, which is T-12 months for transactions. Once Phyllo processes the request, you can fetch the updated transactions by calling the [retrieve social transactions API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1transactions/get). Subscribe to the &quot;TRANSACTIONS.ADDED&quot; and &quot;TRANSACTIONS.UPDATED&quot; webhooks to receive a notification once the request is completed. With webhooks, you should use the [retrieve social transactions in bulk API](../reference/openapi.v1.yml/paths/~1v1~1social~1income~1transactions~1search/post) for optimal performance. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;social&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Refresh1, Integer, Hash)>) —

    Refresh1 data, response status code and response headers



1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'lib/phyllo/api/income_api.rb', line 1361

def v1_refresh_social_income_transactions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_refresh_social_income_transactions ..."
  end
  # resource path
  local_var_path = "/v1/social/income/transactions/refresh"

  # 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(opts[:refresh1])

  # return_type
  return_type = opts[:debug_return_type] || "Refresh1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_search_commerce_income_balances(opts = {}) ⇒ CommerceBalanceSearchList1

Retrieve e-commerce balances in bulk Search balances in bulk by providing the IDs. This is best used in combination with webhooks - you can directly take the IDs from "BALANCES.ADDED" and "BALANCES.UPDATED" webhook notifications and pass on to this API to get the updated transaction items. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1415
1416
1417
1418
 
# File 'lib/phyllo/api/income_api.rb', line 1415

def v1_search_commerce_income_balances(opts = {})
  data, _status_code, _headers = v1_search_commerce_income_balances_with_http_info(opts)
  data
end

#v1_search_commerce_income_balances_with_http_info(opts = {}) ⇒ Array<(CommerceBalanceSearchList1, Integer, Hash)>

Retrieve e-commerce balances in bulk Search balances in bulk by providing the IDs. This is best used in combination with webhooks - you can directly take the IDs from &quot;BALANCES.ADDED&quot; and &quot;BALANCES.UPDATED&quot; webhook notifications and pass on to this API to get the updated transaction items. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(CommerceBalanceSearchList1, Integer, Hash)>) —

    CommerceBalanceSearchList1 data, response status code and response headers



1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/phyllo/api/income_api.rb', line 1425

def v1_search_commerce_income_balances_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_search_commerce_income_balances ..."
  end
  # resource path
  local_var_path = "/v1/commerce/income/balances/search"

  # 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(opts[:commerce_balance_search1])

  # return_type
  return_type = opts[:debug_return_type] || "CommerceBalanceSearchList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_search_commerce_income_payouts(opts = {}) ⇒ CommercePayoutSearchList1

Retrieve e-commerce payouts in bulk Search payouts in bulk by providing the IDs. This is best used in combination with webhooks - you can directly take the IDs from "PAYOUTS.ADDED" and "PAYOUTS.UPDATED" webhook notifications and pass on to this API to get the updated payout items. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1479
1480
1481
1482
 
# File 'lib/phyllo/api/income_api.rb', line 1479

def v1_search_commerce_income_payouts(opts = {})
  data, _status_code, _headers = v1_search_commerce_income_payouts_with_http_info(opts)
  data
end

#v1_search_commerce_income_payouts_with_http_info(opts = {}) ⇒ Array<(CommercePayoutSearchList1, Integer, Hash)>

Retrieve e-commerce payouts in bulk Search payouts in bulk by providing the IDs. This is best used in combination with webhooks - you can directly take the IDs from &quot;PAYOUTS.ADDED&quot; and &quot;PAYOUTS.UPDATED&quot; webhook notifications and pass on to this API to get the updated payout items. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(CommercePayoutSearchList1, Integer, Hash)>) —

    CommercePayoutSearchList1 data, response status code and response headers



1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
 
# File 'lib/phyllo/api/income_api.rb', line 1489

def v1_search_commerce_income_payouts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_search_commerce_income_payouts ..."
  end
  # resource path
  local_var_path = "/v1/commerce/income/payouts/search"

  # 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(opts[:commerce_payout_search1])

  # return_type
  return_type = opts[:debug_return_type] || "CommercePayoutSearchList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_search_commerce_income_transactions(opts = {}) ⇒ CommerceTransactionSearchList1

Retrieve e-commerce transactions in bulk Search transactions in bulk by providing the IDs. This is best used in combination with webhooks - you can directly take the IDs from "TRANSACTIONS.ADDED" and "TRANSACTIONS.UPDATED" webhook notifications and pass on to this API to get the updated transaction items. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "commerce".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1543
1544
1545
1546
 
# File 'lib/phyllo/api/income_api.rb', line 1543

def v1_search_commerce_income_transactions(opts = {})
  data, _status_code, _headers = v1_search_commerce_income_transactions_with_http_info(opts)
  data
end

#v1_search_commerce_income_transactions_with_http_info(opts = {}) ⇒ Array<(CommerceTransactionSearchList1, Integer, Hash)>

Retrieve e-commerce transactions in bulk Search transactions in bulk by providing the IDs. This is best used in combination with webhooks - you can directly take the IDs from &quot;TRANSACTIONS.ADDED&quot; and &quot;TRANSACTIONS.UPDATED&quot; webhook notifications and pass on to this API to get the updated transaction items. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;commerce&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/phyllo/api/income_api.rb', line 1553

def v1_search_commerce_income_transactions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_search_commerce_income_transactions ..."
  end
  # resource path
  local_var_path = "/v1/commerce/income/transactions/search"

  # 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(opts[:commerce_transaction_search1])

  # return_type
  return_type = opts[:debug_return_type] || "CommerceTransactionSearchList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_search_social_income_payouts(opts = {}) ⇒ CommercePayoutSearchList1

Retrieve social payouts in bulk Search payouts in bulk by providing the IDs. This is best used in combination with webhooks - you can directly take the IDs from "PAYOUTS.ADDED" and "PAYOUTS.UPDATED" webhook notifications and pass on to this API to get the updated payout items. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "social".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1607
1608
1609
1610
 
# File 'lib/phyllo/api/income_api.rb', line 1607

def v1_search_social_income_payouts(opts = {})
  data, _status_code, _headers = v1_search_social_income_payouts_with_http_info(opts)
  data
end

#v1_search_social_income_payouts_with_http_info(opts = {}) ⇒ Array<(CommercePayoutSearchList1, Integer, Hash)>

Retrieve social payouts in bulk Search payouts in bulk by providing the IDs. This is best used in combination with webhooks - you can directly take the IDs from &quot;PAYOUTS.ADDED&quot; and &quot;PAYOUTS.UPDATED&quot; webhook notifications and pass on to this API to get the updated payout items. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;social&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(CommercePayoutSearchList1, Integer, Hash)>) —

    CommercePayoutSearchList1 data, response status code and response headers



1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
 
# File 'lib/phyllo/api/income_api.rb', line 1617

def v1_search_social_income_payouts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_search_social_income_payouts ..."
  end
  # resource path
  local_var_path = "/v1/social/income/payouts/search"

  # 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(opts[:commerce_payout_search1])

  # return_type
  return_type = opts[:debug_return_type] || "CommercePayoutSearchList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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

#v1_search_social_income_transactions(opts = {}) ⇒ SocialTransactionSearchList1

Retrieve social transactions in bulk Search transactions in bulk by providing the IDs. This is best used in combination with webhooks - you can directly take the IDs from "TRANSACTIONS.ADDED" and "TRANSACTIONS.UPDATED" webhook notifications and pass on to this API to get the updated transaction items. Check the ‘category` field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the "Category" column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under "social".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1671
1672
1673
1674
 
# File 'lib/phyllo/api/income_api.rb', line 1671

def v1_search_social_income_transactions(opts = {})
  data, _status_code, _headers = v1_search_social_income_transactions_with_http_info(opts)
  data
end

#v1_search_social_income_transactions_with_http_info(opts = {}) ⇒ Array<(SocialTransactionSearchList1, Integer, Hash)>

Retrieve social transactions in bulk Search transactions in bulk by providing the IDs. This is best used in combination with webhooks - you can directly take the IDs from &quot;TRANSACTIONS.ADDED&quot; and &quot;TRANSACTIONS.UPDATED&quot; webhook notifications and pass on to this API to get the updated transaction items. Check the &#x60;category&#x60; field from [the work platform API](../reference/openapi.v1.yml/paths/~1v1~1work-platforms/get) response or the &quot;Category&quot; column in [this data guide](airtable.com/shrwEMTWlgECOUhre) to see which platfroms we serve under &quot;social&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
 
# File 'lib/phyllo/api/income_api.rb', line 1681

def v1_search_social_income_transactions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncomeApi.v1_search_social_income_transactions ..."
  end
  # resource path
  local_var_path = "/v1/social/income/transactions/search"

  # 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(opts[:social_transaction_search1])

  # return_type
  return_type = opts[:debug_return_type] || "SocialTransactionSearchList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

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