class

Stripe::ReportingApi

Inherits Reference < Object

Constants

GET_REPORTING_REPORT_RUNS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000

GET_REPORTING_REPORT_RUNS_MAX_LENGTH_FOR_STARTING_AFTER = 5000

GET_REPORTING_REPORT_RUNS_REPORT_RUN_MAX_LENGTH_FOR_REPORT_RUN = 5000

Constructors

new(api_client : Stripe::ApiClient = ApiClient.default)

Instance methods

api_client

api_client=(api_client : ApiClient)

build_api_request_for_get_reporting_report_runs(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_get_reporting_report_runs_report_run(*, report_run : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_get_reporting_report_types(*, expand : Array(Array(String)) | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_get_reporting_report_types_report_type(*, report_type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_post_reporting_report_runs(*, report_type : String | Nil = nil, expand : Array(String) | Nil = nil, parameters : Stripe::RunParameterSpecs | Nil = nil) : Crest::Request

@return Crest::Request

client_side_validation?(*args, **options)

client_side_validation?(*args, **options, &)

debugging?(*args, **options)

debugging?(*args, **options, &)

get_reporting_report_runs(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::FinancialReportingFinanceReportRunList

Returns a list of Report Runs, with the most recent appearing first.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return Report Runs that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::FinancialReportingFinanceReportRunList]

get_reporting_report_runs(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil

<p>Returns a list of Report Runs, with the most recent appearing first.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return Report Runs that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

get_reporting_report_runs_report_run(*, report_run : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ReportingReportRun

Retrieves the details of an existing Report Run.

@required @param report_run [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ReportingReportRun]

get_reporting_report_runs_report_run(*, report_run : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil

<p>Retrieves the details of an existing Report Run.</p> @required @param report_run [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

get_reporting_report_runs_report_run_with_http_info(*, report_run : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ReportingReportRun, Int32, Hash(String, Array(String) | String))

<p>Retrieves the details of an existing Report Run.</p> @required @param report_run [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ReportingReportRun, Integer, Hash)] Stripe::ReportingReportRun, response status code and response headers

get_reporting_report_runs_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::FinancialReportingFinanceReportRunList, Int32, Hash(String, Array(String) | String))

<p>Returns a list of Report Runs, with the most recent appearing first.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return Report Runs that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FinancialReportingFinanceReportRunList, Integer, Hash)] Stripe::FinancialReportingFinanceReportRunList, response status code and response headers

get_reporting_report_types(*, expand : Array(Array(String)) | Nil = nil) : Stripe::FinancialReportingFinanceReportTypeList

Returns a full list of Report Types.

@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::FinancialReportingFinanceReportTypeList]

get_reporting_report_types(*, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil

<p>Returns a full list of Report Types.</p> @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

get_reporting_report_types_report_type(*, report_type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ReportingReportType

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

@required @param report_type [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ReportingReportType]

get_reporting_report_types_report_type(*, report_type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil

<p>Retrieves the details of a Report Type. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.)</p> @required @param report_type [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

get_reporting_report_types_report_type_with_http_info(*, report_type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ReportingReportType, Int32, Hash(String, Array(String) | String))

<p>Retrieves the details of a Report Type. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.)</p> @required @param report_type [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ReportingReportType, Integer, Hash)] Stripe::ReportingReportType, response status code and response headers

get_reporting_report_types_with_http_info(*, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::FinancialReportingFinanceReportTypeList, Int32, Hash(String, Array(String) | String))

<p>Returns a full list of Report Types.</p> @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FinancialReportingFinanceReportTypeList, Integer, Hash)] Stripe::FinancialReportingFinanceReportTypeList, response status code and response headers

post_reporting_report_runs(*, report_type : String | Nil = nil, expand : Array(String) | Nil = nil, parameters : Stripe::RunParameterSpecs | Nil = nil) : Stripe::ReportingReportRun

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

@required @param report_type [String?] The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `\\\"balance.summary.1\\\"`. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param parameters [Stripe::RunParameterSpecs?] @return [Stripe::ReportingReportRun]

post_reporting_report_runs(*, report_type : String | Nil = nil, expand : Array(String) | Nil = nil, parameters : Stripe::RunParameterSpecs | Nil = nil, &block : Crest::Response -> ) : Nil

<p>Creates a new object and begin running the report. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.)</p> @required @param report_type [String?] The ID of the report type to run, such as \\\"balance.summary.1\\\". @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param parameters [Stripe::RunParameterSpecs?] @return nil

post_reporting_report_runs_with_http_info(*, report_type : String | Nil = nil, expand : Array(String) | Nil = nil, parameters : Stripe::RunParameterSpecs | Nil = nil) : Tuple(Stripe::ReportingReportRun, Int32, Hash(String, Array(String) | String))

<p>Creates a new object and begin running the report. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.)</p> @required @param report_type [String?] The ID of the report type to run, such as \\\"balance.summary.1\\\". @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param parameters [Stripe::RunParameterSpecs?] @return [Tuple(Stripe::ReportingReportRun, Integer, Hash)] Stripe::ReportingReportRun, response status code and response headers