tremendous_ruby 6.0.0 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/tremendous/api/tremendous_api.rb +6 -70
- data/lib/tremendous/models/connected_organization_organization.rb +12 -1
- data/lib/tremendous/models/create_organization.rb +11 -1
- data/lib/tremendous/models/create_organization200_response_organization.rb +12 -1
- data/lib/tremendous/models/create_organization_for_response.rb +12 -1
- data/lib/tremendous/models/create_organization_properties.rb +11 -1
- data/lib/tremendous/models/create_organization_request.rb +14 -4
- data/lib/tremendous/models/create_organization_response_organization.rb +12 -1
- data/lib/tremendous/models/create_report_request.rb +12 -1
- data/lib/tremendous/models/list_connected_organizations200_response_connected_organizations_inner_organization.rb +12 -1
- data/lib/tremendous/models/list_organizations200_response_organizations_inner.rb +12 -1
- data/lib/tremendous/models/list_products_response_products_inner.rb +2 -2
- data/lib/tremendous/models/organization.rb +12 -1
- data/lib/tremendous/models/organization_response_organization.rb +12 -1
- data/lib/tremendous/models/product.rb +2 -2
- data/lib/tremendous/version.rb +1 -1
- data/lib/tremendous.rb +0 -2
- metadata +1 -3
- data/lib/tremendous/models/create_api_key200_response.rb +0 -148
- data/lib/tremendous/models/create_api_key_request.rb +0 -182
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 988c7aaf4e50ce1ab20747e6e74dfb3d60d0b412eb3bb7998b3aa30fcf8b088e
|
|
4
|
+
data.tar.gz: 5bbaa25155a21a78024b53e90e6744c8bbd4f295d84580bbc0b0d146d97dfd37
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ad0aa396ea3ff3d04ee469a72aa552f4dd4e82e852252f5834be81e9ef4daadc6461f42dd0d41c37de38dfd34e4731e0d7ca912cdb124662cd9954e39e64d609
|
|
7
|
+
data.tar.gz: 38479d9feeb97e22387fc6583cb93ddbd0cd9c4fcc57bb4be923ec025ec61fa4462f7dcba08086db8c669b7b4d4ce460825b28dc98d8cd223463e161a73a5a4f
|
|
@@ -218,70 +218,6 @@ module Tremendous
|
|
|
218
218
|
return data, status_code, headers
|
|
219
219
|
end
|
|
220
220
|
|
|
221
|
-
# Create API key
|
|
222
|
-
# Creates a new API key. The API key used to make the request will remain active. Created API keys are generated randomly and returned in the response. **You cannot retrieve them again.**
|
|
223
|
-
# @param [Hash] opts the optional parameters
|
|
224
|
-
# @option opts [CreateApiKeyRequest] :create_api_key_request Optional settings for the new API key
|
|
225
|
-
# @return [CreateApiKey200Response]
|
|
226
|
-
def create_api_key(opts = {})
|
|
227
|
-
data, _status_code, _headers = create_api_key_with_http_info(opts)
|
|
228
|
-
data
|
|
229
|
-
end
|
|
230
|
-
|
|
231
|
-
# Create API key
|
|
232
|
-
# Creates a new API key. The API key used to make the request will remain active. Created API keys are generated randomly and returned in the response. **You cannot retrieve them again.**
|
|
233
|
-
# @param [Hash] opts the optional parameters
|
|
234
|
-
# @option opts [CreateApiKeyRequest] :create_api_key_request Optional settings for the new API key
|
|
235
|
-
# @return [Array<(CreateApiKey200Response, Integer, Hash)>] CreateApiKey200Response data, response status code and response headers
|
|
236
|
-
def create_api_key_with_http_info(opts = {})
|
|
237
|
-
if @api_client.config.debugging
|
|
238
|
-
@api_client.config.logger.debug 'Calling API: TremendousApi.create_api_key ...'
|
|
239
|
-
end
|
|
240
|
-
# resource path
|
|
241
|
-
local_var_path = '/organizations/create_api_key'
|
|
242
|
-
|
|
243
|
-
# query parameters
|
|
244
|
-
query_params = opts[:query_params] || {}
|
|
245
|
-
|
|
246
|
-
# header parameters
|
|
247
|
-
header_params = opts[:header_params] || {}
|
|
248
|
-
# HTTP header 'Accept' (if needed)
|
|
249
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
250
|
-
# HTTP header 'Content-Type'
|
|
251
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
252
|
-
if !content_type.nil?
|
|
253
|
-
header_params['Content-Type'] = content_type
|
|
254
|
-
end
|
|
255
|
-
|
|
256
|
-
# form parameters
|
|
257
|
-
form_params = opts[:form_params] || {}
|
|
258
|
-
|
|
259
|
-
# http body (model)
|
|
260
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_api_key_request'])
|
|
261
|
-
|
|
262
|
-
# return_type
|
|
263
|
-
return_type = opts[:debug_return_type] || 'CreateApiKey200Response'
|
|
264
|
-
|
|
265
|
-
# auth_names
|
|
266
|
-
auth_names = opts[:debug_auth_names] || ['BearerApiKey']
|
|
267
|
-
|
|
268
|
-
new_options = opts.merge(
|
|
269
|
-
:operation => :"TremendousApi.create_api_key",
|
|
270
|
-
:header_params => header_params,
|
|
271
|
-
:query_params => query_params,
|
|
272
|
-
:form_params => form_params,
|
|
273
|
-
:body => post_body,
|
|
274
|
-
:auth_names => auth_names,
|
|
275
|
-
:return_type => return_type
|
|
276
|
-
)
|
|
277
|
-
|
|
278
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
279
|
-
if @api_client.config.debugging
|
|
280
|
-
@api_client.config.logger.debug "API called: TremendousApi#create_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
281
|
-
end
|
|
282
|
-
return data, status_code, headers
|
|
283
|
-
end
|
|
284
|
-
|
|
285
221
|
# Create campaign
|
|
286
222
|
# @param create_campaign_request [CreateCampaignRequest] Campaign details
|
|
287
223
|
# @param [Hash] opts the optional parameters
|
|
@@ -695,7 +631,7 @@ module Tremendous
|
|
|
695
631
|
end
|
|
696
632
|
|
|
697
633
|
# Create member
|
|
698
|
-
# Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-
|
|
634
|
+
# Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organization, use an API key for that organization. You can create one in the Tremendous dashboard. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead.
|
|
699
635
|
# @param create_member_request [CreateMemberRequest] Member details
|
|
700
636
|
# @param [Hash] opts the optional parameters
|
|
701
637
|
# @return [CreateMember200Response]
|
|
@@ -705,7 +641,7 @@ module Tremendous
|
|
|
705
641
|
end
|
|
706
642
|
|
|
707
643
|
# Create member
|
|
708
|
-
# Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-
|
|
644
|
+
# Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organization, use an API key for that organization. You can create one in the Tremendous dashboard. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead.
|
|
709
645
|
# @param create_member_request [CreateMemberRequest] Member details
|
|
710
646
|
# @param [Hash] opts the optional parameters
|
|
711
647
|
# @return [Array<(CreateMember200Response, Integer, Hash)>] CreateMember200Response data, response status code and response headers
|
|
@@ -899,7 +835,7 @@ module Tremendous
|
|
|
899
835
|
end
|
|
900
836
|
|
|
901
837
|
# Create report
|
|
902
|
-
# Creating a report allows your organization to programmatically retrieve information that's available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you'll receive a `429` response.
|
|
838
|
+
# Creating a report allows your organization to programmatically retrieve information that's available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. Pass `timezone` to interpret date filters and render timestamps in a specific time zone. Reports created through the API default to UTC and never use your organization's dashboard time zone. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">timezone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Time zone used to interpret date filters and display timestamps in the generated report. Accepts IANA time zone identifiers such as America/New_York or Europe/London, and UTC. Aliases such as US/Eastern are accepted and normalized to their canonical identifier (America/New_York). Defaults to UTC when omitted, null, or blank. Reports created through the API do not inherit your organization's dashboard time zone.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you'll receive a `429` response.
|
|
903
839
|
# @param create_report_request [CreateReportRequest] Report to create
|
|
904
840
|
# @param [Hash] opts the optional parameters
|
|
905
841
|
# @return [CreateReport200Response]
|
|
@@ -909,7 +845,7 @@ module Tremendous
|
|
|
909
845
|
end
|
|
910
846
|
|
|
911
847
|
# Create report
|
|
912
|
-
# Creating a report allows your organization to programmatically retrieve information that's available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you'll receive a `429` response.
|
|
848
|
+
# Creating a report allows your organization to programmatically retrieve information that's available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. Pass `timezone` to interpret date filters and render timestamps in a specific time zone. Reports created through the API default to UTC and never use your organization's dashboard time zone. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">timezone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Time zone used to interpret date filters and display timestamps in the generated report. Accepts IANA time zone identifiers such as America/New_York or Europe/London, and UTC. Aliases such as US/Eastern are accepted and normalized to their canonical identifier (America/New_York). Defaults to UTC when omitted, null, or blank. Reports created through the API do not inherit your organization&#39;s dashboard time zone.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you'll receive a `429` response.
|
|
913
849
|
# @param create_report_request [CreateReportRequest] Report to create
|
|
914
850
|
# @param [Hash] opts the optional parameters
|
|
915
851
|
# @return [Array<(CreateReport200Response, Integer, Hash)>] CreateReport200Response data, response status code and response headers
|
|
@@ -3324,7 +3260,7 @@ module Tremendous
|
|
|
3324
3260
|
end
|
|
3325
3261
|
|
|
3326
3262
|
# List members
|
|
3327
|
-
# To list members of a sub-organization
|
|
3263
|
+
# To list members of a sub-organization, use an API key for that organization. You can create one in the Tremendous dashboard.
|
|
3328
3264
|
# @param [Hash] opts the optional parameters
|
|
3329
3265
|
# @return [ListMembers200Response]
|
|
3330
3266
|
def list_members(opts = {})
|
|
@@ -3333,7 +3269,7 @@ module Tremendous
|
|
|
3333
3269
|
end
|
|
3334
3270
|
|
|
3335
3271
|
# List members
|
|
3336
|
-
# To list members of a sub-organization
|
|
3272
|
+
# To list members of a sub-organization, use an API key for that organization. You can create one in the Tremendous dashboard.
|
|
3337
3273
|
# @param [Hash] opts the optional parameters
|
|
3338
3274
|
# @return [Array<(ListMembers200Response, Integer, Hash)>] ListMembers200Response data, response status code and response headers
|
|
3339
3275
|
def list_members_with_http_info(opts = {})
|
|
@@ -27,6 +27,9 @@ module Tremendous
|
|
|
27
27
|
# Currency used for this organization's balances, orders, and transactions.
|
|
28
28
|
attr_accessor :currency_code
|
|
29
29
|
|
|
30
|
+
# The organization's time zone as a canonical IANA identifier. Returns `null` if not configured.
|
|
31
|
+
attr_accessor :timezone
|
|
32
|
+
|
|
30
33
|
# Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
|
|
31
34
|
attr_accessor :status
|
|
32
35
|
|
|
@@ -62,6 +65,7 @@ module Tremendous
|
|
|
62
65
|
:'name' => :'name',
|
|
63
66
|
:'website' => :'website',
|
|
64
67
|
:'currency_code' => :'currency_code',
|
|
68
|
+
:'timezone' => :'timezone',
|
|
65
69
|
:'status' => :'status',
|
|
66
70
|
:'created_at' => :'created_at'
|
|
67
71
|
}
|
|
@@ -84,6 +88,7 @@ module Tremendous
|
|
|
84
88
|
:'name' => :'String',
|
|
85
89
|
:'website' => :'String',
|
|
86
90
|
:'currency_code' => :'String',
|
|
91
|
+
:'timezone' => :'String',
|
|
87
92
|
:'status' => :'String',
|
|
88
93
|
:'created_at' => :'Date'
|
|
89
94
|
}
|
|
@@ -92,6 +97,7 @@ module Tremendous
|
|
|
92
97
|
# List of attributes with nullable: true
|
|
93
98
|
def self.openapi_nullable
|
|
94
99
|
Set.new([
|
|
100
|
+
:'timezone',
|
|
95
101
|
])
|
|
96
102
|
end
|
|
97
103
|
|
|
@@ -131,6 +137,10 @@ module Tremendous
|
|
|
131
137
|
self.currency_code = attributes[:'currency_code']
|
|
132
138
|
end
|
|
133
139
|
|
|
140
|
+
if attributes.key?(:'timezone')
|
|
141
|
+
self.timezone = attributes[:'timezone']
|
|
142
|
+
end
|
|
143
|
+
|
|
134
144
|
if attributes.key?(:'status')
|
|
135
145
|
self.status = attributes[:'status']
|
|
136
146
|
end
|
|
@@ -225,6 +235,7 @@ module Tremendous
|
|
|
225
235
|
name == o.name &&
|
|
226
236
|
website == o.website &&
|
|
227
237
|
currency_code == o.currency_code &&
|
|
238
|
+
timezone == o.timezone &&
|
|
228
239
|
status == o.status &&
|
|
229
240
|
created_at == o.created_at
|
|
230
241
|
end
|
|
@@ -238,7 +249,7 @@ module Tremendous
|
|
|
238
249
|
# Calculates hash code according to all attributes.
|
|
239
250
|
# @return [Integer] Hash code
|
|
240
251
|
def hash
|
|
241
|
-
[id, name, website, currency_code, status, created_at].hash
|
|
252
|
+
[id, name, website, currency_code, timezone, status, created_at].hash
|
|
242
253
|
end
|
|
243
254
|
|
|
244
255
|
# Builds the object from hash
|
|
@@ -34,6 +34,9 @@ module Tremendous
|
|
|
34
34
|
# Currency code for the new organization. Defaults to the current organization's currency if not provided.
|
|
35
35
|
attr_accessor :currency_code
|
|
36
36
|
|
|
37
|
+
# IANA time zone identifier for the new organization, such as America/New_York or Europe/London. Aliases such as US/Eastern are accepted and converted to their canonical identifier (America/New_York). Defaults to the time zone of the organization associated with the API key used for the request if omitted or blank. If that organization has no time zone, the new organization remains unset.
|
|
38
|
+
attr_accessor :timezone
|
|
39
|
+
|
|
37
40
|
# Timestamp of when the organization has been created.
|
|
38
41
|
attr_accessor :created_at
|
|
39
42
|
|
|
@@ -47,6 +50,7 @@ module Tremendous
|
|
|
47
50
|
:'copy_settings' => :'copy_settings',
|
|
48
51
|
:'phone' => :'phone',
|
|
49
52
|
:'currency_code' => :'currency_code',
|
|
53
|
+
:'timezone' => :'timezone',
|
|
50
54
|
:'created_at' => :'created_at'
|
|
51
55
|
}
|
|
52
56
|
end
|
|
@@ -71,6 +75,7 @@ module Tremendous
|
|
|
71
75
|
:'copy_settings' => :'CreateOrganizationRequestCopySettings',
|
|
72
76
|
:'phone' => :'String',
|
|
73
77
|
:'currency_code' => :'String',
|
|
78
|
+
:'timezone' => :'String',
|
|
74
79
|
:'created_at' => :'Date'
|
|
75
80
|
}
|
|
76
81
|
end
|
|
@@ -131,6 +136,10 @@ module Tremendous
|
|
|
131
136
|
self.currency_code = attributes[:'currency_code']
|
|
132
137
|
end
|
|
133
138
|
|
|
139
|
+
if attributes.key?(:'timezone')
|
|
140
|
+
self.timezone = attributes[:'timezone']
|
|
141
|
+
end
|
|
142
|
+
|
|
134
143
|
if attributes.key?(:'created_at')
|
|
135
144
|
self.created_at = attributes[:'created_at']
|
|
136
145
|
end
|
|
@@ -229,6 +238,7 @@ module Tremendous
|
|
|
229
238
|
copy_settings == o.copy_settings &&
|
|
230
239
|
phone == o.phone &&
|
|
231
240
|
currency_code == o.currency_code &&
|
|
241
|
+
timezone == o.timezone &&
|
|
232
242
|
created_at == o.created_at
|
|
233
243
|
end
|
|
234
244
|
|
|
@@ -241,7 +251,7 @@ module Tremendous
|
|
|
241
251
|
# Calculates hash code according to all attributes.
|
|
242
252
|
# @return [Integer] Hash code
|
|
243
253
|
def hash
|
|
244
|
-
[id, name, website, with_api_key, copy_settings, phone, currency_code, created_at].hash
|
|
254
|
+
[id, name, website, with_api_key, copy_settings, phone, currency_code, timezone, created_at].hash
|
|
245
255
|
end
|
|
246
256
|
|
|
247
257
|
# Builds the object from hash
|
|
@@ -31,6 +31,9 @@ module Tremendous
|
|
|
31
31
|
# Currency code for the new organization. Defaults to the current organization's currency if not provided.
|
|
32
32
|
attr_accessor :currency_code
|
|
33
33
|
|
|
34
|
+
# The organization's time zone as a canonical IANA identifier. Returns `null` if not configured.
|
|
35
|
+
attr_accessor :timezone
|
|
36
|
+
|
|
34
37
|
# Timestamp of when the organization has been created.
|
|
35
38
|
attr_accessor :created_at
|
|
36
39
|
|
|
@@ -46,6 +49,7 @@ module Tremendous
|
|
|
46
49
|
:'copy_settings' => :'copy_settings',
|
|
47
50
|
:'phone' => :'phone',
|
|
48
51
|
:'currency_code' => :'currency_code',
|
|
52
|
+
:'timezone' => :'timezone',
|
|
49
53
|
:'created_at' => :'created_at',
|
|
50
54
|
:'api_key' => :'api_key'
|
|
51
55
|
}
|
|
@@ -70,6 +74,7 @@ module Tremendous
|
|
|
70
74
|
:'copy_settings' => :'CreateOrganizationRequestCopySettings',
|
|
71
75
|
:'phone' => :'String',
|
|
72
76
|
:'currency_code' => :'String',
|
|
77
|
+
:'timezone' => :'String',
|
|
73
78
|
:'created_at' => :'Date',
|
|
74
79
|
:'api_key' => :'String'
|
|
75
80
|
}
|
|
@@ -79,6 +84,7 @@ module Tremendous
|
|
|
79
84
|
def self.openapi_nullable
|
|
80
85
|
Set.new([
|
|
81
86
|
:'phone',
|
|
87
|
+
:'timezone',
|
|
82
88
|
])
|
|
83
89
|
end
|
|
84
90
|
|
|
@@ -126,6 +132,10 @@ module Tremendous
|
|
|
126
132
|
self.currency_code = attributes[:'currency_code']
|
|
127
133
|
end
|
|
128
134
|
|
|
135
|
+
if attributes.key?(:'timezone')
|
|
136
|
+
self.timezone = attributes[:'timezone']
|
|
137
|
+
end
|
|
138
|
+
|
|
129
139
|
if attributes.key?(:'created_at')
|
|
130
140
|
self.created_at = attributes[:'created_at']
|
|
131
141
|
end
|
|
@@ -212,6 +222,7 @@ module Tremendous
|
|
|
212
222
|
copy_settings == o.copy_settings &&
|
|
213
223
|
phone == o.phone &&
|
|
214
224
|
currency_code == o.currency_code &&
|
|
225
|
+
timezone == o.timezone &&
|
|
215
226
|
created_at == o.created_at &&
|
|
216
227
|
api_key == o.api_key
|
|
217
228
|
end
|
|
@@ -225,7 +236,7 @@ module Tremendous
|
|
|
225
236
|
# Calculates hash code according to all attributes.
|
|
226
237
|
# @return [Integer] Hash code
|
|
227
238
|
def hash
|
|
228
|
-
[id, name, website, copy_settings, phone, currency_code, created_at, api_key].hash
|
|
239
|
+
[id, name, website, copy_settings, phone, currency_code, timezone, created_at, api_key].hash
|
|
229
240
|
end
|
|
230
241
|
|
|
231
242
|
# Builds the object from hash
|
|
@@ -34,6 +34,9 @@ module Tremendous
|
|
|
34
34
|
# Currency code for the new organization. Defaults to the current organization's currency if not provided.
|
|
35
35
|
attr_accessor :currency_code
|
|
36
36
|
|
|
37
|
+
# The organization's time zone as a canonical IANA identifier. Returns `null` if not configured.
|
|
38
|
+
attr_accessor :timezone
|
|
39
|
+
|
|
37
40
|
# Timestamp of when the organization has been created.
|
|
38
41
|
attr_accessor :created_at
|
|
39
42
|
|
|
@@ -47,6 +50,7 @@ module Tremendous
|
|
|
47
50
|
:'copy_settings' => :'copy_settings',
|
|
48
51
|
:'phone' => :'phone',
|
|
49
52
|
:'currency_code' => :'currency_code',
|
|
53
|
+
:'timezone' => :'timezone',
|
|
50
54
|
:'created_at' => :'created_at'
|
|
51
55
|
}
|
|
52
56
|
end
|
|
@@ -71,6 +75,7 @@ module Tremendous
|
|
|
71
75
|
:'copy_settings' => :'CreateOrganizationRequestCopySettings',
|
|
72
76
|
:'phone' => :'String',
|
|
73
77
|
:'currency_code' => :'String',
|
|
78
|
+
:'timezone' => :'String',
|
|
74
79
|
:'created_at' => :'Date'
|
|
75
80
|
}
|
|
76
81
|
end
|
|
@@ -79,6 +84,7 @@ module Tremendous
|
|
|
79
84
|
def self.openapi_nullable
|
|
80
85
|
Set.new([
|
|
81
86
|
:'phone',
|
|
87
|
+
:'timezone',
|
|
82
88
|
])
|
|
83
89
|
end
|
|
84
90
|
|
|
@@ -130,6 +136,10 @@ module Tremendous
|
|
|
130
136
|
self.currency_code = attributes[:'currency_code']
|
|
131
137
|
end
|
|
132
138
|
|
|
139
|
+
if attributes.key?(:'timezone')
|
|
140
|
+
self.timezone = attributes[:'timezone']
|
|
141
|
+
end
|
|
142
|
+
|
|
133
143
|
if attributes.key?(:'created_at')
|
|
134
144
|
self.created_at = attributes[:'created_at']
|
|
135
145
|
end
|
|
@@ -213,6 +223,7 @@ module Tremendous
|
|
|
213
223
|
copy_settings == o.copy_settings &&
|
|
214
224
|
phone == o.phone &&
|
|
215
225
|
currency_code == o.currency_code &&
|
|
226
|
+
timezone == o.timezone &&
|
|
216
227
|
created_at == o.created_at
|
|
217
228
|
end
|
|
218
229
|
|
|
@@ -225,7 +236,7 @@ module Tremendous
|
|
|
225
236
|
# Calculates hash code according to all attributes.
|
|
226
237
|
# @return [Integer] Hash code
|
|
227
238
|
def hash
|
|
228
|
-
[id, name, website, with_api_key, copy_settings, phone, currency_code, created_at].hash
|
|
239
|
+
[id, name, website, with_api_key, copy_settings, phone, currency_code, timezone, created_at].hash
|
|
229
240
|
end
|
|
230
241
|
|
|
231
242
|
# Builds the object from hash
|
|
@@ -34,6 +34,9 @@ module Tremendous
|
|
|
34
34
|
# Currency code for the new organization. Defaults to the current organization's currency if not provided.
|
|
35
35
|
attr_accessor :currency_code
|
|
36
36
|
|
|
37
|
+
# IANA time zone identifier for the new organization, such as America/New_York or Europe/London. Aliases such as US/Eastern are accepted and converted to their canonical identifier (America/New_York). Defaults to the time zone of the organization associated with the API key used for the request if omitted or blank. If that organization has no time zone, the new organization remains unset.
|
|
38
|
+
attr_accessor :timezone
|
|
39
|
+
|
|
37
40
|
# Timestamp of when the organization has been created.
|
|
38
41
|
attr_accessor :created_at
|
|
39
42
|
|
|
@@ -47,6 +50,7 @@ module Tremendous
|
|
|
47
50
|
:'copy_settings' => :'copy_settings',
|
|
48
51
|
:'phone' => :'phone',
|
|
49
52
|
:'currency_code' => :'currency_code',
|
|
53
|
+
:'timezone' => :'timezone',
|
|
50
54
|
:'created_at' => :'created_at'
|
|
51
55
|
}
|
|
52
56
|
end
|
|
@@ -71,6 +75,7 @@ module Tremendous
|
|
|
71
75
|
:'copy_settings' => :'CreateOrganizationRequestCopySettings',
|
|
72
76
|
:'phone' => :'String',
|
|
73
77
|
:'currency_code' => :'String',
|
|
78
|
+
:'timezone' => :'String',
|
|
74
79
|
:'created_at' => :'Date'
|
|
75
80
|
}
|
|
76
81
|
end
|
|
@@ -125,6 +130,10 @@ module Tremendous
|
|
|
125
130
|
self.currency_code = attributes[:'currency_code']
|
|
126
131
|
end
|
|
127
132
|
|
|
133
|
+
if attributes.key?(:'timezone')
|
|
134
|
+
self.timezone = attributes[:'timezone']
|
|
135
|
+
end
|
|
136
|
+
|
|
128
137
|
if attributes.key?(:'created_at')
|
|
129
138
|
self.created_at = attributes[:'created_at']
|
|
130
139
|
end
|
|
@@ -178,6 +187,7 @@ module Tremendous
|
|
|
178
187
|
copy_settings == o.copy_settings &&
|
|
179
188
|
phone == o.phone &&
|
|
180
189
|
currency_code == o.currency_code &&
|
|
190
|
+
timezone == o.timezone &&
|
|
181
191
|
created_at == o.created_at
|
|
182
192
|
end
|
|
183
193
|
|
|
@@ -190,7 +200,7 @@ module Tremendous
|
|
|
190
200
|
# Calculates hash code according to all attributes.
|
|
191
201
|
# @return [Integer] Hash code
|
|
192
202
|
def hash
|
|
193
|
-
[id, name, website, with_api_key, copy_settings, phone, currency_code, created_at].hash
|
|
203
|
+
[id, name, website, with_api_key, copy_settings, phone, currency_code, timezone, created_at].hash
|
|
194
204
|
end
|
|
195
205
|
|
|
196
206
|
# Builds the object from hash
|
|
@@ -32,6 +32,9 @@ module Tremendous
|
|
|
32
32
|
# Currency code for the new organization. Defaults to the current organization's currency if not provided.
|
|
33
33
|
attr_accessor :currency_code
|
|
34
34
|
|
|
35
|
+
# IANA time zone identifier for the new organization, such as America/New_York or Europe/London. Aliases such as US/Eastern are accepted and converted to their canonical identifier (America/New_York). Defaults to the time zone of the organization associated with the API key used for the request if omitted or blank. If that organization has no time zone, the new organization remains unset.
|
|
36
|
+
attr_accessor :timezone
|
|
37
|
+
|
|
35
38
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
36
39
|
def self.attribute_map
|
|
37
40
|
{
|
|
@@ -40,7 +43,8 @@ module Tremendous
|
|
|
40
43
|
:'with_api_key' => :'with_api_key',
|
|
41
44
|
:'copy_settings' => :'copy_settings',
|
|
42
45
|
:'phone' => :'phone',
|
|
43
|
-
:'currency_code' => :'currency_code'
|
|
46
|
+
:'currency_code' => :'currency_code',
|
|
47
|
+
:'timezone' => :'timezone'
|
|
44
48
|
}
|
|
45
49
|
end
|
|
46
50
|
|
|
@@ -62,7 +66,8 @@ module Tremendous
|
|
|
62
66
|
:'with_api_key' => :'Boolean',
|
|
63
67
|
:'copy_settings' => :'CreateOrganizationRequestCopySettings',
|
|
64
68
|
:'phone' => :'String',
|
|
65
|
-
:'currency_code' => :'String'
|
|
69
|
+
:'currency_code' => :'String',
|
|
70
|
+
:'timezone' => :'String'
|
|
66
71
|
}
|
|
67
72
|
end
|
|
68
73
|
|
|
@@ -117,6 +122,10 @@ module Tremendous
|
|
|
117
122
|
if attributes.key?(:'currency_code')
|
|
118
123
|
self.currency_code = attributes[:'currency_code']
|
|
119
124
|
end
|
|
125
|
+
|
|
126
|
+
if attributes.key?(:'timezone')
|
|
127
|
+
self.timezone = attributes[:'timezone']
|
|
128
|
+
end
|
|
120
129
|
end
|
|
121
130
|
|
|
122
131
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -189,7 +198,8 @@ module Tremendous
|
|
|
189
198
|
with_api_key == o.with_api_key &&
|
|
190
199
|
copy_settings == o.copy_settings &&
|
|
191
200
|
phone == o.phone &&
|
|
192
|
-
currency_code == o.currency_code
|
|
201
|
+
currency_code == o.currency_code &&
|
|
202
|
+
timezone == o.timezone
|
|
193
203
|
end
|
|
194
204
|
|
|
195
205
|
# @see the `==` method
|
|
@@ -201,7 +211,7 @@ module Tremendous
|
|
|
201
211
|
# Calculates hash code according to all attributes.
|
|
202
212
|
# @return [Integer] Hash code
|
|
203
213
|
def hash
|
|
204
|
-
[name, website, with_api_key, copy_settings, phone, currency_code].hash
|
|
214
|
+
[name, website, with_api_key, copy_settings, phone, currency_code, timezone].hash
|
|
205
215
|
end
|
|
206
216
|
|
|
207
217
|
# Builds the object from hash
|