Class: Webhookdb::Replicator::StripeInvoiceV1

Inherits:
Base
  • Object
show all
Includes:
Appydays::Loggable, StripeV1Mixin
Defined in:
lib/webhookdb/replicator/stripe_invoice_v1.rb

Constant Summary

Constants inherited from Base

Base::MAX_INDEX_NAME_LENGTH

Constants included from DBAdapter::ColumnTypes

DBAdapter::ColumnTypes::BIGINT, DBAdapter::ColumnTypes::BIGINT_ARRAY, DBAdapter::ColumnTypes::BOOLEAN, DBAdapter::ColumnTypes::COLUMN_TYPES, DBAdapter::ColumnTypes::DATE, DBAdapter::ColumnTypes::DECIMAL, DBAdapter::ColumnTypes::DOUBLE, DBAdapter::ColumnTypes::FLOAT, DBAdapter::ColumnTypes::INTEGER, DBAdapter::ColumnTypes::INTEGER_ARRAY, DBAdapter::ColumnTypes::OBJECT, DBAdapter::ColumnTypes::TEXT, DBAdapter::ColumnTypes::TEXT_ARRAY, DBAdapter::ColumnTypes::TIMESTAMP, DBAdapter::ColumnTypes::UUID

Instance Attribute Summary

Attributes inherited from Base

#service_integration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from StripeV1Mixin

#_fetch_backfill_page, #_resource_and_event, #_timestamp_column_name, #_verify_backfill_401_err_msg, #_verify_backfill_403_err_msg, #_verify_backfill_err_msg, #_webhook_response, #calculate_backfill_state_machine, #calculate_webhook_state_machine, #restricted_key_resource_name

Methods inherited from Base

#_any_subscriptions_to_notify?, #_backfill_state_change_fields, #_backfillers, #_clear_backfill_information, #_clear_webook_information, #_coalesce_excluded_on_update, #_enqueue_backfill_jobs, #_extra_index_specs, #_fetch_enrichment, #_find_dependency_candidate, #_notify_dependents, #_parallel_backfill, #_prepare_for_insert, #_publish_rowupsert, #_resource_and_event, #_resource_to_data, #_store_enrichment_body?, #_timestamp_column_name, #_to_json, #_upsert_update_expr, #_upsert_webhook, #_verify_backfill_err_msg, #_webhook_response, #_webhook_state_change_fields, #admin_dataset, #backfill, #backfill_not_supported_message, #calculate_and_backfill_state_machine, #calculate_backfill_state_machine, #calculate_dependency_state_machine_step, #calculate_preferred_create_state_machine, #calculate_webhook_state_machine, chunked_row_update_bounds, #clear_backfill_information, #clear_webhook_information, #create_table, #create_table_modification, #data_column, #dbadapter_table, #denormalized_columns, #descriptor, #dispatch_request_to, #documentation_url, #enqueue_sync_targets, #enrichment_column, #ensure_all_columns, #ensure_all_columns_modification, #find_dependent, #find_dependent!, #indices, #initialize, #on_dependency_webhook_upsert, #preferred_create_state_machine_method, #preprocess_headers_for_logging, #primary_key_column, #process_state_change, #process_webhooks_synchronously?, #qualified_table_sequel_identifier, #readonly_dataset, #remote_key_column, #requires_sequence?, #resource_name_plural, #resource_name_singular, #schema_and_table_symbols, #storable_columns, #synchronous_processing_response_body, #timestamp_column, #upsert_has_deps?, #upsert_webhook, #upsert_webhook_body, #verify_backfill_credentials, #webhook_endpoint, #webhook_response

Constructor Details

This class inherits a constructor from Webhookdb::Replicator::Base

Class Method Details

.descriptor ⇒ Webhookdb::Replicator::Descriptor

Returns:



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/webhookdb/replicator/stripe_invoice_v1.rb', line 11

def self.descriptor
  return Webhookdb::Replicator::Descriptor.new(
    name: "stripe_invoice_v1",
    ctor: ->(sint) { Webhookdb::Replicator::StripeInvoiceV1.new(sint) },
    feature_roles: [],
    resource_name_singular: "Stripe Invoice",
    supports_webhooks: true,
    supports_backfill: true,
    api_docs_url: "https://stripe.com/docs/api/invoices",
  )
end

Instance Method Details

#_denormalized_columns ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/webhookdb/replicator/stripe_invoice_v1.rb', line 27

def _denormalized_columns
  return [
    Webhookdb::Replicator::Column.new(:amount_due, INTEGER),
    Webhookdb::Replicator::Column.new(:amount_paid, INTEGER),
    Webhookdb::Replicator::Column.new(:amount_remaining, INTEGER),
    Webhookdb::Replicator::Column.new(:charge, TEXT, index: true),
    Webhookdb::Replicator::Column.new(:created, TIMESTAMP, index: true, converter: :tsat),
    Webhookdb::Replicator::Column.new(:customer, TEXT, index: true),
    Webhookdb::Replicator::Column.new(:customer_address, TEXT),
    Webhookdb::Replicator::Column.new(:customer_email, TEXT, index: true),
    Webhookdb::Replicator::Column.new(:customer_name, TEXT),
    Webhookdb::Replicator::Column.new(:customer_phone, TEXT, index: true),
    Webhookdb::Replicator::Column.new(:customer_shipping, TEXT),
    Webhookdb::Replicator::Column.new(:number, TEXT, index: true),
    Webhookdb::Replicator::Column.new(:period_start, TIMESTAMP, index: true, converter: :tsat),
    Webhookdb::Replicator::Column.new(:period_end, TIMESTAMP, index: true, converter: :tsat),
    Webhookdb::Replicator::Column.new(:statement_descriptor, TEXT),
    Webhookdb::Replicator::Column.new(:status, TEXT),
    Webhookdb::Replicator::Column.new(
      :status_transitions_finalized_at,
      TIMESTAMP,
      index: true,
      data_key: ["status_transitions", "status_transitions_finalized_at"],
      optional: true,
      converter: :tsat,
    ),
    Webhookdb::Replicator::Column.new(
      :status_transitions_marked_uncollectible_at,
      TIMESTAMP,
      index: true,
      data_key: ["status_transitions", "status_transitions_marked_uncollectible_at"],
      optional: true,
      converter: :tsat,
    ),
    Webhookdb::Replicator::Column.new(
      :status_transitions_marked_paid_at,
      TIMESTAMP,
      index: true,
      data_key: ["status_transitions", "status_transitions_marked_paid_at"],
      optional: true,
      converter: :tsat,
    ),
    Webhookdb::Replicator::Column.new(
      :status_transitions_voided_at,
      TIMESTAMP,
      index: true,
      data_key: ["status_transitions", "status_transitions_voided_at"],
      optional: true,
      converter: :tsat,
    ),
    Webhookdb::Replicator::Column.new(:subtotal, INTEGER, index: true),
    Webhookdb::Replicator::Column.new(:tax, INTEGER, index: true),
    Webhookdb::Replicator::Column.new(:total, INTEGER, index: true),
    Webhookdb::Replicator::Column.new(
      :updated,
      TIMESTAMP,
      index: true,
      data_key: "created",
      event_key: "created",
      converter: :tsat,
    ),
  ]
end

#_mixin_backfill_url ⇒ Object 



95
96
97
 
# File 'lib/webhookdb/replicator/stripe_invoice_v1.rb', line 95

def _mixin_backfill_url
  return "https://api.stripe.com/v1/invoices"
end

#_mixin_event_type_names ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/webhookdb/replicator/stripe_invoice_v1.rb', line 99

def _mixin_event_type_names
  return [
    "invoice.created",
    "invoice.deleted",
    "invoice.finalization_failed",
    "invoice.finalized",
    "invoice.marked_uncollectible",
    "invoice.paid",
    "invoice.payment_action_required",
    "invoice.payment_failed",
    "invoice.payment_succeeded",
    "invoice.sent",
    "invoice.upcoming",
    "invoice.updated",
    "invoice.voided",
  ]
end

#_remote_key_column ⇒ Object 



23
24
25
 
# File 'lib/webhookdb/replicator/stripe_invoice_v1.rb', line 23

def _remote_key_column
  return Webhookdb::Replicator::Column.new(:stripe_id, TEXT, data_key: "id")
end

#_update_where_expr ⇒ Object 



91
92
93
 
# File 'lib/webhookdb/replicator/stripe_invoice_v1.rb', line 91

def _update_where_expr
  return self.qualified_table_sequel_identifier[:updated] < Sequel[:excluded][:updated]
end