harvest-ruby-v2 0.2.0

data/lib/harvest/resources/expenses.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param id [Integer]
+    #   Unique ID for the expense category.
+    # @param name [String]
+    #   The name of the expense category.
+    # @param unit_name [String]
+    #   The unit name of the expense category.
+    # @param unit_price [decimal]
+    #   The unit price of the expense category.
+    # @param is_active [Boolean]
+    #   Whether the expense category is active or archived.
+    # @param created_at [DateTime]
+    #   Date and time the expense category was created.
+    # @param updated_at [DateTime]
+    #   Date and time the expense category was last updated.
+    ExpenseCategory = Struct.new(
+      'ExpenseCategory',
+      :id,
+      :name,
+      :unit_name,
+      :unit_price,
+      :is_active,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+
+    # @param id [Integer]
+    #   Unique ID for the expense.
+    # @param client [Struct]
+    #   An object containing the expense's client id, name, and currency.
+    # @param project [Struct]
+    #   An object containing the expense's project id, name, and code.
+    # @param expense_category [Struct]
+    #   An object containing the expense's expense category id, name, unit_price,
+    #   and unit_name.
+    # @param user [Struct]
+    #   An object containing the id and name of the user that recorded the expense.
+    # @param user_assignment [Struct]
+    #   A user assignment object of the user that recorded the expense.
+    # @param receipt [Struct]
+    #   An object containing the expense's receipt URL and file name.
+    # @param invoice [Struct]
+    #   Once the expense has been invoiced, this field will include the associated
+    #   invoice's id and number.
+    # @param notes [String]
+    #   Textual notes used to describe the expense.
+    # @param billable [Boolean]
+    #   Whether the expense is billable or not.
+    # @param is_closed [Boolean]
+    #   Whether the expense has been approved or closed for some other reason.
+    # @param is_locked [Boolean]
+    #   Whether the expense has been been invoiced, approved, or the project or
+    #   person related to the expense is archived.
+    # @param is_billed [Boolean]
+    #   Whether or not the expense has been marked as invoiced.
+    # @param locked_reason [String]
+    #   An explanation of why the expense has been locked.
+    # @param spent_date [Date]
+    #   Date the expense occurred.
+    # @param created_at [DateTime]
+    #   Date and time the expense was created.
+    # @param updated_at [DateTime]
+    #   Date and time the expense was last updated.
+    Expense = Struct.new(
+      'Expense',
+      :id,
+      :client,
+      :project,
+      :expense_category,
+      :user,
+      :user_assignment,
+      :receipt,
+      :invoice,
+      :notes,
+      :billable,
+      :is_closed,
+      :is_locked,
+      :is_billed,
+      :locked_reason,
+      :spent_date,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/resources/invoices.rb

@@ -0,0 +1,262 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param id [Integer]
+    #   Unique ID for the invoice.
+    # @param client [Struct]
+    #   An object containing invoice's client id and name.
+    # @param line_items [List]
+    #   Array of invoice line items.
+    # @param estimate [Struct]
+    #   An object containing the associated estimate's id.
+    # @param retainer [Struct]
+    #   An object containing the associated retainer's id.
+    # @param creator [Struct]
+    #   An object containing the id and name of the person that created the invoice.
+    # @param client_key [String]
+    #   Used to build a URL to the public web invoice for your client:
+    # @param number [String]
+    #   If no value is set, the number will be automatically generated.
+    # @param purchase_order [String]
+    #   The purchase order number.
+    # @param amount [decimal]
+    #   The total amount for the invoice, including any discounts and taxes.
+    # @param due_amount [decimal]
+    #   The total amount due at this time for this invoice.
+    # @param tax [decimal]
+    #   This percentage is applied to the subtotal, including line items and discounts.
+    # @param tax_amount [decimal]
+    #   The first amount of tax included, calculated from tax. If no tax is
+    #   defined, this value will be null.
+    # @param tax2 [decimal]
+    #   This percentage is applied to the subtotal, including line items and discounts.
+    # @param tax2_amount [decimal]
+    #   The amount calculated from tax2.
+    # @param discount [decimal]
+    #   This percentage is subtracted from the subtotal.
+    # @param discount_amount [decimal]
+    #   The amount calcuated from discount.
+    # @param subject [String]
+    #   The invoice subject.
+    # @param notes [String]
+    #   Any additional notes included on the invoice.
+    # @param currency [String]
+    #   The currency code associated with this invoice.
+    # @param state [String]
+    #   The current state of the invoice: draft, open, paid, or closed.
+    # @param period_start [Date]
+    #   Start of the period during which time entries were added to this invoice.
+    # @param period_end [Date]
+    #   End of the period during which time entries were added to this invoice.
+    # @param issue_date [Date]
+    #   Date the invoice was issued.
+    # @param due_date [Date]
+    #   Date the invoice is due.
+    # @param payment_term [String]
+    #   The timeframe in which the invoice should be paid. Options: upon receipt,
+    #   net 15, net 30, net 45, net 60, or custom.
+    # @param sent_at [DateTime]
+    #   Date and time the invoice was sent.
+    # @param paid_at [DateTime]
+    #   Date and time the invoice was paid.
+    # @param paid_date [Date]
+    #   Date the invoice was paid.
+    # @param closed_at [DateTime]
+    #   Date and time the invoice was closed.
+    # @param recurring_invoice_id [Integer]
+    #   Unique ID of the associated recurring invoice.
+    # @param created_at [DateTime]
+    #   Date and time the invoice was created.
+    # @param updated_at [DateTime]
+    #   Date and time the invoice was last updated.
+    Invoice = Struct.new(
+      'Invoice',
+      :id,
+      :client,
+      :line_items,
+      :estimate,
+      :retainer,
+      :creator,
+      :client_key,
+      :number,
+      :purchase_order,
+      :amount,
+      :due_amount,
+      :tax,
+      :tax_amount,
+      :tax2,
+      :tax2_amount,
+      :discount,
+      :discount_amount,
+      :subject,
+      :notes,
+      :currency,
+      :state,
+      :period_start,
+      :period_end,
+      :issue_date,
+      :due_date,
+      :payment_term,
+      :sent_at,
+      :paid_at,
+      :paid_date,
+      :closed_at,
+      :recurring_invoice_id,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+
+    # @param id [Integer]
+    #   Unique ID for the line item.
+    # @param project [Struct]
+    #   An object containing the associated project's id, name, and code.
+    # @param kind [String]
+    #   The name of an invoice item category.
+    # @param description [String]
+    #   Text description of the line item.
+    # @param quantity [decimal]
+    #   The unit quantity of the item.
+    # @param unit_price [decimal]
+    #   The individual price per unit.
+    # @param amount [decimal]
+    #   The line item subtotal (quantity * unit_price).
+    # @param taxed [Boolean]
+    #   Whether the invoice's tax percentage applies to this line item.
+    # @param taxed2 [Boolean]
+    #   Whether the invoice's tax2 percentage applies to this line item.
+    InvoiceLineItem = Struct.new(
+      'InvoiceLineItem',
+      :id,
+      :project,
+      :kind,
+      :description,
+      :quantity,
+      :unit_price,
+      :amount,
+      :taxed,
+      :taxed2,
+      keyword_init: true
+    )
+
+    # @param id [Integer]
+    #   Unique ID for the message.
+    # @param sent_by [String]
+    #   Name of the user that created the message.
+    # @param sent_by_email [String]
+    #   Email of the user that created the message.
+    # @param sent_from [String]
+    #   Name of the user that the message was sent from.
+    # @param sent_from_email [String]
+    #   Email of the user that message was sent from.
+    # @param recipients [List]
+    #   Array of invoice message recipients.
+    # @param subject [String]
+    #   The message subject.
+    # @param body [String]
+    #   The message body.
+    # @param include_link_to_client_invoice [Boolean]
+    #   Whether to include a link to the client invoice in the message body. Not
+    #   used when thank_you is true.
+    # @param attach_pdf [Boolean]
+    #   Whether to attach the invoice PDF to the message email.
+    # @param send_me_a_copy [Boolean]
+    #   Whether to email a copy of the message to the current user.
+    # @param thank_you [Boolean]
+    #   Whether this is a thank you message.
+    # @param event_type [String]
+    #   The type of invoice event that occurred with the message: send, close,
+    #   draft, re-open, or view.
+    # @param reminder [Boolean]
+    #   Whether this is a reminder message.
+    # @param send_reminder_on [Date]
+    #   The Date the reminder email will be sent.
+    # @param created_at [DateTime]
+    #   Date and time the message was created.
+    # @param updated_at [DateTime]
+    #   Date and time the message was last updated.
+    InvoiceMessage = Struct.new(
+      'InvoiceMessage',
+      :id,
+      :sent_by,
+      :sent_by_email,
+      :sent_from,
+      :sent_from_email,
+      :recipients,
+      :subject,
+      :body,
+      :include_link_to_client_invoice,
+      :attach_pdf,
+      :send_me_a_copy,
+      :thank_you,
+      :event_type,
+      :reminder,
+      :send_reminder_on,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+
+    # @param id [Integer]
+    #   Unique ID for the payment.
+    # @param amount [decimal]
+    #   The amount of the payment.
+    # @param paid_at [DateTime]
+    #   Date and time the payment was made.
+    # @param paid_date [Date]
+    #   Date the payment was made.
+    # @param recorded_by [String]
+    #   The name of the person who recorded the payment.
+    # @param recorded_by_email [String]
+    #   The email of the person who recorded the payment.
+    # @param notes [String]
+    #   Any notes associated with the payment.
+    # @param transaction_id [String]
+    #   Either the card authorization or PayPal transaction ID.
+    # @param payment_gateway [Struct]
+    #   The payment gateway id and name used to process the payment.
+    # @param created_at [DateTime]
+    #   Date and time the payment was recorded.
+    # @param updated_at [DateTime]
+    #   Date and time the payment was last updated.
+    InvoicePayment = Struct.new(
+      'InvoicePayment',
+      :id,
+      :amount,
+      :paid_at,
+      :paid_date,
+      :recorded_by,
+      :recorded_by_email,
+      :notes,
+      :transaction_id,
+      :payment_gateway,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+
+    # @param id [Integer]
+    #   Unique ID for the invoice item category.
+    # @param name [String]
+    #   The name of the invoice item category.
+    # @param use_as_service [Boolean]
+    #   Whether this invoice item category is used for billable hours when generating an invoice.
+    # @param use_as_expense [Boolean]
+    #   Whether this invoice item category is used for expenses when generating an invoice.
+    # @param created_at [DateTime]
+    #   Date and time the invoice item category was created.
+    # @param updated_at [DateTime]
+    #   Date and time the invoice item category was last updated.
+    InvoiceItemCategory = Struct.new(
+      'InvoiceItemCategory',
+      :id,
+      :name,
+      :use_as_service,
+      :use_as_expense,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/resources/message.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param name [String]
+    #   Name of the message recipient.
+    # @param email [String]
+    #   Email of the message recipient.
+    MessageRecipient = Struct.new(
+      'MessageRecipient',
+      :name,
+      :email,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/resources/project.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # https://help.getharvest.com/api-v2/projects-api/projects/projects/
+    # @param id [Integer]
+    #   Unique ID for the project.
+    # @param client [Struct]
+    #   An object containing the project's client id, name, and currency.
+    # @param name [String]
+    #   Unique name for the project.
+    # @param code [String]
+    #   The code associated with the project.
+    # @param is_active [Boolean]
+    #   Whether the project is active or archived.
+    # @param is_billable [Boolean]
+    #   Whether the project is billable or not.
+    # @param is_fixed_fee [Boolean]
+    #   Whether the project is a fixed-fee project or not.
+    # @param bill_by [String]
+    #   The method by which the project is invoiced.
+    # @param hourly_rate [decimal]
+    #   Rate for projects billed by Project Hourly Rate.
+    # @param budget [decimal]
+    #   The budget in hours for the project when budgeting by time.
+    # @param budget_by [String]
+    #   The method by which the project is budgeted.
+    # @param budget_is_monthly [Boolean]
+    #   Option to have the budget reset every month.
+    # @param notify_when_over_budget [Boolean]
+    #   Whether Project Managers should be notified when the project goes over budget.
+    # @param over_budget_notification_percentage [decimal]
+    #   Percentage value used to trigger over budget email alerts.
+    # @param over_budget_notification_date [Date]
+    #   Date of last over budget notification. If none have been sent, this will be null.
+    # @param show_budget_to_all [Boolean]
+    #   Option to show project budget to all employees. Does not apply to Total Project Fee projects.
+    # @param cost_budget [decimal]
+    #   The monetary budget for the project when budgeting by money.
+    # @param cost_budget_include_expenses [Boolean]
+    #   Option for budget of Total Project Fees projects to include tracked expenses.
+    # @param fee [decimal]
+    #   The amount you plan to invoice for the project. Only used by fixed-fee projects.
+    # @param notes [String]
+    #   Project notes.
+    # @param starts_on [Date]
+    #   Date the project was started.
+    # @param ends_on [Date]
+    #   Date the project will end.
+    # @param created_at [DateTime]
+    #   Date and time the project was created.
+    # @param updated_at [DateTime]
+    #   Date and time the project was last updated.
+    Project = Struct.new(
+      'Project',
+      :bill_by,
+      :budget,
+      :budget_by,
+      :budget_is_monthly,
+      :client,
+      :code,
+      :cost_budget,
+      :cost_budget_include_expenses,
+      :created_at,
+      :ends_on,
+      :fee,
+      :hourly_rate,
+      :id,
+      :is_active,
+      :is_billable,
+      :is_fixed_fee,
+      :name,
+      :notes,
+      :notify_when_over_budget,
+      :over_budget_notification_date,
+      :over_budget_notification_percentage,
+      :show_budget_to_all,
+      :starts_on,
+      :updated_at,
+      :task_assignments,
+      keyword_init: true
+    )
+  end
+end